> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gu1.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Ativar ou desativar monitoramento por entidade e integração

> PATCH /entities/toggle-status-monitoring — extensível por código de integração — no serviço de monitoramento de entidades gu1 para screening contínuo.

```
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: **Gu1 sanções globais**).

## Autenticação

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```

## Corpo (JSON)

<ParamField body="entityId" type="string" required>
  UUID da entidade (da sua organização).
</ParamField>

<ParamField body="integrationCode" type="string" required>
  Código da integração. **Suportado hoje:** `global_gueno_sanctions_enrichment`.
</ParamField>

<ParamField body="active" type="boolean">
  * `true` — **incluir** no monitoramento quando aplicável.
  * `false` — **excluir** (equivalente ao antigo `monitoringOptOut: true`).
    É necessário enviar **pelo menos um** de `active` ou `riskMatrixId`.
</ParamField>

<ParamField body="riskMatrixId" type="string | null">
  Opcional. Apenas **sanções globais Gu1**. 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`.
</ParamField>

## Exemplo

```bash theme={null}
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.