---
title: "Divida Ativa"
description: "API Divida Ativa - Consulta Rápida de Dívidas em CPF"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/e3d2db92-330e-4bc6-b28b-7d98f8bdf036
markdown: https://doc.apibrasil.io/apis/creditos/e3d2db92-330e-4bc6-b28b-7d98f8bdf036.md
source: apibrasil-documentation
---

# Divida Ativa

> API Divida Ativa - Consulta Rápida de Dívidas em CPF

- **Categoria:** Regularidade Fiscal
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 8,50 por consulta
- **Limite:** 999.000 por mês
- **Cadastro:** exige CNPJ
- **Versão:** v2
- **Publicada por:** APIBrasil
- **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/e3d2db92-330e-4bc6-b28b-7d98f8bdf036/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

API Dívida Ativa - Consulte Débitos Pendentes em Instantes

A API Divida Ativa permite a consulta rápida e precisa de dívidas ativas vinculadas ao CPF de seus clientes, integrando-se facilmente ao seu sistema através de um endpoint simples via método POST. Com respostas detalhadas e atualizadas em tempo real, você obtém informações valiosas para análise de crédito, concessão de benefícios ou tomada de decisões em processos financeiros. Otimize suas operações e minimize riscos ao incorporar essa solução eficiente, elevando a segurança e agilidade no seu fluxo de trabalho.

- **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
{
  "cpf": "00000000000",
  "tipo": "divida-ativa",
  "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 '{"cpf":"00000000000","tipo":"divida-ativa","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": "105,660",
  "balance_before": "105,660",
  "tax": "0,000",
  "status_code": 200,
  "error": false,
  "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.",
  "valor_consulta": 0,
  "api_limit_for": "homolog",
  "homolog": true,
  "data": {
    "dividaAtiva": [
      {
        "_id": "mock-divida-001",
        "codigoComprot": "1100001",
        "codigoSida": "6000",
        "codigoTipoSituacao": "06",
        "codigoUorg": "0004520",
        "cpfCnpj": "000.000.000-00",
        "descricaoTipoSituacao": "EXTINTA",
        "id": "mock-divida-001",
        "nomeDevedor": "CONTRIBUINTE DEMONSTRATIVO",
        "nomeUnidade": "PROCURADORIA REGIONAL DEMO",
        "numeroInscricao": "00 0 24 000001-00",
        "numeroProcesso": "12345 000000/2024-00",
        "situacaoDescricao": "EXTINTA POR CANCELAMENTO VALOR ILUSTRATIVO",
        "tipoDevedor": "CO-RESPONSAVEL",
        "tipoRegularidade": "REGULAR",
        "valorTotalConsolidadoMoeda": "0,00"
      }
    ]
  }
}
```

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/e3d2db92-330e-4bc6-b28b-7d98f8bdf036/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/e3d2db92-330e-4bc6-b28b-7d98f8bdf036