{
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"__event__": {
"type": "OnboardingSession.failed",
"origin": "api"
},
"reference_id": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"individual_ref": "<string>",
"business_ref": "<string>",
"terminal_reason": {
"state": "FAILED",
"message": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Platform
Onboarding session failed
Emitted when a hosted enrollment session fails. Carries the OnboardingSession.completed payload plus terminal_reason. A direct verification sends Verification.failed instead.
WEBHOOK
OnboardingSession.failed
{
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"__event__": {
"type": "OnboardingSession.failed",
"origin": "api"
},
"reference_id": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"individual_ref": "<string>",
"business_ref": "<string>",
"terminal_reason": {
"state": "FAILED",
"message": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Unique id of the submission.
Lifecycle state of the verification workflow.
Available options:
PENDING, EXECUTING, WAITING, COMPLETED, FAILED, EXPIRED, CANCELLED Show child attributes
Show child attributes
Resolved onboarding verdict; null until completion.
Available options:
APPROVED, UNDER_REVIEW, REJECTED Caller-supplied correlation id.
When the workflow reached a terminal state.
Pairwise reference to the verified individual, unique to the calling organization and stable across re-verification.
Pairwise reference to the verified business, when the submission covered one.
Status of the principal-operates-business link as of this submission's evaluation.
Available options:
VERIFIED, UNDER_REVIEW, REJECTED Why the session did not complete.
Show child attributes
Show child attributes
Response
Successful Response