Sign in
kyc

Create KYC Link

Generate a KYC/TOS verification link via Bridge.xyz for a customer to complete identity verification

post/kyc

Headers

Authorization-Signaturestring required

Authorization header format: 'APIKey=<api_key>,signature=<signature>,timestamp=<unix_timestamp>'

Request body

emailstring required
type'individual' | 'business' required

Whether the KYC link is for an individual or a business

full_namestring
endorsementsEndorsementName[]
redirect_uristring

Response

KYC link created successfully

idstring required
type'individual' | 'business' required

Whether the KYC link is for an individual or a business

customer_idstring nullable
full_namestring nullable
emailstring required
kyc_linkstring required
kyc_status'not_started' | 'incomplete' | 'awaiting_questionnaire' | 'awaiting_ubo' | 'under_review' | 'approved' | 'rejected' | 'paused' | 'offboarded' required

Current verification status of the KYC link

tos_linkstring required
tos_status'pending' | 'approved' required

Whether the customer has accepted the Terms of Service

created_atstring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.