Visualizar Quod de um cliente

GET

/queries/clients/{clientId}/quod/{queryId}

Devolve o resultado do Quod do cliente informado em clientId, na consulta informada em queryId (o identificador da consulta, listado por serviço na rota de consultas do cliente). O formato depende do tipo do cliente: para pessoa física, a resposta traz score, loans, appointments, indicators e negative; para pessoa jurídica, score, negative, indicators e register. Quando a consulta tem erro gravado, a resposta é 200 com error (title e message) no lugar dos dados; title é "Informação restrita" para cliente PEP ou VIP e "Ocorreu um erro" nos demais casos. Quando não há resultado para o queryId, a resposta é 200 com um objeto vazio. Requer autenticação via Bearer JWT ou header x-api-key. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 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

🟢200

application/json

Resultado do Quod do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/queries/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/quod/3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso (pessoa física)

{
    "score": {
        "rating": 720,
        "credit_risk": {
            "rank": "B",
            "description": "Risco baixo"
        },
        "payment_probability": {
            "perc": 91.2,
            "description": "Alta probabilidade de pagamento"
        }
    },
    "loans": {
        "amount": 12000,
        "due_amount": 3000,
        "unpaid_due_amount_period": {
            "under_15_days": 500,
            "from_16_to_30_days": 0,
            "from_31_to_60_days": 0,
            "from_61_to_90_days": 0,
            "over_91_days": 0
        }
    },
    "appointments": [
        {
            "_id": "f6a7b8c9-d0e1-4f23-a405-b6c7d8e9f012",
            "company_name": "CREDOR EXEMPLO",
            "amount": 1500.5,
            "inclusion_date": "2026-03-10",
            "details": {
                "tax_id": "11222333000181",
                "participant_type": "DEVEDOR",
                "nature": "CREDIARIO",
                "contract_number": "123456",
                "address": "RUA EXEMPLO, 100",
                "status": "EM ABERTO",
                "occurrence_date": "2026-02-01",
                "modification_date": "2026-03-10"
            }
        }
    ],
    "indicators": {
        "punctuality": {
            "perc": 80,
            "rank": "Alta",
            "description": "O consumidor apresenta ou apresentou alguns atrasos de pagamentos ou pendências financeiras na média dos últimos 12 meses"
        },
        "payment_capacity": {
            "perc": 70,
            "rank": "Alta",
            "description": "O consumidor apresenta o comportamento esperado ou possui pequenas divergências na utilização de produtos financeiros"
        }
    },
    "negative": {
        "last_date_appointment": "2026-03-10",
        "dependencies_control_cred_amount": 1,
        "dependencies_control_cred_qty": 1
    }
}

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

Página anterior

Visualizar protestos de um cliente

Próxima página

Listar pessoas do grupo familiar de um cliente