Crypto Offramp — KYC / KYB
Field requirements when a customer converts crypto to fiat and settles to a beneficiary. The required field set depends on whether the party is an individual or a business, and whether they are sending or receiving funds.
Use the create-customer flow with purpose: 'crypto_offramp'. The grouped tables below list every accepted field for the four supported (type, party) combinations. Send only the fields relevant to your combination; unknown or unrelated fields are ignored.
Document fields under documents and ubos[].documents reference document_id values returned by a prior uploadCustomerDocument call. Each id is single-use, project-scoped, and expires 24h after upload if not attached.
Individual — sender
Apply when type = 'individual' and party = 'sender'. The sender is the natural person initiating the offramp transaction — these fields drive compliance and KYC at the partner.
| Field | Type | Required | Description |
|---|---|---|---|
| first_name | string | Yes | Sender's legal first name as it appears on the identity document. |
| middle_name | string | No | Sender's middle name if present on the identity document. |
| last_name | string | Yes | Sender's legal last name as it appears on the identity document. |
| string | No | Required if mobile_number is not provided. At least one of email or mobile_number must be present. | |
| mobile_number | string | No | Required if email is not provided. At least one of email or mobile_number must be present. |
| isd_code | string | No | International Subscriber Dialing code (e.g. +91). Required when mobile_number is provided. |
| identity_document_type | passport | national_id | ssn | Yes | Type of identity document used to verify the sender for compliance. |
| identity_document_number | string | Yes | Document number that corresponds to the chosen identity_document_type. |
| residence_country | IN | US | SG | No | ISO 3166-1 alpha-2 country code. When provided, the partner enforces country-specific document rules (e.g. residence_country = 'IN' requires identity_document_type = 'pan'). |
Individual — receiver
Apply when type = 'individual' and party = 'receiver'. The receiver is the natural-person beneficiary of the offramp settlement — no identity document is required because settlement happens against the contact details only.
| Field | Type | Required | Description |
|---|---|---|---|
| first_name | string | Yes | Receiver's legal first name. |
| middle_name | string | No | Receiver's middle name if present. |
| last_name | string | Yes | Receiver's legal last name. |
| string | No | Required if mobile_number is not provided. At least one of email or mobile_number must be present. | |
| mobile_number | string | No | Required if email is not provided. At least one of email or mobile_number must be present. Used for settlement notifications. |
| isd_code | string | No | International Subscriber Dialing code. Required when mobile_number is provided. |
Business — sender
Apply when type = 'business' and party = 'sender'. The sender business is the entity initiating the offramp. Requires company-level identity plus a UBO array for beneficial-ownership disclosure.
| Field | Type | Required | Description |
|---|---|---|---|
| country_of_incorporation | string (ISO 3166-1 alpha-2) | Yes | Two-letter country code for the company's country of incorporation. |
| documents.certificate_of_incorporation | document_id (PDF) | Yes | Document id from a prior uploadCustomerDocument call. Single-use, project-scoped, 24h TTL if not attached. |
| ubos | array (1–5 entries) | Yes | Ultimate Beneficial Owners. Each UBO must include identity_document_type and identity_document_number. |
| ubos[].identity_document_type | passport | national_id | ssn | Yes | Identity document type for the UBO. |
| ubos[].identity_document_number | string | Yes | Identity document number for the UBO matching its identity_document_type. |
Business — receiver
Apply when type = 'business' and party = 'receiver'. The receiver business is the settlement beneficiary — only country_of_incorporation is required at create time; additional documents may be requested by authorities post-creation.
| Field | Type | Required | Description |
|---|---|---|---|
| country_of_incorporation | string (ISO 3166-1 alpha-2) | Yes | Two-letter country code for the company's country of incorporation. |