Skip to main content
POST
Submit a consumer identity for verification

Authorizations

X-API-Key
string
header
required

Body

Body for POST /identity_submissions/consumer.

idempotency_key
string
required

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

Required string length: 1 - 255
consumer
ConsumerIdentityPayload (v1) · object
required

The consumer identity to verify.

reference_id
string | null

Caller-supplied correlation id.

Maximum string length: 128

Response

Response

Body for the submission routes: the accepted, asynchronous submission.

KYC/KYB run asynchronously — the response never carries a verification result. Poll GET /identity_submissions/{submission_id} or subscribe to the OnboardingSession.completed webhook for the outcome and refs.

submission_id
string<uuid>
required

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

state
enum<string>
required

Lifecycle state of the verification workflow.

Available options:
PENDING,
EXECUTING,
WAITING,
COMPLETED,
FAILED,
EXPIRED,
CANCELLED
reference_id
string | null

Caller-supplied correlation id.