Overview

Vaults are HD seed containers. Every wallet belongs to exactly one vault. Dedicated vaults map 1:1 to a single wallet per chain; pool vaults hold unlimited wallets.


List Vaults

Use Case

Returns a paginated list of vaults in the organization.

List Vaults

Query Parameters
1
limitinteger

Page size. Default 20, max 100. Use this with `offset` to paginate through large vault counts.

2
offsetinteger

Number of items to skip from the start of the result set. Default 0. Pair with `limit` for cursor-style paging.

3
vault_typestring

Restrict results to a single vault type. `dedicated` returns treasury/operational vaults; `pool` returns exchange-style vaults that hold many wallets.

4
statusstring

Filter by lifecycle status. `active` is the default working set; pass `archived` to surface vaults you've previously taken out of rotation.

List Vaults Request

List Vaults Response
1
idstring (uuid)

Unique identifier for the vault. Use it to scope wallet creation, exports, and audit lookups.

2
namestring

Display name as supplied on creation, shown in dashboards and audit logs.

3
vault_typestring

`dedicated` (one wallet per chain) or `pool` (unlimited wallets per chain).

4
statusstring

Lifecycle status. `active` is in-use; `archived` is taken out of rotation but kept for audit purposes.

5
wallet_countinteger

Number of wallets currently derived from this vault's seed.

6
provider_wallet_idstring

Opaque Enclave-internal seed identifier. Used by Bitnob's signing pipeline; you don't need to act on it.

7
metadataobject

Arbitrary key-value metadata you set on the vault for your own bookkeeping.

8
created_atstring (RFC3339)

Timestamp when the vault was created.

9
updated_atstring (RFC3339)

Timestamp of the most recent change (name, type, or metadata).

List Vaults Response

Get Vault

Use Case

Retrieves a single vault by ID.

Get Vault

Get Vault Response
Same shape as List Vaults Response

The response payload uses the same VaultResponse object as each entry in the List Vaults Response. Refer there for the per-field explanations.

Get Vault Response
Did you find this page useful?

Join our Discord