Listar alertas de um cliente do monitoramento

GET

/v2/monitoring/{monitoringId}/clients/{clientId}

Lista os alertas de risco vigentes de um cliente no monitoramento informado em monitoringId, agrupados por módulo.

Os alertas limpos não aparecem; os lidos e os não lidos aparecem, do mais recente para o mais antigo. Cada alerta traz o campo que mudou, o valor anterior e o atual, crus e formatados para exibição, e a regra que o disparou. Só entram módulos ligados.

Entre eles, aparecem os que têm alerta para o cliente e os indisponíveis no perfil de permissão de quem criou o monitoramento, para avisar que não estão sendo consultados. Módulos disponíveis sem alerta ficam de fora. Listar não marca os alertas como lidos; para isso, use a rota de marcar alertas de um cliente como lidos.

Qualquer usuário da empresa pode consultar. Monitoramento inexistente ou de outra empresa devolve 404 (Monitoria não encontrada.). Cliente que não está no monitoramento, que foi excluído da base de clientes ou que não é pessoa física nem jurídica devolve 404 (Cliente não monitorado nesta monitoria.).

Requer autenticação via Bearer JWT ou header x-api-key e a permissão de ver monitoramentos. Usuário sem perfil de permissão recebe 403 (Acesso negado); perfil inexistente, 401 (Permissão inválida!); perfil sem a permissão, 400 (Permissão não encontrada); usuário inativo, 404 (Usuário não encontrado).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200Sucesso

application/json

Alertas do cliente por módulo

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para ver monitoramentos

🟠403Acesso negado

🟠404Monitoramento ou cliente não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/monitoring/9c1e4b7a-0000-4000-8000-000000000d01/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Cliente com alertas

{
    "client": {
        "_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "name": "Empresa Exemplo Ltda",
        "taxId": "11222333000181",
        "kind": "legal",
        "lastRunAt": "2026-10-15T09:00:00.000Z"
    },
    "modules": [
        {
            "moduleKey": "PROTESTS",
            "moduleName": "Protestos",
            "available": true,
            "unavailableReason": null,
            "alerts": [
                {
                    "_id": "6d2f8a10-0000-4000-8000-0000000000f1",
                    "kind": "RISK",
                    "status": "UNREAD",
                    "field": "totalProtests",
                    "fieldLabel": "Total de protestos",
                    "fieldType": "NUMBER",
                    "previousValue": 0,
                    "previousLabel": "0 protestos",
                    "currentValue": 2,
                    "currentLabel": "2 protestos",
                    "criterionSummary": "Alerta quando \"Total de protestos\" for \"Maior que\" \"0\"",
                    "triggeredAt": "2026-10-15T09:12:44.000Z"
                },
                {
                    "_id": "6d2f8a10-0000-4000-8000-0000000000f2",
                    "kind": "RISK",
                    "status": "READ",
                    "field": "totalValue",
                    "fieldLabel": "Valor total",
                    "fieldType": "CURRENCY",
                    "previousValue": 0,
                    "previousLabel": "R$ 0,00",
                    "currentValue": 62500,
                    "currentLabel": "R$ 62.500,00",
                    "criterionSummary": "Alerta quando \"Valor total\" for \"Maior ou igual a\" \"50000\"",
                    "triggeredAt": "2026-10-15T09:12:44.000Z"
                }
            ]
        },
        {
            "moduleKey": "JUDICIAL",
            "moduleName": "Judicial",
            "available": false,
            "unavailableReason": "SERVICE_UNAVAILABLE",
            "alerts": []
        }
    ],
    "isOwner": true
}

Modificado em 2026-10-21 13:22:56

Página anterior

Remover cliente de um monitoramento

Próxima página

Marcar alertas de um cliente como lidos