Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Identities

Submit a consumer identity for verification

Submits an identity you collected from a consumer for KYC verification. Verification runs asynchronously: the request is accepted with a 202 and a submission id — poll GET /identity-submissions/{submission_id} or subscribe to the OnboardingSession.completed webhook for the outcome and the resulting principal_ref. Submissions are idempotent per idempotency_key: resubmitting the same key returns the original submission instead of starting a new verification.

post/identity-submissions/consumer

Request body

idempotency_keystring required

Caller-chosen key making the submission idempotent: a resubmission under the same key returns the original submission instead of minting a second session.

reference_idstring nullable

Caller-supplied correlation id.

Response

Response

submission_idstring uuid required

Unique id of the accepted submission — the handle for status polling, and the session id the OnboardingSession.completed webhook carries.

state'PENDING' | 'EXECUTING' | 'WAITING' | 'COMPLETED' | 'FAILED' | 'EXPIRED' | 'CANCELLED' required

Lifecycle state of an asynchronous verification workflow, such as an identity submission: PENDING, EXECUTING, or WAITING while in flight, then a terminal COMPLETED, FAILED, EXPIRED, or CANCELLED.

reference_idstring nullable

Caller-supplied correlation id.