Your Fireblocks workspace utilizes a hierarchy of vault accounts as part of its Object Model. This hierarchy allows you to segregate funds belonging to different business units or deposited by different users. A Vault account can hold multiple assets. To transfer to or from vault accounts, your source or destination targets must be provided with both their vault ID and asset ID. Use the Create a new vault account API call to create a new vault account that will hold your UTXO or account-based wallets.

Important:

Vault account names should consist of ASCII characters only.

Code Example

(async() => {

  const vaultAccount = await fireblocks.vaults.createVaultAccount({
    createVaultAccountRequest: {
      name: "MyVaultAccount",
      autoFuel: true,
      hiddenOnUI: false
    }
  })
  console.log(JSON.stringify(vaultAccount.data, null, 2))

})();

vault_account = fireblocks.create_vault_account(
    name="MyVaultAccount",
    hiddenOnUI=False,
    autoFuel=True
)

Response Example

{
  "id": "148",
  "name": "MyVaultAccount",
  "hiddenOnUI": false,
  "assets": [],
  "autoFuel": true
}

Create tagged vault accounts in bulk. This endpoint does not accept tags. To create many vault accounts at once with tags already attached, use the bulk creation endpoint with tagIds. See Tag vault accounts at creation.

Optional parameters

hiddenOnUI

Set to true by default, hides this vault account from appearing in the Fireblocks Console. This is the best practice when creating intermediate deposit vault accounts for your users as it helps reduce visual clutter and improves UI loading time. The best practice is configuring this setting so that only your omnibus account and another operational vault account (or multiple) are visible in the Fireblocks Console.

Hiding is a Console-only view change. A hidden vault account still exists and remains fully functional: it retains its ID, keeps all wallets and balances, is reachable through the API, and continues to emit webhook events (for example, TRANSACTION_STATUS_UPDATED and VAULT_BALANCE_UPDATE). To toggle visibility later, call Hide a vault account or Unhide a vault account, or see Manage vault accounts for the Console walkthrough.

Deleting or archiving vault accounts

Vault accounts are permanent. Fireblocks does not expose an API or Console action to delete or archive a vault account, and there is no archive equivalent to hiddenOnUI. To remove a vault account from day-to-day views, hide it from the Console; the underlying account, addresses, and history are preserved.

autoFuel

If the Gas Station service is enabled on your workspace, this flag needs to be set to true if you wish to monitor and fuel this account’s Ethereum address upon detected balance refresh events, such as when deposits of ERC20 tokens occur.

Get Started

Transactions

API Co-Signers

Webhooks

Workspace & Security

Identity & Compliance

Manage Wallets

Smart Contracts & Tokenization

Treasury & Trading

Gas Management

Payments

Embedded Wallets

Offchain Signing

Direct Custody Wallets

Integrations

Assets & NFTs

Canton

Key Link

Create Vault Accounts

Important:

Code Example

Response Example

Optional parameters

hiddenOnUI

Deleting or archiving vault accounts

autoFuel

​Important:

​Code Example

​Response Example

​Optional parameters

​hiddenOnUI

​Deleting or archiving vault accounts

​autoFuel

Important:

Code Example

Response Example

Optional parameters

hiddenOnUI

Deleting or archiving vault accounts

autoFuel