Vaults

Get job status of bulk creation of new vault accounts

Returns the current status of (or error for) the specified vault account bulk creation job.

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

get/vault/accounts/bulk/{jobId}

Request

Path parameters

jobIdstring required

The ID of the job to create addresses

Response

A Job with status

statusstring required

Status of the job. Possible values - Success, In Progress, Error, Pending Approval, Canceled

vaultAccountsobject

Mapping between VaultAccountId to a mapping of asset to address, and the vault account name

tagIdsstring[]

List of tag IDs successfully attached to each of the created vault accounts

errorMessagestring
approvalRequestIdstring

Approval request ID if the job has protected tags to attach to the vault accounts

Example response

{
  "status": "Success",
  "vaultAccounts": {
    "0": {
      "BTC_TEST": "bcrt1qs0zzqytuw49w2jqkmfhzgdh2lylzde2uw4zncz",
      "ETH_TEST": "0x460395Edb2338023c6f137259C6e20B6C37dDE95",
      "name": "My Vault Account"
    }
  },
  "tagIds": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  ],
  "errorMessage": "Asset not supported",
  "approvalRequestId": "12345"
}

Changes

No recorded changes to this operation across all 1 revision of this API.