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.
Query Parameters
Page size. Default 20, max 100. Use this with `offset` to paginate through large vault counts.
Number of items to skip from the start of the result set. Default 0. Pair with `limit` for cursor-style paging.
Restrict results to a single vault type. `dedicated` returns treasury/operational vaults; `pool` returns exchange-style vaults that hold many wallets.
Filter by lifecycle status. `active` is the default working set; pass `archived` to surface vaults you've previously taken out of rotation.
List Vaults Response
Unique identifier for the vault. Use it to scope wallet creation, exports, and audit lookups.
Display name as supplied on creation, shown in dashboards and audit logs.
`dedicated` (one wallet per chain) or `pool` (unlimited wallets per chain).
Lifecycle status. `active` is in-use; `archived` is taken out of rotation but kept for audit purposes.
Number of wallets currently derived from this vault's seed.
Opaque Enclave-internal seed identifier. Used by Bitnob's signing pipeline; you don't need to act on it.
Arbitrary key-value metadata you set on the vault for your own bookkeeping.
Timestamp when the vault was created.
Timestamp of the most recent change (name, type, or metadata).
Get Vault
Use Case
Retrieves a single vault by ID.
Get Vault Response
The response payload uses the same VaultResponse object as each entry in the List Vaults Response. Refer there for the per-field explanations.