API SPEC · V1 · GADEVELOPER REFERENCE

    Developer API

    REST API voor AML-screening

    Bouw screening op sancties, PEP, opsporingslijsten, adverse media (negatieve berichtgeving) en KYB/UBO rechtstreeks in uw onboarding-, monitoring- en transactieflows. De API is live: authenticeer met een API-sleutel en roep dezelfde screeningengine aan die het portaal gebruikt.

    API v1 is live

    De endpoints zijn algemeen beschikbaar met API-sleutelauthenticatie en rate limits per abonnementsniveau. Verken elk endpoint in de interactieve OpenAPI-documentatie op /api/v1/docs.

    §01Snel starten

    01 / 05
    STEP 01

    1. Maak een API-sleutel aan

    Maak in uw dashboard een API-sleutel met beperkte rechten aan, of genereer er programmatisch een met uw account-bearertoken voor server-naar-server-verzoeken.

    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. Voer uw eerste zoekopdracht uit

    Dien een entiteit in met de X-API-Key header. De API retourneert een search-ID dat u ophaalt zodra de verwerking klaar is.

    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. Dien een batch in

    Stuur een CSV/XLSX-bestand om meerdere entiteiten in één taak te screenen en haal daarna de rijen of exports op zodra de batch klaar is.

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

    §02Kern-endpoints

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Maak een screeningverzoek aan voor één entiteit. Retourneert een search-ID en de verwerkingsstatus. Ook endpoints voor account, dekking en health zijn beschikbaar onder /api/v1.

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

    EP 02ENDPOINT

    POST /api/v1/batch

    Dien CSV/XLSX-bestanden in voor screening met hoog volume en haal daarna de rijen of exports op zodra de taken klaar zijn.

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

    EP 03ENDPOINT

    POST /api/v1/keys

    Maak API-credentials aan en beheer ze met beperkte rechten, rate limits per abonnementsniveau en gebruiksregistratie.

    Auth: Bearer-token (account)

    §03Waarom teams deze API gebruiken

    03 / 05
    • Eén integratie voor screening op sancties, PEP, opsporingslijsten, adverse media en KYB/UBO
    • API-sleutelauthenticatie via de X-API-Key header, met rechtenbeperkte sleutels voor least-privilege-toegang
    • Rate limits per abonnementsniveau met gebruiksregistratie voor governance en kostenbeheersing
    • Endpoints voor search, batch, keys, account, dekking en health onder /api/v1
    • Interactieve OpenAPI-documentatie op /api/v1/docs plus een machineleesbaar OpenAPI-schema
    • Gestructureerde output, geschikt voor audittrails, dossiers en downstream beslissingen

    §05API FAQ

    05 / 05
    Q01

    Hoe authenticeer ik API-verzoeken?

    Screeningverzoeken aan /api/v1/search en /api/v1/batch authenticeert u met een API-sleutel die u meestuurt in de X-API-Key header. Maak sleutels aan in uw dashboard, of programmatisch via /api/v1/keys nadat u zich met uw account-bearertoken hebt geauthenticeerd.

    Q02

    Is de API algemeen beschikbaar?

    Ja. API v1 is live en algemeen beschikbaar. Authenticeer met een API-sleutel, roep de endpoints voor search, batch en sleutelbeheer aan, en verken alles in de interactieve OpenAPI-documentatie op /api/v1/docs.

    Q03

    Kan ik de rechten van een API-sleutel beperken?

    Ja. Sleutels ondersteunen permissies zoals search:read, search:write, batch:read en batch:write, zodat u per integratie least-privilege-toegang kunt afdwingen.

    Q04

    Welke rate limits gelden er?

    Rate limits worden toegekend per API-niveau en gehandhaafd per API-sleutel — het niveau bepaalt de verzoekdoorvoer, niet de facturering. De response-headers bevatten de limiet, het resterende quotum en reset-tijdstempels, zodat u netjes kunt afremmen.

    Q05

    Waar test ik de endpoints snel?

    Gebruik de interactieve documentatie op /api/v1/docs voor Swagger-tests en /api/v1/redoc voor referentiedocumentatie. Het OpenAPI-schema wordt aangeboden op /api/v1/openapi.json.