API SPEC · V1 · GADEVELOPER REFERENCE

    API għall-Iżviluppaturi

    REST API għall-iskrining AML

    Integra l-iskrining tas-sanzjonijiet, tal-PEP, tal-listi ta' sorveljanza kriminali, tal-midja avversa, u tal-KYB/UBO direttament fil-flussi tiegħek ta' onboarding, monitoraġġ, u tranżazzjonijiet. L-API hija diretta: awtentika b'API key u sejjaħ l-istess magna ta' skrining li juża l-portal.

    API v1 hija diretta

    L-endpoints huma ġeneralment disponibbli b'awtentikazzjoni b'API key u limiti tar-rata skont il-livell. Esplora kull endpoint fid-dokumentazzjoni interattiva OpenAPI fuq /api/v1/docs.

    §01Bidu Malajr

    01 / 05
    STEP 01

    1. Oħloq API key

    Oħloq API key bi skop definit fid-dashboard tiegħek, jew iġġenera waħda b'mod programmatiku bit-token bearer tal-kont tiegħek għal talbiet server-to-server.

    curl
    curl -X POST https://screenveritai.com/api/v1/keys \
      -H "Authorization: Bearer <SUPABASE_JWT>" \
      -H "Content-Type: application/json" \
      -d '{"name":"server-key","permissions":["search:read","search:write"]}'
    STEP 02

    2. Mexxi l-ewwel tiftixa tiegħek

    Issottometti entità bl-header X-API-Key. L-API tirritorna search id li tirkupra meta l-ipproċessar jitlesta.

    curl
    curl -X POST https://screenveritai.com/api/v1/search \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{"entity_name":"Acme Ltd","entity_type":"company","search_type":"full_search"}'
    STEP 03

    3. Issottometti lott

    Ibgħat fajl CSV/XLSX biex tiskrinja bosta entitajiet f'xogħol wieħed, imbagħad irkupra r-ringieli jew l-esportazzjonijiet meta l-lott jispiċċa.

    curl
    curl -X POST https://screenveritai.com/api/v1/batch \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -F "file=@entities.csv"

    §02Endpoints ewlenin

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Oħloq talba ta' skrining għal entità waħda. Tirritorna search id u l-istatus tal-ipproċessar. Endpoints tal-kont, tal-kopertura, u tas-saħħa huma disponibbli wkoll taħt /api/v1.

    Awtentikazzjoni: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    Issottometti fajls CSV/XLSX għal skrining ta' volum għoli, imbagħad irkupra r-ringieli jew l-esportazzjonijiet meta x-xogħlijiet jitlestew.

    Awtentikazzjoni: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    Oħloq u ġġestixxi kredenzjali tal-API b'permessi bi skop definit, limiti tar-rata skont il-livell, u traċċar tal-użu.

    Awtentikazzjoni: Bearer token (kont)

    §03Għaliex it-timijiet jużaw l-API

    03 / 05
    • Integrazzjoni waħda għall-iskrining tas-sanzjonijiet, tal-PEP, tal-listi ta' sorveljanza kriminali, tal-midja avversa, u tal-KYB/UBO
    • Awtentikazzjoni b'API key permezz tal-header X-API-Key, b'keys bi skop definit għal aċċess ta' privileġġ minimu
    • Limiti tar-rata skont il-livell b'reġistrazzjoni tal-użu għall-governanza u l-kontroll tal-ispejjeż
    • Endpoints ta' tiftixa, lott, keys, kont, kopertura, u saħħa taħt /api/v1
    • Dokumentazzjoni interattiva OpenAPI fuq /api/v1/docs flimkien ma' skema OpenAPI li tinqara mill-magni
    • Output strutturat adattat għal logs tal-awditu, fajls tal-każijiet, u deċiżjonijiet sussegwenti

    §05Mistoqsijiet Frekwenti dwar l-API

    05 / 05
    Q01

    Kif nawtentika talbiet tal-API?

    Talbiet ta' skrining lejn /api/v1/search u /api/v1/batch jawtentikaw b'API key mibgħuta fl-header X-API-Key. Oħloq keys fid-dashboard tiegħek, jew b'mod programmatiku permezz ta' /api/v1/keys wara li tawtentika bit-token bearer tal-kont tiegħek.

    Q02

    L-API hija ġeneralment disponibbli?

    Iva. API v1 hija diretta u ġeneralment disponibbli. Awtentika b'API key, sejjaħ l-endpoints ta' tiftixa, lott, u ġestjoni tal-key, u esplora kollox fid-dokumentazzjoni interattiva OpenAPI fuq /api/v1/docs.

    Q03

    Nista' niddefinixxi l-iskop tal-permessi tal-API key?

    Iva. Il-keys jappoġġjaw permessi bħal search:read, search:write, batch:read, u batch:write biex tinforza aċċess ta' privileġġ minimu għal kull integrazzjoni.

    Q04

    Liema limiti tar-rata japplikaw?

    Il-limiti tar-rata jiġu assenjati skont il-livell tal-API u infurzati għal kull API key — il-livell jirregola l-flussi ta' talbiet, mhux il-fatturazzjoni. L-headers tar-risposta jinkludu l-limitu, il-kwota li fadal, u l-marki taż-żmien tal-irkupru biex tkun tista' tnaqqas ir-rata b'mod nadif.

    Q05

    Fejn nista' nittestja l-endpoints malajr?

    Uża d-dokumentazzjoni interattiva fuq /api/v1/docs għal ttestjar Swagger u /api/v1/redoc għal dokumentazzjoni ta' referenza. L-iskema OpenAPI tinsab fuq /api/v1/openapi.json.