--- title: "SCR Detalhado do Banco Central" description: "API SCR Detalhado do Banco Central" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/976fa08a-9854-4b1d-810b-1d3aac2cc328 markdown: https://doc.apibrasil.io/apis/creditos/976fa08a-9854-4b1d-810b-1d3aac2cc328.md source: apibrasil-documentation --- # SCR Detalhado do Banco Central > API SCR Detalhado do Banco Central - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 10,78 por consulta - **Limite:** 990.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/976fa08a-9854-4b1d-810b-1d3aac2cc328/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## Endpoints (1 endpoint) ### 1. POST /consulta/cpf/credits Envie um POST com tipo=scr-detalhada e o cpf (11 dígitos) ou o cnpj (14 dígitos), um só por requisição, com o dígito verificador conferido; opcionalmente o mes_ano (MM/aaaa) da competência, que sem ele é a mais recente. A resposta vem em data.dados e traz documento, mes_referencia, data_inicio_relacionamento, numero_historico, quantidades de instituições e operações (inclusive em discordância e sub judice), obrigações, responsabilidades totais, score, faixa_risco, risco_total, carteira_credito, a lista modalidades (a liberar, a vencer, vencido, prejuízo e limite), resumo com o alerta e o link pdf do relatório. A cobrança acontece quando o Banco Central devolve o SCR do documento; documento sem registro no SCR ou resposta vazia responde HTTP 404, e falhas de consulta respondem 4xx/5xx, sem cobrança; campo cnpj ausente ou inválido é recusado com HTTP 400, sem cobrança. Fonte indisponível responde HTTP 502, 503 ou 504, também sem cobrança. Em homologação (homolog=true) a resposta é uma amostra fictícia completa, sem cobrança, para qualquer cnpj válido. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "scr-detalhada", "cnpj": "11222333000181", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cpf/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"scr-detalhada","cnpj":"11222333000181","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "389,220", "balance_before": "400,000", "tax": "10,780", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 10,78.", "valor_consulta": 10.78, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "carteira_credito": { "a_vencer": 7800, "limite": 25000, "prejuizo": 1200, "total": 10000, "vencido": 1000 }, "data_inicio_relacionamento": "01/01/2015", "documento": "11.222.333/0001-81", "faixa_risco": "Risco baixo", "mes_referencia": "09/2026", "modalidades": [ { "a_liberar": { "acima_de_361_dias": 0, "de_181_a_360_dias": 400, "de_1_a_30_dias": 100, "de_31_a_60_dias": 200, "de_61_a_90_dias": 0, "de_91_a_180_dias": 300, "total": 0 }, "a_vencer": { "acima_de_361_dias": 0, "acima_de_5400_dias": 0, "de_1081_a_1440_dias": 0, "de_1441_a_1800_dias": 0, "de_1801_a_5400_dias": 0, "de_181_a_360_dias": 400, "de_1_a_30_dias": 100, "de_31_a_60_dias": 200, "de_361_a_720_dias": 0, "de_61_a_90_dias": 0, "de_721_a_1080_dias": 0, "de_91_a_180_dias": 300, "total": 7800 }, "codigo": "0101", "descricao": "Capital de giro (teste)", "limite_credito": 20000, "prejuizo": { "acima_de_48_meses": 0, "ate_12_meses": 1200, "ate_24_meses": 0, "ate_36_meses": 0, "ate_48_meses": 0, "total": 1200 }, "variacao_cambial": 0, "vencido": { "acima_de_361_dias": 0, "acima_de_5400_dias": 0, "de_1081_a_1440_dias": 0, "de_1441_a_1800_dias": 0, "de_1801_a_5400_dias": 0, "de_181_a_360_dias": 400, "de_1_a_30_dias": 100, "de_31_a_60_dias": 200, "de_361_a_720_dias": 0, "de_61_a_90_dias": 0, "de_721_a_1080_dias": 0, "de_91_a_180_dias": 300, "total": 1000 } }, { "a_liberar": { "acima_de_361_dias": 0, "de_181_a_360_dias": 400, "de_1_a_30_dias": 100, "de_31_a_60_dias": 200, "de_61_a_90_dias": 0, "de_91_a_180_dias": 300, "total": 0 }, "a_vencer": { "acima_de_361_dias": 0, "acima_de_5400_dias": 0, "de_1081_a_1440_dias": 0, "de_1441_a_1800_dias": 0, "de_1801_a_5400_dias": 0, "de_181_a_360_dias": 400, "de_1_a_30_dias": 100, "de_31_a_60_dias": 200, "de_361_a_720_dias": 0, "de_61_a_90_dias": 0, "de_721_a_1080_dias": 0, "de_91_a_180_dias": 300, "total": 0 }, "codigo": "0202", "descricao": "Cartão de crédito (teste)", "limite_credito": 5000, "prejuizo": { "acima_de_48_meses": 0, "ate_12_meses": 0, "ate_24_meses": 0, "ate_36_meses": 0, "ate_48_meses": 0, "total": 0 }, "variacao_cambial": null, "vencido": { "acima_de_361_dias": 0, "acima_de_5400_dias": 0, "de_1081_a_1440_dias": 0, "de_1441_a_1800_dias": 0, "de_1801_a_5400_dias": 0, "de_181_a_360_dias": 400, "de_1_a_30_dias": 100, "de_31_a_60_dias": 200, "de_361_a_720_dias": 0, "de_61_a_90_dias": 0, "de_721_a_1080_dias": 0, "de_91_a_180_dias": 300, "total": 0 } } ], "numero_historico": 12, "obrigacao_assumida": 10000, "obrigacao_resumida": 9500, "pdf": "(link do PDF da consulta)", "percentual_documento_processado": 100, "percentual_volume_processado": 98.5, "quantidade_instituicoes": 3, "quantidade_operacoes": 5, "quantidade_operacoes_discordancia": 0, "quantidade_operacoes_subjudice": 1, "responsabilidade_total": 10000, "responsabilidade_total_discordancia": 0, "responsabilidade_total_subjudice": 500, "resumo": { "alerta": "alto", "possui_operacao_discordancia": false, "possui_operacao_subjudice": true, "possui_prejuizo": true, "possui_vencido": true, "total_modalidades": 2 }, "risco_indireto_vendor": 0, "risco_total": 10000, "score": 720, "score_observacao": "Amostra fictícia de homologação." } } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/976fa08a-9854-4b1d-810b-1d3aac2cc328/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/976fa08a-9854-4b1d-810b-1d3aac2cc328