API SPEC · V1 · GADEVELOPER REFERENCE

    Vývojárske API

    REST API pre AML screening

    Integrujte screening sankcií, PEP, zoznamov hľadaných osôb, negatívnych médií a KYB/UBO priamo do svojich onboardingových, monitorovacích a transakčných procesov. API je živé: autentifikujte sa API kľúčom a volajte ten istý screeningový engine, aký používa portál.

    API v1 je live

    Endpointy sú vo všeobecnej dostupnosti s autentifikáciou API kľúčom a limitmi požiadaviek podľa úrovne. Preskúmajte každý endpoint v interaktívnej OpenAPI dokumentácii na /api/v1/docs.

    §01Rýchly štart

    01 / 05
    STEP 01

    1. Vytvorte API kľúč

    Vytvorte si API kľúč s obmedzeným rozsahom oprávnení na svojej nástenke, alebo ho vygenerujte programovo pomocou bearer tokenu svojho účtu pre požiadavky medzi servermi.

    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. Spustite prvé vyhľadávanie

    Odošlite subjekt s hlavičkou X-API-Key. API vráti ID vyhľadávania, ktoré si vyzdvihnete po dokončení spracovania.

    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. Odošlite hromadnú úlohu

    Pošlite súbor CSV/XLSX na preverenie mnohých subjektov v jednej úlohe a po dokončení hromadnej úlohy si vyzdvihnite riadky alebo export.

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

    §02Hlavné endpointy

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Vytvorí požiadavku na screening jedného subjektu. Vráti ID vyhľadávania a stav spracovania. Endpointy pre účet, pokrytie a stav sú tiež dostupné pod /api/v1.

    Autentifikácia: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    Odošlite súbory CSV/XLSX na screening vo veľkom objeme a po dokončení úloh si vyzdvihnite riadky alebo export.

    Autentifikácia: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    Vytvárajte a spravujte API kľúče s obmedzeným rozsahom oprávnení, limitmi podľa úrovne a sledovaním využitia.

    Autentifikácia: Bearer token (účet)

    §03Prečo tímy používajú toto API

    03 / 05
    • Jedna integrácia pre screening sankcií, PEP, zoznamov hľadaných osôb, negatívnych médií a KYB/UBO
    • Autentifikácia API kľúčom cez hlavičku X-API-Key, s kľúčmi s obmedzeným rozsahom oprávnení podľa princípu najmenších práv
    • Limity požiadaviek podľa úrovne s logovaním využitia pre riadenie a kontrolu nákladov
    • Endpointy pre vyhľadávanie, hromadné spracovanie, kľúče, účet, pokrytie a stav pod /api/v1
    • Interaktívna OpenAPI dokumentácia na /api/v1/docs plus strojovo čitateľná OpenAPI schéma
    • Štruktúrovaný výstup vhodný pre auditné záznamy, spisy prípadov a nadväzujúce rozhodnutia

    §05Časté otázky k API

    05 / 05
    Q01

    Ako autentifikujem požiadavky API?

    Požiadavky na screening na /api/v1/search a /api/v1/batch sa autentifikujú API kľúčom odoslaným v hlavičke X-API-Key. Kľúče vytvoríte na svojej nástenke, alebo programovo cez /api/v1/keys po autentifikácii bearer tokenom svojho účtu.

    Q02

    Je API vo všeobecnej dostupnosti?

    Áno. API v1 je live a vo všeobecnej dostupnosti. Autentifikujte sa API kľúčom, volajte endpointy pre vyhľadávanie, hromadné spracovanie a správu kľúčov a preskúmajte všetko v interaktívnej OpenAPI dokumentácii na /api/v1/docs.

    Q03

    Môžem obmedziť rozsah oprávnení API kľúča?

    Áno. Kľúče podporujú oprávnenia ako search:read, search:write, batch:read a batch:write, takže môžete pre každú integráciu presadiť prístup podľa princípu najmenších práv.

    Q04

    Aké limity požiadaviek platia?

    Limity sú priradené podľa úrovne API a vynucované pre každý API kľúč — úroveň určuje priepustnosť požiadaviek, nie fakturáciu. Hlavičky odpovede obsahujú limit, zostávajúcu kvótu a čas resetu, takže môžete plynulo spomaliť požiadavky.

    Q05

    Kde môžem rýchlo otestovať endpointy?

    Použite interaktívnu dokumentáciu na /api/v1/docs na testovanie cez Swagger a /api/v1/redoc pre referenčnú dokumentáciu. OpenAPI schéma je dostupná na /api/v1/openapi.json.