API SPEC · V1 · GADEVELOPER REFERENCE

    API za razvojne inženjere

    REST API za AML provjeru

    Integrirajte provjeru sankcija, PEP-a, popisa traženih osoba, negativnih medija i KYB/UBO izravno u svoje procese onboardinga, praćenja i transakcija. API je aktivan: autentificirajte se API ključem i pozovite isti sustav provjere koji koristi portal.

    API v1 je aktivan

    Krajnje točke su općenito dostupne uz autentifikaciju API ključem i ograničenja brzine po razini. Istražite svaku krajnju točku u interaktivnoj OpenAPI dokumentaciji na /api/v1/docs.

    §01Brzi početak

    01 / 05
    STEP 01

    1. Izradite API ključ

    Izradite API ključ s definiranim ovlastima u svojoj nadzornoj ploči, ili ga programski generirajte s bearer tokenom svog računa za server-server zahtjeve.

    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. Pokrenite prvu pretragu

    Predajte subjekt uz zaglavlje X-API-Key. API vraća identifikator pretrage koji preuzimate kad obrada završi.

    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. Pošaljite skupnu obradu

    Pošaljite CSV/XLSX datoteku za provjeru mnogo subjekata u jednom zadatku, a zatim preuzmite retke ili izvoze kad skupna obrada završi.

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

    §02Osnovne krajnje točke

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Izradite zahtjev za provjeru jednog subjekta. Vraća identifikator pretrage i status obrade. Krajnje točke za račun, pokrivenost i status dostupnosti također su dostupne pod /api/v1.

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

    EP 02ENDPOINT

    POST /api/v1/batch

    Predajte CSV/XLSX datoteke za provjeru velikog obujma, a zatim preuzmite retke ili izvoze kad zadaci završe.

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

    EP 03ENDPOINT

    POST /api/v1/keys

    Izrađujte i upravljajte API vjerodajnicama s definiranim ovlastima, ograničenjima brzine ovisnima o razini i praćenjem korištenja.

    Autentifikacija: Bearer token (račun)

    §03Zašto timovi koriste API

    03 / 05
    • Jedinstvena integracija za provjeru sankcija, PEP-a, popisa traženih osoba, negativnih medija i KYB/UBO
    • Autentifikacija API ključem putem zaglavlja X-API-Key, s ključevima ograničenih ovlasti za pristup s najmanjim potrebnim pravima
    • Ograničenja brzine po razini uz evidenciju korištenja za upravljanje i kontrolu troškova
    • Krajnje točke za pretragu, skupnu obradu, ključeve, račun, pokrivenost i status dostupnosti pod /api/v1
    • Interaktivna OpenAPI dokumentacija na /api/v1/docs plus strojno čitljiva OpenAPI shema
    • Strukturirani izlaz prikladan za revizijske zapise, dosjee predmeta i daljnje odluke

    §05Česta pitanja o API-ju

    05 / 05
    Q01

    Kako autentificiram API zahtjeve?

    Zahtjevi za provjeru prema /api/v1/search i /api/v1/batch autentificiraju se API ključem poslanim u zaglavlju X-API-Key. Izradite ključeve u svojoj nadzornoj ploči, ili programski putem /api/v1/keys nakon autentifikacije bearer tokenom svog računa.

    Q02

    Je li API općenito dostupan?

    Da. API v1 je aktivan i općenito dostupan. Autentificirajte se API ključem, pozovite krajnje točke za pretragu, skupnu obradu i upravljanje ključevima, te istražite sve u interaktivnoj OpenAPI dokumentaciji na /api/v1/docs.

    Q03

    Mogu li ograničiti ovlasti API ključa?

    Da. Ključevi podržavaju ovlasti poput search:read, search:write, batch:read i batch:write, tako da možete provesti pristup s najmanjim potrebnim pravima po integraciji.

    Q04

    Koja ograničenja brzine vrijede?

    Ograničenja brzine dodjeljuju se po API razini i provode se po API ključu — razina određuje propusnost zahtjeva, ne naplatu. Zaglavlja odgovora uključuju ograničenje, preostalu kvotu i vremenske oznake resetiranja, tako da možete uredno usporiti zahtjeve.

    Q05

    Gdje mogu brzo testirati krajnje točke?

    Koristite interaktivnu dokumentaciju na /api/v1/docs za Swagger testiranje i /api/v1/redoc za dokumentaciju u referentnom stilu. OpenAPI shema poslužuje se na /api/v1/openapi.json.