---
title: "Histórico de Crédito SCR Analítico"
description: "API Histórico de Crédito SCR Analítico"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/42ddc8be-2f59-4dd7-80cb-9e13be34dce0
markdown: https://doc.apibrasil.io/apis/creditos/42ddc8be-2f59-4dd7-80cb-9e13be34dce0.md
source: apibrasil-documentation
---

# Histórico de Crédito SCR Analítico

> API Histórico de Crédito SCR Analítico

- **Categoria:** Análise de Crédito
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 12,87 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/42ddc8be-2f59-4dd7-80cb-9e13be34dce0/openapi.json

## Como chamar

**Endereço base:** `https://gateway.apibrasil.io/api/v2`

Autenticação: cabeçalho `Authorization: Bearer <token>`. 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=credito-scr-analitico e o cpf (11 dígitos) ou o cnpj (14 dígitos), com ou sem máscara, um por consulta; o dígito verificador é conferido. Ao consultar, o cliente declara ter a autorização do titular do documento. A resposta vem em data.dados e traz documento e tipo_documento, score, perfil, volume, relacionamentos, situacao, classe_risco, quantidade_operacoes, quantidade_instituicoes, carteira_credito (a vencer e vencida), indice, percentual_categoria, percentual_vencido, percentual_prazo, percentual_evolucao_compromisso, resumo (alertas) e o link pdf do relatório. A cobrança acontece quando a fonte responde com dados de crédito; documento sem registro no SCR responde HTTP 200 com situacao nada_consta, também cobrado. Resposta sem conteúdo aproveitável (HTTP 404) e falhas de consulta (4xx/5xx) não são cobradas; campo cpf 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 cpf 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": "credito-scr-analitico",
  "cpf": "40442820135",
  "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":"credito-scr-analitico","cpf":"40442820135","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": "387,130",
  "balance_before": "400,000",
  "tax": "12,870",
  "status_code": 200,
  "error": false,
  "message": "Dados validos! Voce foi tarifado em R$ 12,87.",
  "valor_consulta": 12.87,
  "api_limit_for": "credit",
  "homolog": false,
  "data": {
    "dados": {
      "carteira_credito": {
        "valor_a_vencer": "De R$ 1.000,00 a R$ 5.000,00",
        "valor_vencido": "De R$ 100,00 a R$ 500,00"
      },
      "classe_risco": "Risco Alto",
      "documento": "404.428.201-35",
      "indice": {
        "cartao": "R$ 0,80 a cada R$ 100,00",
        "cheque_especial": "R$ 0,20 a cada R$ 100,00",
        "credito_pessoal": "R$ 0,50 a cada R$ 100,00",
        "total": "R$ 1,50 a cada R$ 100,00"
      },
      "pdf": "(link do PDF da consulta)",
      "percentual_categoria": {
        "adiantamentos_depositantes": 0,
        "cartao": 40,
        "coobrigacoes": 0,
        "emprestimos": 30,
        "financiamentos": 10,
        "financiamentos_exportacao": 0,
        "financiamentos_imobiliarios": 5,
        "financiamentos_veiculos": 5,
        "linha_risco_maior": 100,
        "operacoes_arrendamento": 0,
        "outros": 5,
        "outros_creditos": 5
      },
      "percentual_evolucao_compromisso": {
        "cartao": 5,
        "financiamentos": 0,
        "maior_risco": -32.12,
        "total": -12.4
      },
      "percentual_prazo": {
        "curto": 20,
        "longo": 49.5,
        "medio": 30.5
      },
      "percentual_vencido": {
        "adiantamento_depositos": 1.25,
        "cartao": 0,
        "emprestimos": 12.5,
        "financiamentos": 0,
        "financiamentos_imobiliarios": 0,
        "financiamentos_veiculos": 0
      },
      "perfil": "Conservador",
      "quantidade_instituicoes": 2,
      "quantidade_operacoes": 6,
      "relacionamentos": "Moderado",
      "resumo": {
        "alertas": [
          "operação com valor vencido",
          "classe de risco elevada"
        ],
        "possui_operacoes": true,
        "possui_valor_vencido": true
      },
      "score": 620,
      "situacao": "Atenção",
      "tipo_documento": "cpf",
      "volume": "Médio"
    }
  }
}
```

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/42ddc8be-2f59-4dd7-80cb-9e13be34dce0/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/42ddc8be-2f59-4dd7-80cb-9e13be34dce0
