Skip to main content
POST
/
vault
/
accounts
TypeScript
const response: Promise<FireblocksResponse<VaultAccount>> = fireblocks.vaults.createVaultAccount(vaultsApiCreateVaultAccountRequest);
{
  "id": "<string>",
  "name": "<string>",
  "assets": [
    {
      "id": "<string>",
      "total": "<string>",
      "balance": "<string>",
      "available": "<string>",
      "pending": "<string>",
      "frozen": "<string>",
      "lockedAmount": "<string>",
      "staked": "<string>",
      "totalStakedCPU": "<string>",
      "totalStakedNetwork": "<string>",
      "selfStakedCPU": "<string>",
      "selfStakedNetwork": "<string>",
      "pendingRefundCPU": "<string>",
      "pendingRefundNetwork": "<string>",
      "blockHeight": "<string>",
      "blockHash": "<string>",
      "rewardsInfo": {
        "pendingRewards": "<string>"
      }
    }
  ],
  "hiddenOnUI": true,
  "customerRefId": "<string>",
  "autoFuel": true,
  "tags": [
    {
      "id": "df4c0987-30da-4976-8dcf-bc2dd41ae331",
      "label": "VIP",
      "isProtected": false,
      "updatedAt": 1717084800000,
      "description": "Tag for VIP customers",
      "color": "#FF5733",
      "pendingApprovalRequest": {
        "id": "12345",
        "type": "TAG_UPDATE",
        "state": "PENDING"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.fireblocks.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

Idempotency-Key
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Body

application/json
name
string

Account Name

hiddenOnUI
boolean

Optional - if true, the created account and all related transactions will not be shown on Fireblocks console

customerRefId
string

Optional - Sets a customer reference ID

autoFuel
boolean

Optional - Sets the autoFuel property of the vault account

vaultType
enum<string>
default:MPC

Type of vault account. The default type will be set to MPC.
If the workspace does not support the selected type, it will return an error.

Available options:
MPC,
KEY_LINK
autoAssign
boolean
default:false

Applicable only when the vault account type is KEY_LINK. For MPC, this parameter will be ignored.
If set to true and there are available keys, random keys will be assigned to the newly created vault account.
If set to true and there are no available keys to be assigned, it will return an error.
If set to false, the vault account will be created without any keys.

Response

A Vault Account object

id
string
name
string
assets
object[]
hiddenOnUI
boolean
customerRefId
string
autoFuel
boolean
tags
object[]

List of tags attached to the vault account