Add vault accounts to the address registry opt-out list

POST

address_registry

vaults

TypeScript

const response: Promise<FireblocksResponse<AddressRegistryAddVaultOptOutsResponse>> = fireblocks.compliance.addAddressRegistryVaultOptOuts(complianceApiAddAddressRegistryVaultOptOutsRequest);

{
  "acceptedCount": 3
}

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

vaultAccountIds

(integer<int32> | string)[]

required

Vault account ids to add to the opt-out list (non-empty). Each element may be a JSON number or a decimal string; both forms are accepted.

Minimum array length: 1

Example:

10001

Example:

[10001, "10002"]

Response

Opt-outs recorded; response body includes acceptedCount.

Result of adding vault account ids to the workspace opt-out list for the address registry.

acceptedCount

integer<int32>

required

Number of vault ids from the request that were processed. An empty vaultAccountIds list is rejected with HTTP 400, not a 200 with zero.

Example:

3

Remove all vault-level address registry opt-outs for the workspaceRemoves all vault accounts from the workspace opt-out list.

⌘I

TypeScript

const response: Promise<FireblocksResponse<AddressRegistryAddVaultOptOutsResponse>> = fireblocks.compliance.addAddressRegistryVaultOptOuts(complianceApiAddAddressRegistryVaultOptOutsRequest);

{
  "acceptedCount": 3
}