---
title: "Negativações e Restrições Detalhadas"
description: "API Negativações e Restrições Detalhadas"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/2a6940de-48a4-4a87-ba39-f9fb38ac00ef
markdown: https://doc.apibrasil.io/apis/creditos/2a6940de-48a4-4a87-ba39-f9fb38ac00ef.md
source: apibrasil-documentation
---

# Negativações e Restrições Detalhadas

> API Negativações e Restrições Detalhadas

- **Categoria:** Negativação e Protesto
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 6,23 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/2a6940de-48a4-4a87-ba39-f9fb38ac00ef/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=negativacoes-detalhadas e o cpf (11 dígitos) ou o cnpj (14 dígitos), apenas um dos dois, com ou sem máscara; o dígito verificador é conferido. A resposta vem em data.dados e traz documento, tipo_pessoa (fisica ou juridica), situacao (consta_pendencia ou nada_consta), possui_pendencia, situacao_texto, valor_total_pendencia, observacao, resumo, negativacoes, protestos, acoes_judiciais, recuperacoes_judiciais_falencias, cheques_sem_fundo e o link pdf do relatório. A cobrança acontece quando a consulta é respondida, com ou sem pendência; documento sem pendência responde 200 com situacao nada_consta, também cobrado; resposta sem nenhum bloco (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": "negativacoes-detalhadas",
  "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":"negativacoes-detalhadas","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": "393,770",
  "balance_before": "400,000",
  "tax": "6,230",
  "status_code": 200,
  "error": false,
  "message": "Dados validos! Voce foi tarifado em R$ 6,23.",
  "valor_consulta": 6.23,
  "api_limit_for": "credit",
  "homolog": false,
  "data": {
    "dados": {
      "acoes_judiciais": [
        {
          "autor": "BANCO EXEMPLO S.A.",
          "cidade": "SAO PAULO",
          "comarca": "SAO PAULO",
          "data_ajuizamento": "10/02/2024",
          "documento": "11222333000181",
          "forum": "FORUM CENTRAL",
          "numero_processo": "00000000020248260000",
          "numero_processo_antigo": null,
          "parte_acusada": "EMPRESA TESTE LTDA",
          "situacao": null,
          "tipo_processo": "EXECUCAO DE TITULO EXTRAJUDICIAL",
          "tipo_tribunal": "ESTADUAL",
          "valor": 15582.58,
          "vara": "1 VARA CIVEL"
        }
      ],
      "cheques_sem_fundo": [
        {
          "codigo_banco": "001",
          "data_ultima_ocorrencia": "05/01/2025",
          "documento": "11222333000181",
          "nome_agencia": "AGENCIA TESTE",
          "numero_agencia": "0001",
          "quantidade_ocorrencias": 1,
          "tipo_pessoa": "Juridica"
        }
      ],
      "documento": "11222333000181",
      "negativacoes": [
        {
          "credor": "CREDOR EXEMPLO LTDA",
          "data_atualizacao": null,
          "data_inclusao": "15/03/2025",
          "data_ocorrencia": "10/03/2025",
          "documento_credor": "11222333000181",
          "endereco": {
            "bairro": "CENTRO",
            "cep": "01000-000",
            "cidade": "SAO PAULO",
            "complemento": "SALA 1",
            "logradouro": "RUA EXEMPLO",
            "numero": "100",
            "uf": "SP"
          },
          "motivo": "FINANCIAMENTOS",
          "numero_contrato": "12345",
          "situacao": "ATIVO",
          "tipo_participacao": "devedor principal",
          "valor": 506.11
        }
      ],
      "observacao": null,
      "pdf": "(link do PDF da consulta)",
      "possui_pendencia": true,
      "protestos": [
        {
          "cartorios": [
            {
              "cidade": "SAO PAULO",
              "codigo_cartorio": "01",
              "codigo_cidade": "3550308",
              "endereco": "RUA DE TESTE, 100 CENTRO",
              "nome": "1 TABELIAO DE PROTESTO DE TESTE",
              "quantidade_protestos": 2,
              "telefone": "11 00000000",
              "valor_protestado": 1500
            }
          ],
          "observacao": "A entidade possui protestos",
          "quantidade_cartorios": 1,
          "situacao": "Consta Protesto",
          "valor_total": 1500
        }
      ],
      "recuperacoes_judiciais_falencias": [
        {
          "autor": "BANCO EXEMPLO S.A.",
          "cidade": "SAO PAULO",
          "comarca": "SAO PAULO",
          "data_ajuizamento": "10/02/2024",
          "documento": "11222333000181",
          "forum": "FORUM CENTRAL",
          "numero_processo": "00000000120238260000",
          "numero_processo_antigo": null,
          "parte_acusada": "EMPRESA TESTE LTDA",
          "situacao": "CONCEDIDA",
          "tipo_processo": "RECUPERACAO JUDICIAL",
          "tipo_tribunal": "ESTADUAL",
          "valor": null,
          "vara": "1 VARA CIVEL"
        }
      ],
      "resumo": {
        "acoes_judiciais": 1,
        "cheques_sem_fundo": 1,
        "negativacoes": 1,
        "protestos": 1,
        "recuperacoes_judiciais_falencias": 1,
        "total_registros": 5,
        "valor_negativado": 506.11,
        "valor_protestado": 1500
      },
      "situacao": "consta_pendencia",
      "situacao_texto": "Consta Pendência",
      "tipo_pessoa": "juridica",
      "valor_total_pendencia": 17588.69
    }
  }
}
```

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/2a6940de-48a4-4a87-ba39-f9fb38ac00ef/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/2a6940de-48a4-4a87-ba39-f9fb38ac00ef
