Get vault by ID
Retrieve detailed information about a specific vault using its UUID.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string (UUID) | Yes | Vault UUID |
Response Fields
Returns complete vault data:
| Field | Type | Description |
|---|---|---|
id | UUID | Unique vault identifier |
name | string | Human-readable vault name |
type | enum | Vault type - HSM (currently supported) or MPC (coming soon) |
status | enum | Vault status - active or inactive |
keyStatus | enum | Key generation status - ready, pending, or failed |
keyError | string | Error message if key generation failed (nullable) |
userId | UUID | ID of user who created the vault |
organizationId | UUID | Organization ID that owns the vault |
address | string | Ethereum-compatible blockchain address (0x...) |
bsb | string | Bank State Branch code (for fiat integrations, nullable) |
accountNumber | string | Bank account number (for fiat integrations, nullable) |
groupName | string | Optional grouping label for organizing vaults (nullable) |
tags | string[] | Array of string tags for filtering |
createdAt | datetime | Creation timestamp (ISO 8601, UTC) |
updatedAt | datetime | Last modification timestamp (ISO 8601, UTC) |
assets | array | Array of asset balances associated with this vault |
user | object | Nested user object containing user id |
Use Cases
- Verify vault configuration and status before initiating transactions
- Display vault details on a dashboard or management interface
- Check key generation status after vault creation
- Retrieve vault address for receiving funds
- Validate vault ownership and permissions
Required Permission
vaults:read
Get vault by ID
Retrieve detailed information about a specific vault using its UUID.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string (UUID) | Yes | Vault UUID |
Response Fields
Returns complete vault data:
| Field | Type | Description |
|---|---|---|
id | UUID | Unique vault identifier |
name | string | Human-readable vault name |
type | enum | Vault type - HSM (currently supported) or MPC (coming soon) |
status | enum | Vault status - active or inactive |
keyStatus | enum | Key generation status - ready, pending, or failed |
keyError | string | Error message if key generation failed (nullable) |
userId | UUID | ID of user who created the vault |
organizationId | UUID | Organization ID that owns the vault |
address | string | Ethereum-compatible blockchain address (0x...) |
bsb | string | Bank State Branch code (for fiat integrations, nullable) |
accountNumber | string | Bank account number (for fiat integrations, nullable) |
groupName | string | Optional grouping label for organizing vaults (nullable) |
tags | string[] | Array of string tags for filtering |
createdAt | datetime | Creation timestamp (ISO 8601, UTC) |
updatedAt | datetime | Last modification timestamp (ISO 8601, UTC) |
assets | array | Array of asset balances associated with this vault |
user | object | Nested user object containing user id |
Use Cases
- Verify vault configuration and status before initiating transactions
- Display vault details on a dashboard or management interface
- Check key generation status after vault creation
- Retrieve vault address for receiving funds
- Validate vault ownership and permissions
Required Permission
vaults:read