Visualizar resumo do SCR de um cliente

GET

/v2/queries/clients/{clientId}/scr-resume/{queryId}

Visualiza o resumo do SCR (Sistema de Informações de Créditos do Banco Central) apurado para o cliente na consulta informada: dívida vencida, carteira ativa A, dívida rural, endividamento oneroso, pagamento de juros, prejuízo e taxa de juros. As séries por período vêm em quatro faixas de meses (de 1 a 6, de 6 a 12, de 12 a 18 e de 18 a 24 meses), em que greater_than_or_equal é o início da faixa e less_than, o fim. Valores são em reais e percentuais vão de 0 a 100. Campos sem valor apurado vêm com 0, faixas sem dados vêm com valor 0, e a taxa de juros vem com -1 quando não foi apurada. Devolve null quando não há resumo registrado para essa combinação de cliente e consulta. Só retorna dados de clientes vinculados à empresa do usuário autenticado: cliente de outra empresa devolve 401, e cliente inexistente devolve 404. 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 de Caminho

Parâmetros Header

Respostas

🟢200

application/json

Resumo do SCR

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/queries/clients/4005e4a6-08b5-4dea-b4f9-35a6630154ad/scr-resume/b7e3c2a1-4f5d-4a6b-8c9d-0e1f2a3b4c5d' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "_id": "3c9e1b7a-2d4f-4e6a-8b1c-5f7d9e0a2b4c",
    "company_id": "5f8d0d55b54764421b7156a1",
    "client_id": "4005e4a6-08b5-4dea-b4f9-35a6630154ad",
    "query_id": "b7e3c2a1-4f5d-4a6b-8c9d-0e1f2a3b4c5d",
    "overdue": {
        "amount_last_month": 30000,
        "quantities_per_interval_of_months": [
            {
                "greater_than_or_equal": 1,
                "less_than": 6,
                "value": 1
            },
            {
                "greater_than_or_equal": 6,
                "less_than": 12,
                "value": 0
            },
            {
                "greater_than_or_equal": 12,
                "less_than": 18,
                "value": 0
            },
            {
                "greater_than_or_equal": 18,
                "less_than": 24,
                "value": 0
            }
        ],
        "percent_in_relation_total_indebtednesss_per_interval_of_months": [
            {
                "greater_than_or_equal": 1,
                "less_than": 6,
                "value": 3.06
            },
            {
                "greater_than_or_equal": 6,
                "less_than": 12,
                "value": 0
            },
            {
                "greater_than_or_equal": 12,
                "less_than": 18,
                "value": 0
            },
            {
                "greater_than_or_equal": 18,
                "less_than": 24,
                "value": 0
            }
        ],
        "percent_in_relation_total_indebtednesss_historical": 0.51,
        "percent_in_relation_total_indebtednesss_last_month": 3.06
    },
    "active_portfolio_a": 980000.25,
    "debts_rural": {
        "amount_last_month": 620000,
        "percent_in_relation_total_per_interval_of_months": [
            {
                "greater_than_or_equal": 1,
                "less_than": 6,
                "value": 63.27
            },
            {
                "greater_than_or_equal": 6,
                "less_than": 12,
                "value": 61.8
            },
            {
                "greater_than_or_equal": 12,
                "less_than": 18,
                "value": 60.12
            },
            {
                "greater_than_or_equal": 18,
                "less_than": 24,
                "value": 58.4
            }
        ],
        "percent_in_relation_total_last_month": 63.27
    },
    "onerous_indebtedness": {
        "per_interval_of_months": [
            {
                "greater_than_or_equal": 1,
                "less_than": 6,
                "currency": 121500.5,
                "percent_in_relation_active_portfolio_a": 12.4,
                "weight": 4.81
            },
            {
                "greater_than_or_equal": 6,
                "less_than": 12,
                "currency": 98000,
                "percent_in_relation_active_portfolio_a": 10.1,
                "weight": 2.35
            },
            {
                "greater_than_or_equal": 12,
                "less_than": 18,
                "currency": 44500,
                "percent_in_relation_active_portfolio_a": 4.6,
                "weight": 0.11
            },
            {
                "greater_than_or_equal": 18,
                "less_than": 24,
                "currency": 0,
                "percent_in_relation_active_portfolio_a": 0,
                "weight": 0
            }
        ],
        "historical": {
            "currency": 12,
            "percent_in_relation_active_portfolio_a": 9.8,
            "weight": 3.2
        },
        "last_month": {
            "currency": 121500.5,
            "percent_in_relation_active_portfolio_a": 12.4,
            "weight": 4.81
        }
    },
    "interest_payments": 28470.35,
    "financial_loss": {
        "quantities_greater_than_limit_per_interval_of_months": [
            {
                "greater_than_or_equal": 1,
                "less_than": 6,
                "value": 0
            },
            {
                "greater_than_or_equal": 6,
                "less_than": 12,
                "value": 0
            },
            {
                "greater_than_or_equal": 12,
                "less_than": 18,
                "value": 0
            },
            {
                "greater_than_or_equal": 18,
                "less_than": 24,
                "value": 0
            }
        ],
        "quantities_per_interval_of_months": [
            {
                "greater_than_or_equal": 1,
                "less_than": 6,
                "value": 0
            },
            {
                "greater_than_or_equal": 6,
                "less_than": 12,
                "value": 0
            },
            {
                "greater_than_or_equal": 12,
                "less_than": 18,
                "value": 0
            },
            {
                "greater_than_or_equal": 18,
                "less_than": 24,
                "value": 0
            }
        ],
        "financial_losses_per_interval_of_months": [
            {
                "greater_than_or_equal": 1,
                "less_than": 6,
                "value": 0
            },
            {
                "greater_than_or_equal": 6,
                "less_than": 12,
                "value": 0
            },
            {
                "greater_than_or_equal": 12,
                "less_than": 18,
                "value": 0
            },
            {
                "greater_than_or_equal": 18,
                "less_than": 24,
                "value": 0
            }
        ],
        "financial_losses_last_month": 0
    },
    "interest_Rate": 1.85
}

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

Página anterior

Listar solicitações de SCR

Próxima página

Solicitar análise de endividamento por IA