Skip to main content
POST
Create Identity Verification Check

Authorizations

Authorization
string
header
required

Bearer authentication with an API token

Path Parameters

identity_id
string
required

Unique identifier of the identity to verify

Body

application/json
identity_id
string

Unique identifier of the identity to verify

redirect_url
string | null

(OPTIONAL) URL to redirect the user to after completing identity verification

reason
enum<string>

Reason for the identity verification check

Available options:
IDV_CHECK_REASON_UNSPECIFIED,
ONBOARDING,
ACCOUNT_RECOVERY,
RFI
Example:

"ONBOARDING"

request_id
string

Client-provided idempotency key

labels
string[]

(OPTIONAL) Labels to associate with this identity verification check

(OPTIONAL)

Response

Success

id_verification_check
id_verification_check · object

The created identity verification check