---
title: "Antifraude PIX"
description: "API Antifraude PIX - Proteção inteligente em tempo real"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/ayb1dc3fa-e455-45c2-adc12-baet1fe-2a
markdown: https://doc.apibrasil.io/apis/creditos/ayb1dc3fa-e455-45c2-adc12-baet1fe-2a.md
source: apibrasil-documentation
---

# Antifraude PIX

> API Antifraude PIX - Proteção inteligente em tempo real

- **Categoria:** Emissão de Certidões
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 3,49 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/ayb1dc3fa-e455-45c2-adc12-baet1fe-2a/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 Antifraude PIX - Proteção inteligente em tempo real

A API Antifraude PIX permite consultar de forma rápida e segura o risco de fraude atrelado a um CPF antes de autorizar uma transação PIX, reduzindo perdas financeiras e aumentando a confiança nas suas operações. Com integração simples via método POST na rota antifraude-chave-pix (consulta/cpf/credits), você obtém em segundos um retorno estruturado com indicadores de risco e recomendação de aprovação, recusa ou revisão manual. Isso gera valor direto para o seu negócio ao diminuir chargebacks, proteger a experiência do usuário e automatizar regras de decisão em seu fluxo de pagamentos. A API pode ser plugada ao seu sistema de core bancário, app de carteira digital, plataforma de marketplace ou solução de cobrança, permitindo que cada transação PIX seja avaliada em tempo real, sem fricção e com alto nível de precisão.

- **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": "antifraude-chave-pix",
  "documento": "15379633331",
  "tipo-chave": "cpf",
  "chave-pix": "15379633331",
  "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":"antifraude-chave-pix","documento":"15379633331","tipo-chave":"cpf","chave-pix":"15379633331","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": "108,300",
  "balance_before": "108,300",
  "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": {
    "chavePix": "00000000000",
    "documento": "000.000.000-00",
    "nomeEntidade": "Homologacao Pix",
    "probabilidadeTitularidade": "Indefinido",
    "riscoFraude": "Risco Nao Avaliado",
    "riscoLaranja": "Risco Nao Avaliado",
    "status": "Chave Em Homologacao",
    "tipo": "CPF"
  }
}
```

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/ayb1dc3fa-e455-45c2-adc12-baet1fe-2a/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/ayb1dc3fa-e455-45c2-adc12-baet1fe-2a