Get vault information by id

POST 
/0/private/GetCustodyVault

Retrieve information and balances for a specific vault.

Request

Query Parameters

id stringrequired

Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$

Vault ID

application/json

Body

required

required
nonce int64

Nonce used in construction of API-Sign header

Responses

200

application/json

Schema

Schema

result objectnullable

Metadata of a vault

id stringrequired

Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$

An ID uniquely identifying the vault

created_at UnixTimestamp (string)required

Possible values: <= 13 characters

Vault creation time

updated_at UnixTimestamp (string)required

Possible values: <= 13 characters

Last time an attribute of the vault was changed

count_assets uint32required

Count of the number of unique assets for a vault

asset_details object[]required

A list of the assets in this vault

Array [

asset stringrequired

Possible values: non-empty and <= 16 characters

The asset as ISO x-iso-4217-a3

current_usd_price stringnullable

Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

Current USD price of the asset

available_balance objectrequired

Available amount of a crypto-asset

current_usd_value stringnullable

Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

Current USD value of the asset

quantity stringrequired

Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

Asset quantity

total_balance objectrequired

Total amount of a crypto-asset

current_usd_value stringnullable

Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

Current USD value of the asset

quantity stringrequired

Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

Asset quantity

]

status stringrequired

Possible values: [pending, created, failed, disabled]

Vault status:

• pending: The HSM vault is still initializing
• created: The HSM vault has been created
• failed: The HSM vault creation has failed
• disabled: The underlying account has been disabled

iiban stringrequired

Possible values: >= 14 characters and <= 42 characters

The IIBAN of the vault.

deposit_lock_rekeying_only booleannullable

name stringrequired

Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$

Vault name

description stringnullable

Possible values: <= 1024 characters

A description of the vault

balance_fiat stringnullable

Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

Total balance in fiat currency

balance_diff stringnullable

Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

Balance percentage daily change relative to midnight's total balance

available_balance_fiat stringnullable

Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

Available balance in fiat currency

errors object[]required
Array [
severity stringrequired
Possible values: [E, W]
API error severity.
errorClass stringrequired
type stringrequired
errorMessage stringnullable
]

Example (from schema)

{
  "result": {
    "id": "VW44KPQC4C62K6",
    "name": "My Vault 1",
    "description": "My vault description",
    "created_at": "1710877421",
    "updated_at": "1710877421",
    "balance_fiat": "1000.0000",
    "balance_diff": "1.25",
    "available_balance_fiat": "1000.0000",
    "count_assets": 3,
    "asset_details": [
      {
        "asset": "BTC",
        "current_usd_price": "7.00",
        "available_balance": {
          "current_usd_value": "20.0",
          "quantity": "0.00000500"
        },
        "total_balance": {
          "current_usd_value": "5.00",
          "quantity": "0.00001000"
        }
      }
    ],
    "status": "created",
    "iiban": "AA88 N84G AET3 RAOA",
    "deposit_lock_rekeying_only": false
  },
  "errors": [
    {
      "severity": "E",
      "errorClass": "string",
      "type": "string",
      "errorMessage": "string"
    }
  ]
}

Loading...