---
title: "Score de Crédito PJ"
description: "API Score de Crédito PJ"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/0689e420-0a14-4bdc-9203-ff81e7a871ca
markdown: https://doc.apibrasil.io/apis/creditos/0689e420-0a14-4bdc-9203-ff81e7a871ca.md
source: apibrasil-documentation
---

# Score de Crédito PJ

> API Score de Crédito PJ

- **Categoria:** Consulta CNPJ
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 1,38 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/0689e420-0a14-4bdc-9203-ff81e7a871ca/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/cnpj/credits

⚠️ Aviso: a consulta só é cobrada quando a resposta traz ao menos um score. Sem informação para a consulta, a resposta é HTTP 404 e não há cobrança.

Envie um POST com tipo=score-pj e o cnpj (14 dígitos, com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.credcadastral e traz o bloco scores, com a lista ocorrencias: score, classif_abc, classif_nro, probabilidade_inadimplencia, risco e texto. Cada bloco tem o seu status_retorno (codigo 1 = bloco consultado com sucesso). 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, sem cobrança, para qualquer cnpj válido.

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cnpj/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-pj",
  "cnpj": "11222333000181",
  "homolog": true
}
```

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cnpj/credits" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN" \
  -d '{"tipo":"score-pj","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": "398,620",
  "balance_before": "400,000",
  "tax": "1,380",
  "status_code": 200,
  "error": false,
  "message": "Dados validos! Voce foi tarifado em R$ 1,38.",
  "valor_consulta": 1.38,
  "api_limit_for": "credit",
  "homolog": false,
  "data": {
    "credcadastral": {
      "scores": {
        "status_retorno": {
          "codigo": "1",
          "descricao": "CONSULTA CONCLUIDA COM SUCESSO"
        },
        "quantidade_ocorrencias": "1",
        "ocorrencias": [
          {
            "layout": "1",
            "tipo_score": "SCORE DE HOMOLOGACAO",
            "score": "700",
            "execucao": "",
            "descr_plano": "",
            "descr_score": "SCORE DE HOMOLOGACAO",
            "classif_nro": "3",
            "classif_abc": "C",
            "probabilidade_inadimplencia": "20,00",
            "texto": "AMOSTRA FICTICIA DE HOMOLOGACAO",
            "risco": "BAIXO",
            "modelo_score": "",
            "informante": ""
          }
        ]
      }
    }
  }
}
```

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/0689e420-0a14-4bdc-9203-ff81e7a871ca/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/0689e420-0a14-4bdc-9203-ff81e7a871ca