Bulk creation of new vault accounts

Create multiple vault accounts by running an async job.

The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported.
These endpoints are currently in beta and might be subject to changes.
Limited to a maximum of 10,000 accounts per operation.
With vaultType: KEY_LINK, creates Key Link vault accounts; set autoAssign: true to bind them to the workspace’s signing keys (see vaultType and autoAssign).

Endpoint Permissions: Admin, Non-Signing Admin, Signer, Approver, Editor.

POST

vault

accounts

bulk

TypeScript

const response: Promise<FireblocksResponse<JobCreated>> = fireblocks.vaults.createMultipleAccounts(vaultsApiCreateMultipleAccountsRequest);

curl --request POST \
  --url https://api.fireblocks.io/v1/vault/accounts/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "count": 1000,
  "baseAssetIds": [
    "BTC",
    "ETH",
    "SOL"
  ],
  "names": [
    "first va",
    "client 65502e71-ecdf-48da-a074-c1753befc7fb"
  ],
  "vaultAccountNamesStartingIndex": 0,
  "prefix": "Copied from: ",
  "tagIds": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  ],
  "vaultType": "KEY_LINK",
  "autoAssign": true
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    count: 1000,
    baseAssetIds: ['BTC', 'ETH', 'SOL'],
    names: ['first va', 'client 65502e71-ecdf-48da-a074-c1753befc7fb'],
    vaultAccountNamesStartingIndex: 0,
    prefix: 'Copied from: ',
    tagIds: ['a1b2c3d4-e5f6-7890-abcd-ef1234567890', 'b2c3d4e5-f6a7-8901-bcde-f12345678901'],
    vaultType: 'KEY_LINK',
    autoAssign: true
  })
};

fetch('https://api.fireblocks.io/v1/vault/accounts/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/vault/accounts/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'count' => 1000,
    'baseAssetIds' => [
        'BTC',
        'ETH',
        'SOL'
    ],
    'names' => [
        'first va',
        'client 65502e71-ecdf-48da-a074-c1753befc7fb'
    ],
    'vaultAccountNamesStartingIndex' => 0,
    'prefix' => 'Copied from: ',
    'tagIds' => [
        'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
        'b2c3d4e5-f6a7-8901-bcde-f12345678901'
    ],
    'vaultType' => 'KEY_LINK',
    'autoAssign' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/vault/accounts/bulk"

	payload := strings.NewReader("{\n  \"count\": 1000,\n  \"baseAssetIds\": [\n    \"BTC\",\n    \"ETH\",\n    \"SOL\"\n  ],\n  \"names\": [\n    \"first va\",\n    \"client 65502e71-ecdf-48da-a074-c1753befc7fb\"\n  ],\n  \"vaultAccountNamesStartingIndex\": 0,\n  \"prefix\": \"Copied from: \",\n  \"tagIds\": [\n    \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n    \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n  ],\n  \"vaultType\": \"KEY_LINK\",\n  \"autoAssign\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/vault/accounts/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"count\": 1000,\n  \"baseAssetIds\": [\n    \"BTC\",\n    \"ETH\",\n    \"SOL\"\n  ],\n  \"names\": [\n    \"first va\",\n    \"client 65502e71-ecdf-48da-a074-c1753befc7fb\"\n  ],\n  \"vaultAccountNamesStartingIndex\": 0,\n  \"prefix\": \"Copied from: \",\n  \"tagIds\": [\n    \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n    \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n  ],\n  \"vaultType\": \"KEY_LINK\",\n  \"autoAssign\": true\n}"

response = http.request(request)
puts response.read_body

{
  "jobId": "<string>",
  "approvalRequestId": "<string>"
}

{
  "message": "<string>",
  "code": 123
}

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

count

integer

required

Count

Example:

1000

baseAssetIds

string[]

required

Array of base asset IDs

Example:

["BTC", "ETH", "SOL"]

names

string[]

Names to assign to vault accounts. if vaultAccountNamesStartingIndex or prefix is used it'll fail

Example:

[
  "first va",
  "client 65502e71-ecdf-48da-a074-c1753befc7fb"
]

vaultAccountNamesStartingIndex

integer

Copy vault accounts names starting from this index. If names array is used it'll fail

Example:

0

prefix

string

When copying from existing vault accounts (vaultAccountNamesStartingIndex) then adding a prefix to the names. If names array is used it'll fail

Example:

"Copied from: "

tagIds

string<uuid>[]

Optional list of tag IDs to attach to all created vault accounts

Maximum array length: 20

Example:

[
  "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "b2c3d4e5-f6a7-8901-bcde-f12345678901"
]

vaultType

enum<string>

default:MPC

Type of vault accounts to create. The default type is MPC. KEY_LINK creates Key Link vault accounts. It requires a Key Link workspace. With autoAssign set to true, the vault accounts are bound to the workspace's Key Link signing keys, assigned automatically from the available keys, and only one KEY_LINK bulk creation with autoAssign set to true can run per workspace at a time. With autoAssign set to false (the default), the vault accounts are created without keys. With KEY_LINK, names, vaultAccountNamesStartingIndex, prefix and tagIds work as they do for MPC, and baseAssetIds may be empty to create vault accounts without wallets.

Available options:

MPC,

KEY_LINK

Example:

"KEY_LINK"

autoAssign

boolean

default:false

Applicable only when vaultType is KEY_LINK. For MPC, this parameter is ignored. If set to true, keys are assigned to every created vault account. If there are not enough available keys to assign, the request returns an error and no vault accounts are created. If set to false, the vault accounts are created without any keys, and baseAssetIds must be empty because wallets can only be created for vault accounts that have keys.

Example:

true

Response

A JobCreated object

jobId

string

approvalRequestId

string

Approval request ID. Returned when a tag triggers an approval flow.

⌘I

TypeScript

const response: Promise<FireblocksResponse<JobCreated>> = fireblocks.vaults.createMultipleAccounts(vaultsApiCreateMultipleAccountsRequest);

curl --request POST \
  --url https://api.fireblocks.io/v1/vault/accounts/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "count": 1000,
  "baseAssetIds": [
    "BTC",
    "ETH",
    "SOL"
  ],
  "names": [
    "first va",
    "client 65502e71-ecdf-48da-a074-c1753befc7fb"
  ],
  "vaultAccountNamesStartingIndex": 0,
  "prefix": "Copied from: ",
  "tagIds": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  ],
  "vaultType": "KEY_LINK",
  "autoAssign": true
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    count: 1000,
    baseAssetIds: ['BTC', 'ETH', 'SOL'],
    names: ['first va', 'client 65502e71-ecdf-48da-a074-c1753befc7fb'],
    vaultAccountNamesStartingIndex: 0,
    prefix: 'Copied from: ',
    tagIds: ['a1b2c3d4-e5f6-7890-abcd-ef1234567890', 'b2c3d4e5-f6a7-8901-bcde-f12345678901'],
    vaultType: 'KEY_LINK',
    autoAssign: true
  })
};

fetch('https://api.fireblocks.io/v1/vault/accounts/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/vault/accounts/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'count' => 1000,
    'baseAssetIds' => [
        'BTC',
        'ETH',
        'SOL'
    ],
    'names' => [
        'first va',
        'client 65502e71-ecdf-48da-a074-c1753befc7fb'
    ],
    'vaultAccountNamesStartingIndex' => 0,
    'prefix' => 'Copied from: ',
    'tagIds' => [
        'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
        'b2c3d4e5-f6a7-8901-bcde-f12345678901'
    ],
    'vaultType' => 'KEY_LINK',
    'autoAssign' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/vault/accounts/bulk"

	payload := strings.NewReader("{\n  \"count\": 1000,\n  \"baseAssetIds\": [\n    \"BTC\",\n    \"ETH\",\n    \"SOL\"\n  ],\n  \"names\": [\n    \"first va\",\n    \"client 65502e71-ecdf-48da-a074-c1753befc7fb\"\n  ],\n  \"vaultAccountNamesStartingIndex\": 0,\n  \"prefix\": \"Copied from: \",\n  \"tagIds\": [\n    \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n    \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n  ],\n  \"vaultType\": \"KEY_LINK\",\n  \"autoAssign\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/vault/accounts/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"count\": 1000,\n  \"baseAssetIds\": [\n    \"BTC\",\n    \"ETH\",\n    \"SOL\"\n  ],\n  \"names\": [\n    \"first va\",\n    \"client 65502e71-ecdf-48da-a074-c1753befc7fb\"\n  ],\n  \"vaultAccountNamesStartingIndex\": 0,\n  \"prefix\": \"Copied from: \",\n  \"tagIds\": [\n    \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n    \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n  ],\n  \"vaultType\": \"KEY_LINK\",\n  \"autoAssign\": true\n}"

response = http.request(request)
puts response.read_body

{
  "jobId": "<string>",
  "approvalRequestId": "<string>"
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Bulk creation of new vault accounts

Headers

Body

Response