Alertas

Endpoints para gerenciamento de alertas de risco.

GET /alerts

Lista paginada de alertas.

Request:

GET /api/v1/alerts
Authorization: Bearer <token>

Query Parameters:

• page (int, padrão: 1) - Número da página
• size (int, padrão: 20) - Elementos por página
• status (string) - Filtrar por status (open, under_investigation, resolved, dismissed)
• severity (string) - Filtrar por severidade (low, medium, high, critical)

Exemplo:

curl "https://api.gbfiscalai.srv1164291.hstgr.cloud/api/v1/alerts?status=open" \
  -H "Authorization: Bearer <token>"

Resposta:

{
  "items": [
    {
      "id": 1,
      "title": "Subavaliação detectada",
      "description": "Valor declarado inferior ao preço de referência",
      "alert_type": "anomaly",
      "severity": "critical",
      "status": "open",
      "declaration_id": 42,
      "created_at": "2026-01-12T10:00:00Z"
    }
  ],
  "total": 25,
  "page": 1,
  "size": 20,
  "pages": 2
}

GET /alerts/id

Detalhes de um alerta específico.

Request:

GET /api/v1/alerts/1
Authorization: Bearer <token>

Resposta:

{
  "id": 1,
  "title": "Subavaliação detectada",
  "severity": "critical",
  "status": "open",
  "declaration": {
    "id": 42,
    "reference": "DEC-2026-00042"
  },
  "created_at": "2026-01-12T10:00:00Z"
}

PATCH /alerts/id

Atualiza o status de um alerta.

Request:

PATCH /api/v1/alerts/1
Authorization: Bearer <token>
Content-Type: application/json

Body:

{
  "status": "resolved",
  "resolution_notes": "Verificação realizada"
}

Resposta:

{
  "id": 1,
  "status": "resolved",
  "resolved_at": "2026-01-12T15:00:00Z"
}

Tipos de Alertas

• anomaly - Anomalia de valor detectada
• document - Documento faltando ou suspeito
• pattern - Padrão comportamental suspeito
• fraud - Possível fraude

Esquema Alert

interface Alert {
  id: number
  title: string
  description: string
  alert_type: string
  severity: string
  status: string
  declaration_id: number
  created_at: string
  updated_at: string
}