API SPEC · V1 · GADEVELOPER REFERENCE

    API za razvijalce

    REST API za preverjanje AML

    Vključite preverjanje sankcij, PEP, kazenskih nadzornih seznamov, negativnih medijev in KYB/UBO neposredno v svoje procese sprejema strank, spremljanja in transakcij. API je v produkciji: avtenticirajte se z API ključem in kličite isti sistem preverjanja, ki ga uporablja portal.

    API v1 je v produkciji

    Endpoint-i so splošno dostopni z avtentikacijo prek API ključa in omejitvami zahtevkov po paketu. Raziščite vsak endpoint v interaktivni dokumentaciji OpenAPI na /api/v1/docs.

    §01Hitri začetek

    01 / 05
    STEP 01

    1. Ustvarite API ključ

    V nadzorni plošči ustvarite API ključ z opredeljenim obsegom pravic ali ga programsko izdajte s tokenom nosilca svojega računa za zahtevke med strežniki.

    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. Zaženite prvo iskanje

    Pošljite subjekt z glavo X-API-Key. API vrne identifikator iskanja, ki ga pridobite, ko se obdelava zaključ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šljite paket

    Pošljite datoteko CSV/XLSX za preverjanje več subjektov v enem opravilu, nato ob zaključku paketa pridobite vrstice ali izvoze.

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

    §02Ključni endpoint-i

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Ustvari zahtevo za preverjanje enega subjekta. Vrne identifikator iskanja in stanje obdelave. Pod /api/v1 so na voljo tudi endpoint-i za račun, pokritost in stanje sistema.

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

    EP 02ENDPOINT

    POST /api/v1/batch

    Pošljite datoteke CSV/XLSX za preverjanje velikega obsega, nato ob zaključku opravil pridobite vrstice ali izvoze.

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

    EP 03ENDPOINT

    POST /api/v1/keys

    Ustvarjajte in upravljajte poverilnice API z opredeljenim obsegom pravic, omejitvami zahtevkov po paketu in sledenjem porabe.

    Avtentikacija: token nosilca (račun)

    §03Zakaj ekipe uporabljajo ta API

    03 / 05
    • Ena integracija za preverjanje sankcij, PEP, kazenskih nadzornih seznamov, negativnih medijev in KYB/UBO
    • Avtentikacija z API ključem prek glave X-API-Key, s ključi z opredeljenim obsegom pravic za dostop z najmanjšimi potrebnimi pravicami
    • Omejitve zahtevkov po paketu z beleženjem porabe za nadzor in obvladovanje stroškov
    • Endpoint-i za iskanje, pakete, ključe, račun, pokritost in stanje sistema pod /api/v1
    • Interaktivna dokumentacija OpenAPI na /api/v1/docs ter strojno berljiva shema OpenAPI
    • Strukturiran izpis, primeren za revizijske dnevnike, dosjeje primerov in nadaljnje odločitve

    §05Pogosta vprašanja o API

    05 / 05
    Q01

    Kako avtenticiram zahtevke API?

    Zahtevki za preverjanje na /api/v1/search in /api/v1/batch se avtenticirajo z API ključem, poslanim v glavi X-API-Key. Ključe ustvarite v nadzorni plošči ali programsko prek /api/v1/keys, po avtentikaciji s tokenom nosilca svojega računa.

    Q02

    Ali je API splošno dostopen?

    Da. API v1 je v produkciji in splošno dostopen. Avtenticirajte se z API ključem, kličite endpoint-e za iskanje, pakete in upravljanje ključev ter raziščite vse v interaktivni dokumentaciji OpenAPI na /api/v1/docs.

    Q03

    Ali lahko omejim pravice API ključa?

    Da. Ključi podpirajo pravice, kot so search:read, search:write, batch:read in batch:write, tako da lahko za vsako integracijo uveljavite dostop z najmanjšimi potrebnimi pravicami.

    Q04

    Katere omejitve zahtevkov veljajo?

    Omejitve zahtevkov so dodeljene glede na raven API in se uveljavljajo za vsak API ključ posebej — raven določa pretočnost zahtevkov, ne obračunavanja. Glave odgovora vključujejo omejitev, preostalo kvoto in čas ponastavitve, tako da lahko zahtevke ustrezno prilagodite.

    Q05

    Kje lahko hitro preizkusim endpoint-e?

    Uporabite interaktivno dokumentacijo na /api/v1/docs za testiranje Swagger in /api/v1/redoc za referenčno dokumentacijo. Shema OpenAPI je na voljo na /api/v1/openapi.json.