Skip to main content
GET
Get vault

Authorizations

api-key
string
header
required
api-sign
string
header
required
api-nonce
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"

Response

OK. Returns vault metadata for the requested vault.

id
string
required

Vault identifier, a V-prefixed 14-char base32 string with a final check character. This is the canonical ID used in vault-scoped endpoints (the {vault_id} path parameter).

Example:

"VW44KPQC4C62K6"

iiban
string
required

Vault IIBAN, 16-char alphanumeric in 4x4 groups. A funding account number for the same vault as id — not interchangeable with id in path parameters.

Example:

"AA88 N84G AET3 RAOA"

name
string
required

Human-readable vault name.

Example:

"My Vault 1"

status
string
required

Vault lifecycle status.

Example:

"created"

created_at
string<date-time>
required

Vault creation time as an RFC 3339 UTC timestamp (Z offset required), e.g. 2026-01-15T12:34:56Z.

Example:

"2026-01-15T12:34:56Z"

attributes
string[]
required

Vault attribute labels (e.g. token_vesting).

Example:
description
string | null

Optional vault description.

Example:

"Primary cold vault"

deposit_lock_rekeying_only
boolean | null

Whether the vault's deposits are restricted to rekeying only. Null when not set.

Example:

false