Skip to main content
GET
/
kyc
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "type": "individual",
  "email": "<string>",
  "kyc_link": "<string>",
  "kyc_status": "not_started",
  "tos_link": "<string>",
  "tos_status": "pending",
  "customer_id": "<string>",
  "full_name": "<string>",
  "rejection_reasons": [
    {
      "developer_reason": "<string>",
      "reason": "<string>",
      "created_at": "<string>"
    }
  ],
  "created_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://coinvoyage-3c99945b.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization-Signature
string
required

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

Response

KYC link details

​
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