Skip to main content
POST
/
off-ramp
/
verification
Create Off-ramp Verification
curl --request POST \
  --url https://api.coinvoyage.io/v3/off-ramp/verification \
  --header 'Authorization: <api-key>' \
  --header 'Authorization-Signature: <authorization-signature>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "full_name": "<string>",
  "endorsements": [],
  "redirect_uri": "<string>"
}
'
{
  "id": "<string>",
  "email": "<string>",
  "kyc_link": "<string>",
  "tos_link": "<string>",
  "customer_id": "<string>",
  "full_name": "<string>",
  "rejection_reasons": [
    {
      "developer_reason": "<string>",
      "reason": "<string>",
      "created_at": "<string>"
    }
  ],
  "created_at": "<string>"
}

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_link
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_link
string
required
​
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