Skip to main content
GET
Listar Alertas

Visão Geral

Recupera alertas para entidades específicas ou em toda a organização. Os alertas são gerados automaticamente pelas regras quando as condições são atendidas.

Endpoint

Autenticação

Requer uma chave API válida no cabeçalho de Autorização:

Parâmetros de Consulta

string
required
ID da entidade para filtrar alertas (pessoa, empresa ou transação)
string
Filtrar por status: PENDING, ACKNOWLEDGED, RESOLVED
string
Filtrar por severidade: LOW, MEDIUM, HIGH, CRITICAL
string
Filtrar por categoria de alerta

Resposta

boolean
Se a requisição foi bem-sucedida
array
Array de objetos de alerta
number
Número total de alertas que correspondem aos filtros

Exemplos de Requisições

Obter Alertas para Entidade

Exemplo de Resposta

Níveis de Severidade de Alertas

  • LOW: Informativo, requer revisão
  • MEDIUM: Risco moderado, deve ser investigado
  • HIGH: Risco significativo, requer atenção imediata
  • CRITICAL: Risco severo, ação urgente necessária

Fluxo de Status de Alertas

  1. PENDING: Alerta recém-criado, aguardando revisão
  2. ACKNOWLEDGED: O alerta foi revisado pela equipe de compliance
  3. RESOLVED: O alerta foi tratado e fechado

Veja Também