---
title: "Benefícios Sociais por CPF"
description: "API Benefícios Sociais por CPF"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/3e513808-5c2d-43f1-95fa-ffad57d943b7
markdown: https://doc.apibrasil.io/apis/creditos/3e513808-5c2d-43f1-95fa-ffad57d943b7.md
source: apibrasil-documentation
---

# Benefícios Sociais por CPF

> API Benefícios Sociais por CPF

- **Categoria:** Consulta CPF
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 2,36 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/3e513808-5c2d-43f1-95fa-ffad57d943b7/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=assistencia-social-pf e o cpf (11 dígitos, com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.dados e traz o documento consultado, nome, NIS, data de nascimento, nome da mãe, indicador de óbito, a situação (consta ou nada_consta), o veredito possui_beneficio, o total_programas, a lista programas_ativos, o mapa programas (bolsa_familia, bpc, garantia_safra, seguro_defeso, auxilio_emergencial, auxilio_reconstrucao e gas_do_povo), um resumo com alerta e o link pdf do relatório. A cobrança acontece quando o CPF é consultado e a resposta sai com HTTP 200, inclusive quando a pessoa não recebe nenhum programa ou o CPF não tem registro (situacao nada_consta, com PDF); resposta sem conteúdo aproveitável (HTTP 404), CPF recusado (400) e falhas de consulta (4xx/5xx) não são cobrados; campo cpf 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 cpf 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": "assistencia-social-pf",
  "cpf": "40442820135",
  "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":"assistencia-social-pf","cpf":"40442820135","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": "397,640",
  "balance_before": "400,000",
  "tax": "2,360",
  "status_code": 200,
  "error": false,
  "message": "Dados validos! Voce foi tarifado em R$ 2,36.",
  "valor_consulta": 2.36,
  "api_limit_for": "credit",
  "homolog": false,
  "data": {
    "dados": {
      "data_nascimento": "15/03/1980",
      "documento": "404.428.201-35",
      "nis": "123.45678.90-1",
      "nome": "FULANO DE TESTE",
      "nome_mae": "MARIA DE TESTE",
      "obito": false,
      "pdf": "(link do PDF da consulta)",
      "possui_beneficio": true,
      "programas": {
        "auxilio_emergencial": true,
        "auxilio_reconstrucao": false,
        "bolsa_familia": true,
        "bpc": false,
        "garantia_safra": false,
        "gas_do_povo": false,
        "seguro_defeso": false
      },
      "programas_ativos": [
        "Bolsa Família",
        "Auxílio Emergencial"
      ],
      "resumo": {
        "alerta": "Há registro de recebimento de benefício social para o CPF informado: 2 programa(s)."
      },
      "situacao": "consta",
      "total_programas": 2
    }
  }
}
```

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/3e513808-5c2d-43f1-95fa-ffad57d943b7/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/3e513808-5c2d-43f1-95fa-ffad57d943b7
