Solicitar consulta de Score AgRisk de clientes

POST

/v2/check-score/

Registra uma consulta avulsa de Score AgRisk para cada cliente informado em clients. Para cada cliente, a rota cria a consulta e debita da empresa o valor do produto de consulta de Score AgRisk; em seguida, busca o score mais recente já calculado para o CPF ou CNPJ do cliente e grava esse score como o score atual do cliente na plataforma. A resposta não traz o score: ele passa a aparecer nos dados do cliente (por exemplo, no relatório, em basic_data.detailScore, com a mensagem "Solicite uma consulta completa para um score mais atualizado."). Quando não existe score calculado para o CPF ou CNPJ, a consulta é marcada como falha, o valor é estornado e o cliente passa a mostrar "Score AgRisk não disponível."; a resposta continua 201. Os clientes são processados um de cada vez, na ordem enviada: se a cobrança de um cliente for recusada (por exemplo, créditos insuficientes), a resposta traz o erro, mas os clientes anteriores da lista já foram consultados e cobrados. IDs repetidos geram consultas e cobranças repetidas. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Consultas registradas

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Créditos insuficientes

🟠404Cliente não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/check-score/' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "clients": [
        "4005e4a6-08b5-4dea-b4f9-35a6630154ad",
        "7c1e2f3a-9b8d-4c5e-a6f7-0123456789ab"
    ]
}'

Response Example

201 - Sucesso

{
    "message": "Consulta registrada com sucesso."
}

Modificado em 2026-10-13 09:47:06

Página anterior

Consultar as permissões do usuário autenticado

Próxima página

Gerar URL assinada de download de arquivo de cessão