Skip to main content
GET
List entity country activations

Overview

Returns the operational country activation state for a merchant entity. This is an operational flag only β€” it does not change entity data, enrichments, or compliance status. Integrators typically re-fetch the full entity after receiving the entity.country_activation_changed webhook. Supported countries (v1): AR, BR, CL, CO, MX, US. When no row exists for a country, the API returns deactivated (opt-in model).

Endpoint

Authentication

Requires entities:read (legacy fallback: entities:read / viewer role).

Path Parameters

string
required
UUID of the entity (merchant).

Response

boolean
Whether the request succeeded.
string
Entity UUID.
array
Fixed list of six countries with activation metadata.
Each item in data.countries:

Example

Errors