Skip to main content
POST
Create Off-ramp Verification

Authorizations

Authorization
string
header
required

HMAC-SHA256 signature. See the Authorization-Signature header parameter on signed operations.

Headers

Authorization-Signature
string
required

HMAC-SHA256 signature header: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'. The signature is computed over METHOD + path (with the /v3 prefix stripped) + timestamp.

Body

application/json
email
string
required
type
enum<string>
required

Whether the KYC link is for an individual or a business

Available options:
individual,
business
full_name
string
endorsements
enum<string>[]

Payment rail endorsement: base, cards, cop, faster_payments, pix, sepa, or spei

Available options:
base,
cards,
cop,
faster_payments,
pix,
sepa,
spei
redirect_uri
string

Response

KYC link created

id
string
required
type
enum<string>
required

Whether the KYC link is for an individual or a business

Available options:
individual,
business
email
string
required
kyc_status
enum<string>
required

Current verification status of the KYC link

Available options:
not_started,
incomplete,
awaiting_questionnaire,
awaiting_ubo,
under_review,
approved,
rejected,
paused,
offboarded
tos_status
enum<string>
required

Whether the customer has accepted the Terms of Service

Available options:
pending,
approved
customer_id
string | null
full_name
string | null
rejection_reasons
object[]
created_at
string | null