Submit travel rule information for a deposit transfer held pending compliance review.
Required fields vary by jurisdiction and may include originator name, address, date of birth, personal ID, and VASP information.
If the submitted information satisfies all jurisdictional requirements, status will be completed and the transfer will proceed. Otherwise, status will be incomplete and missingFields will indicate which fields still need to be provided.
A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.
An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our Idempotency docs for more information on using idempotency keys.
1 - 128The unique identifier of the transfer.
^transfer_[a-f0-9\-]{36}$"transfer_af2937b0-9846-4fe7-bfe9-ccc22d935114"
Request body for submitting travel rule information for a deposit transfer. Required fields vary by jurisdiction.
Originator information for a deposit travel rule submission.
{
"name": "John Doe",
"address": {
"line1": "123 Main St",
"city": "San Francisco",
"state": "CA",
"postCode": "94105",
"countryCode": "US"
},
"walletType": "custodial",
"vasp": {
"identifier": "5493001KJTIIGC8Y1R17",
"name": "Fidelity Digital Asset Services, LLC"
}
}Beneficiary information for a deposit travel rule submission.
{ "name": "Jane Smith" }Indicates whether the user attests that the originating wallet belongs to them.
false
Successfully submitted travel rule information.
Response from submitting travel rule information for a deposit transfer.
The status of a travel rule submission.
incomplete, completed "incomplete"
List of field paths that are still required to complete travel rule compliance. Each entry is a dot-separated path (e.g., "originator.name", "originator.address.countryCode"). Empty when status is "completed".
["originator.address.countryCode"]Additional context about the current status. Present when status is incomplete to explain what needs to be fixed before the transfer can proceed.
"Originator date of birth is required."