COcoinvoyage
off-ramp

Create Off-ramp Verification

Changed on

Internal credentials only. The request signature appends the lowercase hex SHA-256 digest of the exact request body after method, path, and timestamp.

post/off-ramp/verification

Request

Headers

Authorization-Signaturestring required

Body-bound HMAC-SHA256 signature header: 'APIKey=<api_key>,signature=<hex>,timestamp=<unix_timestamp>'. The signature is computed over METHOD + path (with the /v3 prefix stripped) + timestamp + lowercase hex SHA-256 digest of the exact request body.

Request body

emailstring required
type'individual' | 'business' required

Whether the KYC link is for an individual or a business

full_namestring
endorsementsEndorsementName[]
redirect_uristring
email_challenge_idstring required
email_challenge_codestring required

Response

KYC link created

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
requirement_urlstring nullable

Changes

  • 86cc796d122eRevision changes
    • info

      added the optional property to the response with the status

  • b82377b55a17Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status