Skip to main content
GET
Get a hosted enrollment session's results

Authorizations

X-API-Key
string
header
required

Path Parameters

session_id
string<uuid>
required

Response

Successful Response

The outcome of a completed onboarding session.

The verdict and review history, around four sections frozen when the session completed: inputs (what the applicant submitted), person (their confirmed identity), business (the business and its verification), and results (the checks' outcomes).

id
string<uuid>
required

Onboarding session id.

inputs
OnboardingInputs · object
required

What the applicant submitted during the session.

results
OnboardingResults · object
required

Outcome of the session's verification checks, led by the overall verification level.

verdict
enum<string> | null

Resolved onboarding verdict: the manual decision when one was made, otherwise the automated verdict from delivery.

Available options:
APPROVED,
UNDER_REVIEW,
REJECTED
manual_decision
OnboardingDecisionView (v1) · object | null

Latest manual decision, when present.

created_at
string<date-time> | null

Session creation timestamp.

completed_at
string<date-time> | null

When the session reached terminal state.

reference_id
string | null

Caller-supplied correlation id.

template_name
string | null

Onboarding template the session ran.

template_version
integer | null

Published template version the session minted from; null for draft/test sessions.

uploaded_document_count
integer
default:0

Number of documents uploaded to the session, including uploads the applicant later replaced, so it can exceed inputs.documents.

active_checks
string[] | null

Verification checks (KYC, KYB) the session's flow included, or null when unknown. Tells a check the template did not include apart from one that ran and produced no result.

findings
OnboardingFinding · object[]

Findings recorded when the session completed: the issues that hold a session for review, plus informational evidence flags (website corroboration, officer match).

person
OnboardingPerson · object | null

Confirmed identity of the person; null when the session confirmed no identity.

business
OnboardingBusiness · object | null

Asserted + KYB-resolved business identity; null when the session collected no business.

owners
OnboardingOwner · object[]

Beneficial owners the applicant entered, each with their per-owner KYC result, in entry order.