Get whether a vault account is opted out of the address registry

Returns whether this vault account is on the workspace opt-out list (optedOut true or false). List, add, and clear-all are available on /v1/address_registry/vaults; this path reads or removes one vault.

GET /address_registry/vaults/{vaultAccountId}

TypeScript

TypeScript

const response: Promise<FireblocksResponse<AddressRegistryGetVaultOptOutResponse>> = fireblocks.compliance.getAddressRegistryVaultOptOut(complianceApiGetAddressRegistryVaultOptOutRequest);

200

{
  "optedOut": false
}

Path Parameters

vaultAccountId · integer<int32> · required

Vault account id (non-negative integer).

Required range: x >= 0

Example:

10001

Response

200

application/json

Current opt-out flag for the vault

Whether the given vault account is excluded from the address registry for your workspace.

optedOut · boolean · required

true if this vault account is excluded from the address registry; false if it is not excluded.

Example:

false