---
title: "Benefícios Sociais PF"
description: "API Benefícios Sociais PF - Consulte benefícios sociais em tempo real"
lang: en
canonical: https://doc.apibrasil.io/apis/creditos/cdd2dd41-8966-4df5-92b3-51e1168cd430
markdown: https://doc.apibrasil.io/apis/creditos/cdd2dd41-8966-4df5-92b3-51e1168cd430.md
source: apibrasil-documentation
---

# Benefícios Sociais PF

> API Benefícios Sociais PF - Consulte benefícios sociais em tempo real

- **Category:** Search & Collections
- **Billing:** per query, with the Bearer Token only
- **Price:** R$3.50 per query
- **Limit:** 999,000 per month
- **Registration:** requires a CNPJ
- **Version:** v1
- **Published by:** APIBrasil
- **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/cdd2dd41-8966-4df5-92b3-51e1168cd430/openapi.json

## How to call

**Base address:** `https://gateway.apibrasil.io/api/v2`

Authentication: the `Authorization: Bearer <token>` header. Nothing else.

With `homolog: true` in the body, the gateway answers from a fixed base, with the real shape of the response, and does not charge. The CPF 00000000000 belongs to that base and to nobody: use it in tests, never in production.

## Endpoints (1 endpoint)

### 1. POST /consulta/cpf/credits

API Benefícios Sociais - Descubra Direitos com Agilidade

A API Benefícios Sociais PF permite consultar, de forma rápida e segura, informações detalhadas sobre benefícios sociais vinculados ao CPF de uma pessoa física. Com integração simples via POST, você proporciona valor imediato ao seu sistema, acessando dados atualizados que ampliam a eficiência na validação, cadastro e elegibilidade de clientes ou usuários. O retorno claro da API facilita decisões automatizadas, reduz fraudes e melhora a experiência do usuário final, agregando inteligência e vantagem competitiva ao seu negócio. Aproveite todo o potencial dessa solução para transformar processos, ganhando em precisão e agilidade na análise de direitos sociais.

- **Method:** `POST`
- **Address:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits`
- **Route version:** v1

**Headers**

| Header | Value |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Request body**

```json
{
  "tipo": "beneficios-sociais-pf",
  "cpf": "00000000000",
  "homolog": true
}
```

**In 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":"beneficios-sociais-pf","cpf":"00000000000","homolog":true}'
```

This endpoint accepts `homolog: true` in the body: the response comes back with valid data, `api_limit_for` equal to `homolog` and no charge.

**Sample response, from the catalog**

```json
{
  "user": {
    "first_name": "[omitido]",
    "email": "[omitido]",
    "cellphone": "[omitido]",
    "notification": "yes"
  },
  "balance": "725,260",
  "error": true,
  "message": "Essa API não está disponível para esse endpoint, caso precise de ajuda, favor contatar o suporte."
}
```

In the sample responses, the fields of the account that generated the sample (`user.first_name`, `user.email`, `user.cellphone`) come out as `[omitido]`. The rest is what the catalog publishes.

## Pitfalls: what an integration gets wrong without warning

Established from the responses the catalog itself publishes. In every one of them the code works on the happy path and fails silently everywhere else:

1. **The error arrives in the BODY, with HTTP 200.**
   The response carries a boolean `error` field and a `message`. Checking only `response.ok` or the HTTP status lets a failure through as a success. ALWAYS check `error === false` before reading `data`.

2. **`balance`, `tax` and `extra_charges.total` are STRINGS in Brazilian format — and the format varies between APIs.**
   Values seen in the catalog: `"154,380"`, `"497,84"`, `"0,000"` and `"0.19"`. Comma in some, dot in another; three decimal places in some, two in another. In JavaScript, `parseFloat("154,380")` returns `154` and drops the cents with no error at all, and `Number("154,380")` returns `NaN`. Write a converter that handles both separators, and never use these fields in a financial decision without converting them.

3. **Every call costs money.**
   Blind retries multiply the bill. Never automatically repeat a 4xx: a bad parameter repeated is still bad, and still charged. Retry only timeouts and 5xx, with exponential backoff and a small attempt ceiling.

4. **HTTP 402 means insufficient balance, and retrying does not fix it.**
   It is the one status that needs a human — a top-up. Treat it as a terminal error with its own message, and do not lump it in with generic 4xx.

5. **`extra_charges` bills on top of the lookup price.**
   When the body asks for add-on services, the response lists each one with its price plus a `total` that is NOT included in the base amount. If you show cost to an end user, add both.

## See also

- OpenAPI specification: https://doc.apibrasil.io/apis/creditos/cdd2dd41-8966-4df5-92b3-51e1168cd430/openapi.json
- API catalog: [API catalog](https://doc.apibrasil.io/apis.md)
- Official SDKs: [Official SDKs](https://doc.apibrasil.io/sdks.md)
- Documentation index: https://doc.apibrasil.io/llms.txt
- HTML version of this page: https://doc.apibrasil.io/apis/creditos/cdd2dd41-8966-4df5-92b3-51e1168cd430