Skip to main content
PATCH
/
entities
/
toggle-status-monitoring
Ativar ou desativar monitoramento por entidade e integração
curl --request PATCH \
  --url http://api.gu1.ai/entities/toggle-status-monitoring \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityId": "<string>",
  "integrationCode": "<string>",
  "active": true,
  "riskMatrixId": {}
}
'
PATCH http://api.gu1.ai/entities/toggle-status-monitoring
Endpoint genérico para definir se a entidade participa do monitoramento contínuo para um integrationCode (hoje: Güeno sanções globais).

Autenticação

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Corpo (JSON)

entityId
string
required
UUID da entidade (da sua organização).
integrationCode
string
required
Código da integração. Suportado hoje: global_gueno_sanctions_enrichment.
active
boolean
  • trueincluir no monitoramento quando aplicável.
  • falseexcluir (equivalente ao antigo monitoringOptOut: true). É necessário enviar pelo menos um de active ou riskMatrixId.
riskMatrixId
string | null
Opcional. Apenas sanções globais Güeno. UUID de uma matriz de risco da org, ou null para remover o override por assinatura (o screening diário volta a usar a matriz global da entidade). Com UUID definido, somente essa matriz é usada na corrida de regras disparada pelo monitoramento; não se mistura com a matriz da entidade. Não altera entities.riskMatrixId.

Exemplo

curl -sS -X PATCH "http://api.gu1.ai/entities/toggle-status-monitoring" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "integrationCode": "global_gueno_sanctions_enrichment",
    "active": false
  }'

Rota deprecada

PATCH /entities/{id}/gueno-sanctions-monitoring-opt-out permanece por compatibilidade.