Assign AML customer reference ID - Fireblocks Developer Docs

POST

vault

accounts

{vaultAccountId}

{assetId}

addresses

{addressId}

set_customer_ref_id

TypeScript

const response: Promise<FireblocksResponse<VaultActionStatus>> = fireblocks.vaults.setCustomerRefIdForAddress(vaultsApiSetCustomerRefIdForAddressRequest);

{
  "success": true
}

Headers

Idempotency-Key

string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Path Parameters

vaultAccountId

string<numeric>

required

The ID of the vault account

assetId

string

required

The ID of the asset

addressId

string

required

The address for which to add a description. For XRP, use

:, for all other assets, use only the address

Body

application/json

customerRefId

string

Customer reference ID

Response

success

boolean

Refresh asset balance dataUpdates the balance of a specific asset in a vault account. This API endpoint is subject to a strict rate limit. Should be used by clients in very specific scenarios. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

⌘I

TypeScript

const response: Promise<FireblocksResponse<VaultActionStatus>> = fireblocks.vaults.setCustomerRefIdForAddress(vaultsApiSetCustomerRefIdForAddressRequest);

{
  "success": true
}