Listar Alertas
Referência API
Listar Alertas
Obter alertas para entidades ou organizações com filtragem e paginação — usando a API de alertas da gu1 para fluxos de risco e compliance.
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
ID da entidade para filtrar alertas (pessoa, empresa ou transação)
Filtrar por status:
PENDING, ACKNOWLEDGED, RESOLVEDFiltrar por severidade:
LOW, MEDIUM, HIGH, CRITICALFiltrar por categoria de alerta
Resposta
Se a requisição foi bem-sucedida
Array de objetos de alerta
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
- PENDING: Alerta recém-criado, aguardando revisão
- ACKNOWLEDGED: O alerta foi revisado pela equipe de compliance
- RESOLVED: O alerta foi tratado e fechado