Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Identities

Poll a submission's verification status

Returns the verification state of a submission and, once complete, the org-scoped pairwise refs. Accepts any of the calling organization's onboarding session ids — direct submissions and hosted-embed sessions alike.

get/identity-submissions/{submission_id}

Path parameters

submission_idstring uuid required

Response

Response

submission_idstring uuid required

Unique id of the submission.

state'PENDING' | 'EXECUTING' | 'WAITING' | 'COMPLETED' | 'FAILED' | 'EXPIRED' | 'CANCELLED' required

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.

verdict'APPROVED' | 'UNDER_REVIEW' | 'REJECTED'

Normalized onboarding verdict used across provider-specific outputs.

reference_idstring nullable

Caller-supplied correlation id.

completed_atstring date-time nullable

When the workflow reached a terminal state.

principal_refstring nullable

Pairwise reference to the verified principal, unique to the calling organization and stable across re-verification.

business_refstring nullable

Pairwise reference to the verified business, when the submission covered one.

business_operator_link_status'VERIFIED' | 'UNDER_REVIEW' | 'REJECTED'

Status of the link between a person (principal) and a business they operate.

VERIFIED is earned by the full evidence recipe (TIN provided + IRS-matched + KYB-verified) or granted by manual review; UNDER_REVIEW is every automatic shortfall; REJECTED is a manual refusal. A rejected link is immutable — a later submission evaluates the pair fresh.