For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sessions

A verification session represents a single execution of the verification flow by an end user: document upload, selfie, liveness check, and any other steps configured in the flow. A session is created automatically when the user opens a verification link (see Verification links); the user goes through every step on the OneKYC verification page.

Creating a session

In the Tenant API, sessions are created through the verification-link endpoints. When the user opens the link, a new verification session is initialised automatically.

POST undefined/v1/kyc/verification-links

POST undefined/v1/kyc/verification-links/batch

For full link-management details, see Verification links.

Session lifecycle

A session goes through the following stages:

  1. Creation — the session is initialised when the verification link is activated.

  2. In progress — the user works through the steps in order (document upload, selfie, liveness, etc.).

  3. Completion — once all checks finish, the session receives a final status: approved, rejected, or routed to manual review.

Fetching applicant session data

The list of verification sessions for an applicant and the verification results are available through the endpoints below (required scopes: applicants:read, verifications:read):

GET undefined/v1/kyc/applicants/{applicant_id}/sessions

GET undefined/v1/kyc/applicants/{applicant_id}/verification


For the full request and response field specification, see API reference (OpenAPI).

Last updated