Skip to main content
GET
/
entities
/
{id}
/
country-activations
Listar ativações de país por entidade
curl --request GET \
  --url http://api.gu1.ai/entities/{id}/country-activations \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data.entityId": "<string>",
  "data.countries": [
    {}
  ]
}

​
Overview

Retorna o estado operacional de ativação por país para uma entidade merchant. É apenas um flag operacional — não altera dados da entidade, enrichments ou status de compliance. Integradores normalmente reconsultam a entidade completa após receber o webhook entity.country_activation_changed. Países suportados (v1): AR, BR, CL, CO, MX, US. Se não existir linha para um país, a API retorna deactivated (modelo opt-in).

​
Endpoint

GET http://api.gu1.ai/entities/{id}/country-activations

​
Autenticação

Requer entities:read (fallback legacy: papel viewer / entities:read). 
Authorization: Bearer YOUR_API_KEY

​
Path Parameters

​
id
string
required
UUID da entidade (merchant).

​
Resposta

​
success
boolean
Indica se a solicitação foi bem-sucedida.
​
data.entityId
string
UUID da entidade.
​
data.countries
array
Lista fixa de seis países com metadata de ativação.
Cada item em data.countries:
CampoTipoDescrição
countryCodestringISO 3166-1 alpha-2 (AR, BR, CL, CO, MX, US)
statusstringdeactivated, activation_requested, activation_in_progress ou activated
activatedAtstring | nullTimestamp ISO da última vez em activated
deactivatedAtstring | nullTimestamp ISO da última vez em deactivated
updatedAtstring | nullTimestamp ISO da última alteração (null se nunca definido)

​
Exemplo

curl -X GET "https://api.gu1.ai/entities/550e8400-e29b-41d4-a716-446655440000/country-activations" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "data": {
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "countries": [
      {
        "countryCode": "AR",
        "status": "deactivated",
        "activatedAt": null,
        "deactivatedAt": null,
        "updatedAt": null
      },
      {
        "countryCode": "CO",
        "status": "activation_in_progress",
        "activatedAt": null,
        "deactivatedAt": null,
        "updatedAt": "2026-07-03T15:00:00.000Z"
      },
      {
        "countryCode": "MX",
        "status": "activated",
        "activatedAt": "2026-07-03T15:00:00.000Z",
        "deactivatedAt": null,
        "updatedAt": "2026-07-03T15:00:00.000Z"
      }
    ]
  }
}

​
Erros

HTTPCodeQuando
404ENTITY_NOT_FOUNDA entidade não existe na organização atual