Compliance

Get address registry status for this workspace

Check whether this workspace uses the address registry. The response is OPTED_IN or OPTED_OUT. If this workspace has not been configured yet, it follows your customer's default (see GET /v1/address_registry/customer) when that default is OPTED_IN or OPTED_OUT; otherwise the workspace is opted in by default.

get/address_registry/tenant

Request

Response

Participation status in the response body

status'OPTED_IN' | 'OPTED_OUT' required

OPTED_IN or OPTED_OUT. On GET, uses the customer default when this workspace has no setting of its own and the customer has made an explicit choice; is OPTED_IN when neither is set. On POST or DELETE, reflects the choice you just made for this workspace.

Example response

{
  "status": "OPTED_IN"
}

Changes

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