---
title: "Score de Crédito com Indicadores"
description: "API Score de Crédito com Indicadores"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/821a1d62-ab0e-4cba-b5dc-1dc24817b722
markdown: https://doc.apibrasil.io/apis/creditos/821a1d62-ab0e-4cba-b5dc-1dc24817b722.md
source: apibrasil-documentation
---

# Score de Crédito com Indicadores

> API Score de Crédito com Indicadores

- **Categoria:** Análise de Crédito
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 5,15 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/821a1d62-ab0e-4cba-b5dc-1dc24817b722/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=score-credito-indicadores e o cpf ou o cnpj (exatamente um por consulta, com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.dados e traz situacao (localizado ou nada_consta), documento, tipo_pessoa, score, escala, faixa_score, risco_inadimplencia, score_perfil, descricao_perfil, score_pagamento, descricao_score_pagamento, motivos, indicadores_negocio, observacao e o link pdf do relatório. A cobrança acontece quando o score é devolvido; documento sem score localizado também é cobrado, com situacao nada_consta; retorno sem conteúdo aproveitável responde HTTP 404 e falhas de consulta (4xx/5xx) não são cobradas; 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": "score-credito-indicadores",
  "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":"score-credito-indicadores","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": "394,850",
  "balance_before": "400,000",
  "tax": "5,150",
  "status_code": 200,
  "error": false,
  "message": "Dados validos! Voce foi tarifado em R$ 5,15.",
  "valor_consulta": 5.15,
  "api_limit_for": "credit",
  "homolog": false,
  "data": {
    "dados": {
      "descricao_perfil": null,
      "descricao_score_pagamento": null,
      "documento": "11.222.333/0001-81",
      "escala": {
        "maximo": 1000,
        "minimo": 0
      },
      "faixa_score": "Médio índice de inadimplência",
      "indicadores_negocio": [
        {
          "indicador": "Pontualidade de pagamentos",
          "observacao": null,
          "risco": "Baixo",
          "situacao": "Volume alto de compromissos pagos em dia."
        },
        {
          "indicador": "Endividamento",
          "observacao": "Amostra fictícia",
          "risco": "Médio",
          "situacao": "Nível de endividamento moderado."
        }
      ],
      "motivos": [
        "Volume de compromissos financeiros pagos em dia (amostra fictícia)",
        "Pouco tempo de relacionamento com o mercado (amostra fictícia)"
      ],
      "observacao": null,
      "pdf": "(link do PDF da consulta)",
      "risco_inadimplencia": "medio",
      "score": 672,
      "score_pagamento": null,
      "score_perfil": null,
      "situacao": "localizado",
      "tipo_pessoa": "pj"
    }
  }
}
```

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/821a1d62-ab0e-4cba-b5dc-1dc24817b722/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/821a1d62-ab0e-4cba-b5dc-1dc24817b722
