← All feature guides Platform

API and Webhooks

API and Webhooks let technical teams embed CV analysis, sanctions screening, PEP checks, batch screening, reports, and monitoring events into existing products.

What It Covers

Automate checks with API keys, scopes, usage limits, and event webhooks.

01

Token scopes for CV, sanctions, PEP, reports, and admin workflows

02

API key, X-API-Key, and bearer token auth support

03

Webhook events for screening and batch completion

04

Developer documentation and code examples

Steps

How to use api and webhooks

1

Create an API token

Choose only the scopes needed for the integration.

2

Call the endpoint

Send requests to the relevant CV, sanctions, PEP, batch, or report endpoint.

3

Listen for events

Register webhooks to receive completion, alert, and batch updates.

Next Step

Choose the right access path before opening the workflow.