All Travel Rule fields live on theDocumentation Index
Fetch the complete documentation index at: https://paxos-0ac97319-preview-travel-rule-api-changes.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
travelrule_metadata object on PUT /v2/transfer/crypto-destination-address.
Fields
| Field | Type | Required (US) | Description |
|---|---|---|---|
custodian_type | enum | Always | Type of wallet at the destination: VASP (held at another regulated institution) or PRIVATE (unhosted/self-custody). Drives downstream validation. |
vasp.id | string | When custodian_type = VASP (preferred) | Paxos identifier for the receiving institution. Resolve via GET /v2/travelrule/vasps. |
vasp.name | string | When custodian_type = VASP and no vasp.id available | Name of the receiving institution. Fallback for institutions not in the Paxos directory. |
vasp.website_url | string | When vasp.name is specified | Website URL of the receiving institution. Required alongside vasp.name to identify off-directory VASPs. |
transfer_purpose | enum | Optional (US); required in SG/EU | Purpose of the transfer. Recommended for partners with cross-jurisdictional flows. |
beneficiary | object | Always | Beneficiary details. Provide either person_details or institution_details, or set self = true for me-to-me transfers. |
beneficiary.self | boolean | Optional | Set true when the destination wallet belongs to the same end user as the originator. When set, omit person_details and institution_details. |
beneficiary.person_details.first_name | string | When beneficiary is a person | Legal first name. |
beneficiary.person_details.last_name | string | When beneficiary is a person | Legal last name. |
beneficiary.person_details.physical_address.country | string | When beneficiary is a person | Country of the beneficiary. |
beneficiary.institution_details.name | string | When beneficiary is an institution | Legal name of the institution. |
beneficiary.institution_details.physical_address.country | string | When beneficiary is an institution | Country of the institution. |
beneficiary.person_details.physical_address.address1 | string | Optional | Street address line 1. |
beneficiary.person_details.physical_address.address2 | string | Optional | Street address line 2. |
beneficiary.person_details.physical_address.city | string | Optional | |
beneficiary.person_details.physical_address.province | string | Optional | State or province. |
beneficiary.person_details.physical_address.zip_code | string | Optional |
vasp.id or vasp.name + vasp.website_url, not both. Prefer vasp.id — Travel Rule messages can only be transmitted automatically when a directory ID is provided.
Examples
Each example below is aPUT /v2/transfer/crypto-destination-address request body.