Listar módulos monitoráveis

GET

/v2/monitoring/modules

Lista os módulos que podem ser monitorados, na ordem fixa do catálogo, com o produto, o preço e os campos de cada um.

Um módulo está disponível quando um produto do perfil de permissão do usuário entrega o serviço dele e tanto o produto quanto o serviço estão ativos; code e price são os desse produto e, quando mais de um produto do perfil entrega o mesmo serviço, vale o mais barato.

Por padrão, só vêm os módulos disponíveis; com includeUnavailable igual a true, vêm todos, e os indisponíveis trazem available false e o motivo em unavailableReason. fields lista os campos de cada módulo com os operadores aceitos e, nos campos de seleção, as opções: são os valores de field, operator e value nas conditions do cadastro e da edição de monitoramentos. A lista não é paginada.

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 Consulta

Parâmetros Header

Respostas

🟢200Sucesso

application/json

Módulos monitoráveis

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para ver monitoramentos

🟠403Acesso negado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/monitoring/modules?includeUnavailable=true' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Só disponíveis

{
    "items": [
        {
            "moduleKey": "RESTRICTIVE_NATIONAL",
            "code": "restritivo-nacional",
            "name": "Restritivo nacional",
            "description": "Consulta nacional de restrições",
            "price": 4,
            "defaultFrequencyDays": 30,
            "available": true,
            "unavailableReason": null,
            "fields": [
                {
                    "key": "score",
                    "label": "Score",
                    "type": "NUMBER",
                    "operators": [
                        {
                            "value": "EQUAL",
                            "label": "Igual a"
                        },
                        {
                            "value": "NOT_EQUAL",
                            "label": "Diferente de"
                        },
                        {
                            "value": "GREATER_THAN",
                            "label": "Maior que"
                        },
                        {
                            "value": "GREATER_THAN_OR_EQUAL",
                            "label": "Maior ou igual a"
                        },
                        {
                            "value": "LESS_THAN",
                            "label": "Menor que"
                        },
                        {
                            "value": "LESS_THAN_OR_EQUAL",
                            "label": "Menor ou igual a"
                        },
                        {
                            "value": "IS_EMPTY",
                            "label": "Está vazio"
                        }
                    ]
                },
                {
                    "key": "riskIndex",
                    "label": "Índice de risco",
                    "type": "SELECT",
                    "operators": [
                        {
                            "value": "EQUAL",
                            "label": "Igual a"
                        },
                        {
                            "value": "NOT_EQUAL",
                            "label": "Diferente de"
                        },
                        {
                            "value": "IS_EMPTY",
                            "label": "Está vazio"
                        }
                    ],
                    "options": [
                        {
                            "value": "BAIXO",
                            "label": "Baixo"
                        },
                        {
                            "value": "MEDIO",
                            "label": "Médio"
                        },
                        {
                            "value": "ALTO",
                            "label": "Alto"
                        }
                    ]
                },
                {
                    "key": "totalNegativationsCount",
                    "label": "Quantidade total de negativações",
                    "type": "NUMBER",
                    "operators": [
                        {
                            "value": "EQUAL",
                            "label": "Igual a"
                        },
                        {
                            "value": "NOT_EQUAL",
                            "label": "Diferente de"
                        },
                        {
                            "value": "GREATER_THAN",
                            "label": "Maior que"
                        },
                        {
                            "value": "GREATER_THAN_OR_EQUAL",
                            "label": "Maior ou igual a"
                        },
                        {
                            "value": "LESS_THAN",
                            "label": "Menor que"
                        },
                        {
                            "value": "LESS_THAN_OR_EQUAL",
                            "label": "Menor ou igual a"
                        },
                        {
                            "value": "IS_EMPTY",
                            "label": "Está vazio"
                        }
                    ]
                },
                {
                    "key": "totalNegativationsValue",
                    "label": "Valor total de negativações",
                    "type": "CURRENCY",
                    "operators": [
                        {
                            "value": "EQUAL",
                            "label": "Igual a"
                        },
                        {
                            "value": "NOT_EQUAL",
                            "label": "Diferente de"
                        },
                        {
                            "value": "GREATER_THAN",
                            "label": "Maior que"
                        },
                        {
                            "value": "GREATER_THAN_OR_EQUAL",
                            "label": "Maior ou igual a"
                        },
                        {
                            "value": "LESS_THAN",
                            "label": "Menor que"
                        },
                        {
                            "value": "LESS_THAN_OR_EQUAL",
                            "label": "Menor ou igual a"
                        },
                        {
                            "value": "IS_EMPTY",
                            "label": "Está vazio"
                        }
                    ]
                },
                {
                    "key": "defaultProbability",
                    "label": "Probabilidade de inadimplência (%)",
                    "type": "PERCENT",
                    "operators": [
                        {
                            "value": "EQUAL",
                            "label": "Igual a"
                        },
                        {
                            "value": "NOT_EQUAL",
                            "label": "Diferente de"
                        },
                        {
                            "value": "GREATER_THAN",
                            "label": "Maior que"
                        },
                        {
                            "value": "GREATER_THAN_OR_EQUAL",
                            "label": "Maior ou igual a"
                        },
                        {
                            "value": "LESS_THAN",
                            "label": "Menor que"
                        },
                        {
                            "value": "LESS_THAN_OR_EQUAL",
                            "label": "Menor ou igual a"
                        },
                        {
                            "value": "IS_EMPTY",
                            "label": "Está vazio"
                        }
                    ]
                }
            ]
        },
        {
            "moduleKey": "PROTESTS",
            "code": "protestos",
            "name": "Protestos",
            "description": "Cartório de protestos",
            "price": 3,
            "defaultFrequencyDays": 30,
            "available": true,
            "unavailableReason": null,
            "fields": [
                {
                    "key": "totalValue",
                    "label": "Valor total",
                    "type": "CURRENCY",
                    "operators": [
                        {
                            "value": "EQUAL",
                            "label": "Igual a"
                        },
                        {
                            "value": "NOT_EQUAL",
                            "label": "Diferente de"
                        },
                        {
                            "value": "GREATER_THAN",
                            "label": "Maior que"
                        },
                        {
                            "value": "GREATER_THAN_OR_EQUAL",
                            "label": "Maior ou igual a"
                        },
                        {
                            "value": "LESS_THAN",
                            "label": "Menor que"
                        },
                        {
                            "value": "LESS_THAN_OR_EQUAL",
                            "label": "Menor ou igual a"
                        },
                        {
                            "value": "IS_EMPTY",
                            "label": "Está vazio"
                        }
                    ]
                },
                {
                    "key": "totalCities",
                    "label": "Total de cidades",
                    "type": "NUMBER",
                    "operators": [
                        {
                            "value": "EQUAL",
                            "label": "Igual a"
                        },
                        {
                            "value": "NOT_EQUAL",
                            "label": "Diferente de"
                        },
                        {
                            "value": "GREATER_THAN",
                            "label": "Maior que"
                        },
                        {
                            "value": "GREATER_THAN_OR_EQUAL",
                            "label": "Maior ou igual a"
                        },
                        {
                            "value": "LESS_THAN",
                            "label": "Menor que"
                        },
                        {
                            "value": "LESS_THAN_OR_EQUAL",
                            "label": "Menor ou igual a"
                        },
                        {
                            "value": "IS_EMPTY",
                            "label": "Está vazio"
                        }
                    ]
                },
                {
                    "key": "totalProtests",
                    "label": "Total de protestos",
                    "type": "NUMBER",
                    "operators": [
                        {
                            "value": "EQUAL",
                            "label": "Igual a"
                        },
                        {
                            "value": "NOT_EQUAL",
                            "label": "Diferente de"
                        },
                        {
                            "value": "GREATER_THAN",
                            "label": "Maior que"
                        },
                        {
                            "value": "GREATER_THAN_OR_EQUAL",
                            "label": "Maior ou igual a"
                        },
                        {
                            "value": "LESS_THAN",
                            "label": "Menor que"
                        },
                        {
                            "value": "LESS_THAN_OR_EQUAL",
                            "label": "Menor ou igual a"
                        },
                        {
                            "value": "IS_EMPTY",
                            "label": "Está vazio"
                        }
                    ]
                },
                {
                    "key": "individualProtestValue",
                    "label": "Valor do protesto (individual)",
                    "type": "CURRENCY",
                    "operators": [
                        {
                            "value": "EQUAL",
                            "label": "Igual a"
                        },
                        {
                            "value": "NOT_EQUAL",
                            "label": "Diferente de"
                        },
                        {
                            "value": "GREATER_THAN",
                            "label": "Maior que"
                        },
                        {
                            "value": "GREATER_THAN_OR_EQUAL",
                            "label": "Maior ou igual a"
                        },
                        {
                            "value": "LESS_THAN",
                            "label": "Menor que"
                        },
                        {
                            "value": "LESS_THAN_OR_EQUAL",
                            "label": "Menor ou igual a"
                        },
                        {
                            "value": "IS_EMPTY",
                            "label": "Está vazio"
                        }
                    ]
                }
            ]
        }
    ]
}

Modificado em 2026-10-21 13:19:47

Página anterior

Cadastrar monitoramento

Próxima página

Pesquisar clientes para monitoramento