Skip to main content
GET
Get a hosted enrollment session

Authorizations

X-API-Key
string
header
required

Path Parameters

session_id
string<uuid>
required

Response

Successful Response

GET /onboarding/sessions/{session_id}: the session's state, plus its outcome for a customer. An API key reads it without the fields the public spec hides; the applicant's embed reads the state alone.

id
string<uuid>
required

Onboarding session id.

state
enum<string>
required

Lifecycle state of the resumable workflow.

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

Caller-supplied correlation id from session creation.

verdict
enum<string> | null

The effective verdict: your reviewer's decision when one was made, otherwise what the checks concluded; null until the session completes.

Available options:
APPROVED,
UNDER_REVIEW,
REJECTED
terminal_reason
IdentitySubmissionTerminalReasonResponse (v1) · object | null

Typed state and detail when the session ended in FAILED; null otherwise.

created_at
string<date-time> | null

When the session was started.

completed_at
string<date-time> | null

When the session reached a terminal state; null until then.