API SPEC · V1 · GADEVELOPER REFERENCE

    Developer API

    REST API pro AML screening

    Integrujte screening sankcí, PEP, seznamů hledaných osob, negativních médií a KYB/UBO přímo do svého onboardingu, monitoringu a transakčních toků. API je živé: ověříte se API klíčem a voláte stejný screeningový engine, který používá portál.

    API v1 je živé

    Endpointy jsou obecně dostupné s autentizací API klíčem a limity požadavků podle tarifu. Prozkoumejte každý endpoint v interaktivní OpenAPI dokumentaci na /api/v1/docs.

    §01Rychlý start

    01 / 05
    STEP 01

    1. Vytvořte API klíč

    Vytvořte v dashboardu API klíč s omezeným rozsahem oprávnění, nebo ho pro komunikaci mezi servery vygenerujte programově pomocí bearer tokenu svého účtu.

    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. Spusťte první vyhledávání

    Odešlete subjekt s hlavičkou X-API-Key. API vrátí id vyhledávání, které si vyzvednete po dokončení zpracování.

    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. Odešlete dávku

    Pošlete soubor CSV/XLSX pro prověření mnoha subjektů v jedné úloze a poté si vyzvedněte řádky nebo export po dokončení dávky.

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

    §02Základní endpointy

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Vytvoří screeningový požadavek pro jeden subjekt. Vrátí id vyhledávání a stav zpracování. Pod /api/v1 jsou dostupné i endpointy pro účet, pokrytí a stav služby.

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

    EP 02ENDPOINT

    POST /api/v1/batch

    Přijme soubory CSV/XLSX pro vysokoobjemový screening a poté umožní vyzvednout řádky nebo export po dokončení úloh.

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

    EP 03ENDPOINT

    POST /api/v1/keys

    Vytváří a spravuje přístupové údaje API s omezeným rozsahem oprávnění, limity podle tarifu a sledováním využití.

    Autentizace: Bearer token (účet)

    §03Proč týmy API používají

    03 / 05
    • Jedna integrace pro screening sankcí, PEP, seznamů hledaných osob, negativních médií a KYB/UBO
    • Autentizace API klíčem přes hlavičku X-API-Key, s klíči omezenými na konkrétní oprávnění pro přístup s nejnižšími nutnými právy
    • Limity požadavků podle tarifu se záznamem využití pro řízení a kontrolu nákladů
    • Endpointy pro vyhledávání, dávky, klíče, účet, pokrytí a stav služby pod /api/v1
    • Interaktivní OpenAPI dokumentace na /api/v1/docs plus strojově čitelné schéma OpenAPI
    • Strukturovaný výstup vhodný pro auditní záznamy, spisy případů a navazující rozhodování

    §05FAQ k API

    05 / 05
    Q01

    Jak se autentizují API požadavky?

    Screeningové požadavky na /api/v1/search a /api/v1/batch se autentizují API klíčem odeslaným v hlavičce X-API-Key. Klíče vytvoříte ve svém dashboardu, nebo programově přes /api/v1/keys po autentizaci bearer tokenem svého účtu.

    Q02

    Je API obecně dostupné?

    Ano. API v1 je živé a obecně dostupné. Autentizujte se API klíčem, volejte endpointy pro vyhledávání, dávky a správu klíčů a vše prozkoumejte v interaktivní OpenAPI dokumentaci na /api/v1/docs.

    Q03

    Můžu omezit rozsah oprávnění API klíče?

    Ano. Klíče podporují oprávnění jako search:read, search:write, batch:read a batch:write, takže pro každou integraci můžete vynutit přístup s nejnižšími nutnými právy.

    Q04

    Jaké limity požadavků platí?

    Limity se přidělují podle úrovně API a vynucují se pro každý API klíč zvlášť — úroveň určuje propustnost požadavků, ne fakturaci. Hlavičky odpovědi obsahují limit, zbývající kvótu a časová razítka obnovení, takže můžete plynule zpomalit.

    Q05

    Kde můžu endpointy rychle vyzkoušet?

    Použijte interaktivní dokumentaci na /api/v1/docs pro testování ve Swaggeru a /api/v1/redoc pro referenční dokumentaci. Schéma OpenAPI je dostupné na /api/v1/openapi.json.