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

Base URL
https://api.baselayer.com
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/baselayer/apis/baselayer-api-service/docs/identity-submissions/consumer/post.ts
A function with typed inputs. Its response is checked against the schema.

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

submission_idstring uuid required

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

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.