Vaults

Get the job status of the bulk deposit address creation

Returns the current status of (or an error for) the specified deposit addresss bulk creation job.

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

get/vault/accounts/addresses/bulk/{jobId}

Request

Base URL
https://api.fireblocks.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/vault/accounts/addresses/bulk/:jobId/get.ts
A function with typed inputs. Its response is checked against the schema.

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, Failed

errorMessagestring

Example response

{
  "status": "Success",
  "addresses": [
    {
      "address": "addr_test1qp07k5kdwdfx4rpfqud8ry65acxgtgfgrxw0t35cwvl4uasjneqjdc868eqlex5p2f0nyekyyk4ze5xuanvj50ysrj3qqxqhsn",
      "index": 0,
      "description": "Address one"
    }
  ],
  "errorMessage": "Asset not supported"
}

Changes

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