Skip to main content
GET
/
v0
/
insto
/
custody
/
vaults
/
{vault_id}
/
whitelist
/
addresses
List addresses
curl --request GET \
  --url https://api.kraken.com/v0/insto/custody/vaults/{vault_id}/whitelist/addresses \
  --header 'api-key: <api-key>' \
  --header 'api-nonce: <api-key>' \
  --header 'api-otp: <api-key>' \
  --header 'api-sign: <api-key>'
[
  {
    "asset": "BTC",
    "asset_class": "currency",
    "address_name": "My BTC Wallet",
    "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
    "tag": "destination-tag-42",
    "description": "Primary cold storage wallet",
    "beneficiary": {
      "recipient": "other",
      "type": "business",
      "name": "Blue Moon",
      "last_name": "Smith",
      "vasp_name": "Self-custody",
      "country": "US",
      "province": "California",
      "address_1": "123 Main St",
      "address_2": "Apt 4B",
      "city": "New York",
      "postal_code": "10001"
    }
  }
]

Authorizations

​
api-key
string
header
required
​
api-sign
string
header
required
​
api-nonce
string
header
required
​
api-otp
string
header
required

Path Parameters

​
vault_id
string
required

Vault identifier, a V-prefixed 14-char base32 string with a final check character.

Example:

"VABCDEF234567A"

Query Parameters

​
asset
string

Filter results to a single asset code (e.g. BTC). Requires asset_class when supplied.

Example:

"BTC"

​
asset_class
string

Asset class filter. Required when asset is supplied. Currently only currency is supported.

Example:

"currency"

Response

Whitelisted withdrawal addresses for the vault.

​
asset
string
required

Asset code of the whitelisted address (e.g. BTC, ETH, USD).

Example:

"BTC"

​
asset_class
string
required

Asset class. Currently always currency.

Example:

"currency"

​
address_name
string
required

Human-readable label assigned to the address at whitelisting time.

Example:

"My BTC Wallet"

​
address
string

Destination blockchain address. Omitted for entries that only carry beneficiary information.

Example:

"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"

​
tag
string

Destination tag, memo, or other secondary identifier required by chains that use one. Examples: XRP destination tag, EOS memo.

Example:

"destination-tag-42"

​
description
string

Free-text description provided when the address was whitelisted.

Example:

"Primary cold storage wallet"

​
beneficiary
object

Beneficiary details captured for the address. Omitted when no beneficiary information was provided.