Listar Alertas
Referencia API
Listar Alertas
Obtener alertas para entidades u organizaciones con filtrado y paginación — usando la API de alertas de gu1 para flujos de riesgo y compliance.
GET
Listar Alertas
Descripción General
Recupera alertas para entidades específicas o en toda la organización. Las alertas se generan automáticamente por las reglas cuando se cumplen las condiciones.Endpoint
Autenticación
Requiere una clave API válida en el encabezado de Autorización:Parámetros de Consulta
string
required
ID de entidad para filtrar alertas (persona, empresa o transacción)
string
Filtrar por estado:
PENDING, ACKNOWLEDGED, RESOLVEDstring
Filtrar por severidad:
LOW, MEDIUM, HIGH, CRITICALstring
Filtrar por categoría de alerta
Respuesta
boolean
Si la solicitud fue exitosa
array
Array de objetos de alerta
number
Número total de alertas que coinciden con los filtros
Ejemplos de Solicitudes
Obtener Alertas para Entidad
Filtrar por Severidad y Estado
Ejemplo de Respuesta
Niveles de Severidad de Alertas
- LOW: Informativo, requiere revisión
- MEDIUM: Riesgo moderado, debe ser investigado
- HIGH: Riesgo significativo, requiere atención inmediata
- CRITICAL: Riesgo severo, acción urgente requerida
Flujo de Estado de Alertas
- PENDING: Alerta recién creada, esperando revisión
- ACKNOWLEDGED: La alerta ha sido revisada por el equipo de cumplimiento
- RESOLVED: La alerta ha sido abordada y cerrada