---
title: "Restrições de Crédito Serasa"
description: "Restrições de crédito de uma pessoa ou de uma empresa na Serasa e em protestos: se há restrição, o total e o valor das ocorrências, cada ocorrência com tipo, credor, valor e datas, o score e a classificação de risco. Cobrada quando a Serasa responde, inclusive quando nada consta; se a Serasa não responder, não há cobrança."
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/b42a4813-de01-11f1-98bb-bc24118aba26
markdown: https://doc.apibrasil.io/apis/creditos/b42a4813-de01-11f1-98bb-bc24118aba26.md
source: apibrasil-documentation
---

# Restrições de Crédito Serasa

> Restrições de crédito de uma pessoa ou de uma empresa na Serasa e em protestos: se há restrição, o total e o valor das ocorrências, cada ocorrência com tipo, credor, valor e datas, o score e a classificação de risco. Cobrada quando a Serasa responde, inclusive quando nada consta; se a Serasa não responder, não há cobrança.

- **Categoria:** Negativação e Protesto
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 39,90 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/b42a4813-de01-11f1-98bb-bc24118aba26/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/restricoes-serasa/credits

⚠️ Aviso: a consulta é cobrada sempre que a Serasa responde, inclusive quando não há restrição. Pode levar até 40 segundos.

Envie um POST com tipo=restricoes-serasa e o documento (CPF ou CNPJ, com ou sem máscara). O campo data traz tipo_documento, titular, possui_restricao, bases_com_restricao, bases_sem_resposta, resumo (total_ocorrencias e valor_total), bases (serasa e protestos, cada uma com situacao, ocorrencias e valor_total), ocorrencias (base, tipo, modalidade, credor, contrato, valor, data_ocorrencia, data_inclusao, cidade e avalista), scores, classificacao_risco e consultado_em, além do documento consultado. Documento inválido é recusado com HTTP 400, sem cobrança. Se a Serasa não responder, a resposta é HTTP 503, sem cobrança: nunca sai resultado sem ela. Base de dados indisponível devolve HTTP 502, 503 ou 504, sem cobrança. Disponível para contas PJ. Em homologação (homolog=true), sem cobrança e com qualquer documento válido, a resposta traz dados fictícios.

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

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/restricoes-serasa/credits" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN" \
  -d '{"tipo":"restricoes-serasa","documento":"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": "360,100",
  "balance_before": "400,000",
  "tax": "39,900",
  "status_code": 200,
  "error": false,
  "message": "Dados validos! Voce foi tarifado em R$ 39,90.",
  "valor_consulta": 39.9,
  "api_limit_for": "credit",
  "homolog": false,
  "data": {
    "tipo_documento": "cpf",
    "titular": {
      "nome": "NOME FICTICIO DE TESTE",
      "data_nascimento": "1990-01-01"
    },
    "possui_restricao": true,
    "bases_com_restricao": [
      "serasa"
    ],
    "bases_sem_resposta": [],
    "resumo": {
      "total_ocorrencias": 1,
      "valor_total": 219.96
    },
    "bases": {
      "serasa": {
        "situacao": "consta",
        "ocorrencias": 1,
        "valor_total": 219.96
      },
      "protestos": {
        "situacao": "nada_consta",
        "ocorrencias": 0,
        "valor_total": null
      }
    },
    "ocorrencias": [
      {
        "base": "serasa",
        "tipo": "PEFIN",
        "modalidade": "DIVIDA",
        "credor": "CREDOR FICTICIO LTDA",
        "contrato": null,
        "valor": 219.96,
        "data_ocorrencia": "2025-03-20",
        "data_inclusao": "2025-03-20",
        "cidade": null,
        "avalista": false
      }
    ],
    "scores": [
      {
        "base": "serasa",
        "valor": 550
      }
    ],
    "classificacao_risco": null,
    "consultado_em": "2026-11-11T12:00:00.000Z",
    "documento": "11222333000181"
  }
}
```

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/b42a4813-de01-11f1-98bb-bc24118aba26/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/b42a4813-de01-11f1-98bb-bc24118aba26