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

GET

address_registry

vaults

{vaultAccountId}

TypeScript

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

{
  "optedOut": false
}

Path Parameters

vaultAccountId

integer<int32>

required

Vault account id (non-negative integer).

Required range: x >= 0

Example:

10001

Response

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

Remove a single vault account from the address registry opt-out listRemoves this vault account id from the workspace opt-out list if it is present; otherwise the call still succeeds. Response body matches GET (`optedOut` is `false` after success). To clear the whole list, use `DELETE /v1/address_registry/vaults`.

⌘I

TypeScript

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

{
  "optedOut": false
}