Update external address

This endpoint allows for the updating of a user’s external address, primarily to comply with Travel Rule requirements. It ensures that the user's address information is accurate and current, aiding in regulatory compliance and smooth transaction processing across different jurisdictions. This endpoint updates deposit addresses when necessary, but not all addresses can be updated.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

The unique identifier for the external address associated with this transaction. This Address ID links the withdrawal to a specific user address.

header Parameters
bp-user-id
required
string <uuid>
Example: 12312312-2be6-4522-977e-ea4d92c45e86
Request Body schema: application/json

The address details that needs to be updated.

host_type
string

Host Type - Specifies the type of wallet or entity hosting the crypto address. The possible values are:

  • KNOWN_VASP: A verified Virtual Asset Service Provider (VASP) such as a licensed exchange.
  • UNKNOWN_VASP: An unverified or unrecognized Virtual Asset Service Provider.
  • SELF_HOSTED: A self-custodied wallet, such as MetaMask, where the user has direct control over their private keys.
Enum: "KNOWN_VASP" "UNKNOWN_VASP" "SELF_HOSTED"
host_name
string or null

The name of the platform or wallet provider associated with the crypto address, represented as a string (e.g., “Binance,” “Coinbase,” etc.).

user_owned
boolean

A boolean indicating ownership of the address. true if the address belongs to the user making the request; false if it belongs to another user.

owner_legal_name
string

The legal name of the address beneficiary, required only if user_owned is false. This specifies the full name of the person or entity that owns the address when it does not belong to the requesting user.

Responses
200

Success Response

400

Bad requeset

401

Unauthorized

403

Forbidden

404

Not Found

422

Validation Error

500

Internal Error

503

Service unavailable

patch/v1/crypto-transfers/addresses/{id}
Request samples
application/json
{
  • "host_type": "KNOWN_VASP",
  • "host_name": "Bitpanda",
  • "user_owned": false,
  • "owner_legal_name": "John Doe"
}
Response samples
application/json
{
  • "data": {
    }
}