Visualizar restritivos de crédito de um cliente

GET

/queries/clients/{clientId}/credit-restrictive/{queryId}

Devolve o resultado dos restritivos de crédito do cliente informado em clientId, na consulta informada em queryId (o identificador da consulta, listado por serviço na rota de consultas do cliente). A resposta traz score, score_exception, rating, riskIndex, probability_default, payment_punctuality e judicial_recovery; summary, com a data do último lançamento e a quantidade e o valor das dependências de controle de crédito; appointments, os lançamentos, do mais recente para o mais antigo, com type PEFIN, REFIN ou INDEFINIDO; bad_checks, os cheques sem fundos; national_protests, os protestos nacionais, no máximo 5, os mais recentes; administrators; corporate_board (quadro societário) e partner_participation (participações societárias), cada pessoa com negativation, a última negativação consultada para o CPF ou CNPJ dela a partir deste cliente. Quando não há resultado para o cliente na consulta informada, a resposta é 200 com a mesma estrutura vazia: score null, fifth_service falso, summary zerada e as listas vazias; a rota não devolve 404. 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

Restritivos de crédito do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Sucesso

{
    "_id": "b8c9d0e1-f203-4b45-a617-d8e9f0a1b234",
    "fifth_service": false,
    "score": 612,
    "score_exception": null,
    "riskIndex": "B",
    "probability_default": 4.2,
    "rating": "B",
    "past_queries": [
        {
            "date": "2026-08-20",
            "informer": "BANCO EXEMPLO",
            "quantity": 2
        }
    ],
    "judicial_recovery": false,
    "payment_punctuality": 87,
    "summary": {
        "last_date_appointment": "2026-03-10T00:00:00.000Z",
        "dependencies_control_cred_qty": 1,
        "dependencies_control_cred_amount": 1500.5
    },
    "appointments": [
        {
            "_id": "c9d0e1f2-0314-4c56-b728-e9f0a1b2c345",
            "amount": 1500.5,
            "company_name": "CREDOR EXEMPLO",
            "inclusion_date": "2026-03-10T00:00:00.000Z",
            "details": {
                "contract_number": "123456",
                "modality": "CREDIARIO",
                "guarantor": "NAO",
                "classification": "VENCIDO",
                "type": "PEFIN"
            }
        }
    ],
    "bad_checks": [
        {
            "_id": "d0e1f203-1425-4d67-b839-f0a1b2c3d456",
            "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "queryId": "3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13",
            "last_check_date": "2026-01-15T00:00:00.000Z",
            "date_occurrence": "2026-01-15T00:00:00.000Z",
            "bank": "001",
            "bank_name": "BANCO EXEMPLO",
            "agency": "1234",
            "CCF_qty": 1,
            "reason": "12",
            "amount": 950
        }
    ],
    "national_protests": [
        {
            "_id": "e1f20314-2536-4e78-a94a-a1b2c3d4e567",
            "city": "SORRISO",
            "contract": "123456",
            "date_occurrence": "2026-02-10T00:00:00.000Z",
            "notary_office": "1º TABELIONATO EXEMPLO",
            "uf": "MT",
            "value": 2500
        }
    ],
    "administrators": [
        {
            "_id": "f2031425-3647-4f89-ba5b-b2c3d4e5f678",
            "name": "ADMINISTRADOR EXEMPLO",
            "restriction": false,
            "role": "DIRETOR",
            "tax_id": "11144477735"
        }
    ],
    "corporate_board": [
        {
            "_id": "03142536-4758-4a9a-8b6c-c3d4e5f6a789",
            "name": "SOCIO EXEMPLO",
            "social_restriction": false,
            "tax_id": "11144477735",
            "total_capital_percentage": 60,
            "relationship_type": "SOCIO",
            "start_date_participation": "01/2020",
            "negativation": null
        }
    ],
    "partner_participation": [
        {
            "_id": "14253647-5869-4bab-9c7d-d4e5f6a7b890",
            "name": "EMPRESA EXEMPLO LTDA",
            "participation_percentage": 30,
            "start_date_participation": "2019-05-01",
            "tax_id": "22333444000155",
            "uf": "MT",
            "update_date": "2026-08-01",
            "relationship_type": "SOCIO",
            "negativation": {
                "result": "NEGATIVADO",
                "updatedAt": "2026-09-01T10:00:00.000Z",
                "status": "FINALIZADO"
            }
        }
    ]
}

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

Página anterior

Solicitar consulta de negativação

Próxima página

Visualizar negativação de uma consulta