REST API: KYC
KYC sessions
The operations behind a verification session.
A session is one verification of one user, created from a scenario. Your backend creates it, the user completes the steps in the web widget, and your backend reads the result, or receives the SESSION_COMPLETE webhook.
Scenarios are created and edited in the dashboard. The API works with the identifier of a scenario that already exists.
| Operation | Endpoint | What it does |
|---|---|---|
| Create session | kyc/session/create | Start a session from a scenario. |
| Session status | kyc/session/status | Read one session or questionnaire record. |
| List sessions | kyc/sessions | Page through sessions, newest first. |
| Filter sessions | kyc/sessions/filter | Search sessions, or order an export archive. |
| Download logs archive | kyc/download | Fetch an export archive. |
| Recognize documents and selfies | kyc/process | Upload images from your backend. |
| Change session status | kyc/session/status/change | Record a manual decision. |
| Database check results | kyc/session/databases | Read AML and other database check verdicts. |
| List questionnaire sessions | kyc/questionnaire/sessions | Page through questionnaire records. |
| Delete questionnaire session | kyc/questionnaire/session/delete | Delete a questionnaire record on request. |
| Erase session personal data | kyc/session/erase | Destroy personal data on request. |
| Data erasure log | kyc/session/erase/log | Read the journal of destruction. |
Read first
- The session object describes the body most of these operations return.
- Response format and errors explains why you branch on the
statusfield of the body. - Session statuses lists the values a session and its steps can have.