Applicants

An applicant is a user who is going through or has completed verification. The Tenant API exposes the applicant list, individual applicant details, verification and AML screening results, and the document list. Each endpoint requires the matching scope on the API key.

List applicants

Returns a paginated list of applicants with filters for status, creation date, and external identifier. Required scope: applicants:read.

GET undefined/v1/kyc/applicants

Get applicant by ID

Returns the full applicant record by internal identifier (UUID). Required scope: applicants:read.

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

Get applicant by external ID

Looks up an applicant by the external identifier (external_id) provided when the verification link was created. Required scope: applicants:read.

GET undefined/v1/kyc/applicants/external/{external_id}

Applicant verification sessions

Returns all verification sessions linked to the applicant. Required scope: applicants:read.

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

Applicant history

Returns the chronological event log for the applicant (creation, status updates, check results). Required scope: applicants:read.

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

Verification result

Returns the final verification result for the applicant, including the decision status, check details, and contact fields (email, phone) from the applicant record. Check details include the normalized ocr, doc_liveness, face_liveness, and face_match blocks when those checks are present. Required scope: verifications:read.

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

AML screening result

Returns the result of sanctions and PEP screening (when the flow contains an AML step). Required scope: verifications:read.

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

Applicant documents

Returns the list of documents uploaded by the applicant during verification. When OCR data is available, extracted_data includes the standard document fields plus extended_data for additional provider-normalized OCR fields. Required scope: documents:read.

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

Delete applicant data

Submits a deletion request for the applicant's data, including documents, selfies, and verification results, in line with GDPR requirements. Actual deletion is executed only after OneKYC approval; after approval, the deletion is irreversible. Required scope: applicants:write.

DELETE undefined/v1/kyc/applicants/{applicant_id}

---

For the full field specification, error codes, and request examples, see API reference (OpenAPI).