Compliance

Opt your customer in to the address registry

Set your customer's default to opted in. Workspaces without their own setting will follow this default. No request body. Returns OPTED_IN. If the customer for this workspace cannot be determined, returns HTTP 404 with error code 2147.

post/address_registry/customer

Request

Base URL
https://api.fireblocks.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/address_registry/customer/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Idempotency-Keystring

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.

Response

Success; response body includes status OPTED_IN

status'NOT_SET' | 'OPTED_IN' | 'OPTED_OUT' required

NOT_SET, OPTED_IN, or OPTED_OUT. On GET, NOT_SET means no default has been chosen yet. On POST or DELETE, returns OPTED_IN or OPTED_OUT after a successful change.

Example response

{
  "status": "NOT_SET"
}

Changes

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