Skip to main content
POST
Start a hosted enrollment session

Authorizations

X-API-Key
string
header
required

Body

application/json

Request to start an onboarding session for one applicant.

Call it from your server; the applicant completes the flow at the returned embed_url.

template_id
string<uuid>
required

ID of the customer journey to run, as built and published in Console; it is the last part of the journey's Console URL. The session runs the latest published version, and a journey that was never published is rejected.

reference_id
string | null

Your own identifier for the applicant or application, returned on the session, its results and its webhooks.

Response

Successful Response

A newly started onboarding session and the link the applicant opens.

id
string<uuid>
required

Onboarding session id. Use it to fetch results and to match OnboardingSession webhooks.

session_token
string
required

Secret token that lets the applicant's browser drive this session. Returned only once and already embedded in embed_url; treat it as a credential.

embed_url
string
required

URL of the hosted flow for this session. Open it for the applicant or load it in an iframe.

expires_at
string<date-time>
required

When session_token, and so embed_url, stops working.

reference_id
string | null

Caller-supplied correlation id.