Developers
REST API reference
Every operation, grouped, with request, response, errors and an example.
Operation groups
Access tokens
List, create, update and delete the permanent API tokens of your account.
Access tokensKYC sessions
Create sessions, read results, list and export them, read database check results and erase personal data.
KYC sessionsUsers
User authorization for a user token, and the balance of an account group.
UsersWorking with faces
Detect, compare and search faces; data sources, person lists, persons and vectors.
Working with facesResponse format and errors
The status field, the error shapes and the refusals that come before an operation.
Response format and errorsWeb SDK
The widget that your user sees, its parameters and the client key.
Web SDK
Before the first call
- All calls are POST under the API address that is provided with your access. The samples use the placeholder
<API_BASE_URL>. - Send a permanent API token in the
tokenfield of the JSON body, or a user token in thetokenheader. See authentication. - Branch on the
statusfield of the body, not on the HTTP code. See response format and errors. - Scenarios are created and edited in the dashboard. The API uses the identifier of a scenario that already exists.
The six operations of the quick start
Create session, session status, filter sessions, change session status, erase session personal data and data erasure log are the operations the quick start lists.