Skip to main content
POST
/
travel_rule_data
/
{id}
Submit travel rule data.
curl --request POST \
  --url https://api.bridge.xyz/v0/travel_rule_data/{id} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "originator": {
    "is_self": true,
    "wallet_type": "external"
  },
  "beneficiary": {
    "name": "Jane Smith",
    "address": {
      "street_line_1": "123 Market St",
      "street_line_2": null,
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94105",
      "country": "USA"
    },
    "wallet_type": "hosted",
    "wallet_attested_ownership_at": "2026-04-01T12:00:00Z"
  },
  "transfer_purpose": "customer_withdrawal"
}
'
{ "message": "Travel rule data processed successfully" }

Documentation Index

Fetch the complete documentation index at: https://apidocs.bridge.xyz/llms.txt

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

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
id
string
required

The ID of the resource to associate with this Travel Rule payload. Supported IDs include transfer IDs, virtual account IDs, virtual account event IDs, liquidation address IDs, bridge wallet event IDs, and drain IDs.

Body

application/json

The Travel Rule payload to associate with the specified resource.

Travel Rule data for a crypto movement. Send this on create or update when the same counterparty should apply to every future use of a reusable resource, or send the same payload with POST /travel_rule_data/{id} when it belongs to one specific movement.

​
originator
object

The party sending the crypto.

​
beneficiary
object

The party receiving the crypto.

​
transfer_purpose
string

A short reason for the movement, such as customer_withdrawal, self_custody, or payment.

Response

Travel Rule data processed successfully

​
message
string
required

Message indicating the status of the request.