Update Missing Travel Rule Information for Rapid Deposit Address

put

https://api.getorbital.io/crypto/deposit/receiving-address/travel-rule/{ExternalID}

Update Travel Rule information for ONLY Rapid Deposit address. Not applicable to invoice-generated deposits..

Path Params

ExternalID

string

required

The external ID of the deposit address requiring Travel Rule information.

Body Params

firstName

string

required

length ≤ 100

Payer's first name.

lastName

string

required

length ≤ 100

Payer's last name.

countryOfResidence

string

required

The country where the payer's resides (ISO-3166-1 alpha-2).

streetName

string

required

length ≤ 70

Street name of the payer address.

buildingNumber

string

required

length ≤ 16

Building number of the payer address.

identificationType

string

enum

required

The type of identification used for the payer.

Allowed:

placeOfBirth

string

length ≤ 70

Payer's place of birth. Required if identificationType is placeOfBirth.

documentNumber

string

length ≤ 35

Identification document number. Required if identificationType is nationalRegistration.

documentType

string

enum

Identification document. Required if identificationType is nationalRegistration.

documentCountryOfIssue

string

The country that issued the identification document (ISO-3166-1 alpha-2 code). Required if identificationType is nationalRegistration.

customerId

string

length ≤ 50

The internal ID for the payer. Required if identificationType is nationalRegistration.

dateOfBirth

date

required

Payer's date of birth (YYYY-MM-DD).

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Travel Rule information updated successfully. Payment will now continue processing.

400Invalid request parameters or validation failures.