---
title: "Exposição e Vínculos AML por CPF"
description: "API Exposição e Vínculos AML por CPF"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/279f71e5-2af1-424f-80d5-069e445e4c4c
markdown: https://doc.apibrasil.io/apis/creditos/279f71e5-2af1-424f-80d5-069e445e4c4c.md
source: apibrasil-documentation
---

# Exposição e Vínculos AML por CPF

> API Exposição e Vínculos AML por CPF

- **Categoria:** Antifraude e Compliance
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 2,16 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/279f71e5-2af1-424f-80d5-069e445e4c4c/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=aml-vinculos e o cpf (11 dígitos, com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.dados e traz situacao (localizado ou nada_consta), pessoa (documento, nome, data de nascimento, gênero, óbito, data do óbito e pep), parentescos (lista com grau, documento, nome e dados do parente), sociedades (lista com cnpj, razão social, datas de abertura e baixa e o quadro de sócios), resumo (pep, óbito, total de parentes, total de sociedades, sociedades ativas e alertas) e o link pdf do relatório. A cobrança acontece quando a consulta é respondida com sucesso (HTTP 200), inclusive quando nada consta para o CPF (situacao nada_consta); resposta sem conteúdo aproveitável (HTTP 404) e falhas de consulta (4xx/5xx) não são cobradas; 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": "aml-vinculos",
  "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":"aml-vinculos","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,840",
  "balance_before": "400,000",
  "tax": "2,160",
  "status_code": 200,
  "error": false,
  "message": "Dados validos! Voce foi tarifado em R$ 2,16.",
  "valor_consulta": 2.16,
  "api_limit_for": "credit",
  "homolog": false,
  "data": {
    "dados": {
      "parentescos": [
        {
          "data_nascimento": "02/02/1950",
          "data_obito": "03/03/2015",
          "documento": "111.444.777-35",
          "genero": "Masculino",
          "grau": "Pai",
          "nome": "PAI DE TESTE",
          "obito": true
        },
        {
          "data_nascimento": "04/04/1955",
          "data_obito": null,
          "documento": "529.982.247-25",
          "genero": "Feminino",
          "grau": "Mãe",
          "nome": "MAE DE TESTE",
          "obito": false
        }
      ],
      "pdf": "(link do PDF da consulta)",
      "pessoa": {
        "data_nascimento": "01/01/1980",
        "data_obito": null,
        "documento": "404.428.201-35",
        "genero": "Masculino",
        "nome": "FULANO DE TESTE",
        "obito": false,
        "pep": true
      },
      "resumo": {
        "alertas": [
          "pessoa exposta politicamente",
          "sociedade baixada"
        ],
        "obito": false,
        "pep": true,
        "sociedades_ativas": 1,
        "total_parentes": 2,
        "total_sociedades": 2
      },
      "situacao": "localizado",
      "sociedades": [
        {
          "baixada": false,
          "cnpj": "11.222.333/0001-81",
          "data_abertura": "05/05/2010",
          "data_baixa": null,
          "nome_fantasia": "EMPRESA TESTE",
          "razao_social": "EMPRESA TESTE LTDA",
          "socios": [
            {
              "baixada": null,
              "data_abertura": null,
              "data_baixa": null,
              "data_nascimento": "01/01/1980",
              "data_obito": null,
              "documento": "404.428.201-35",
              "genero": "Masculino",
              "nome": "FULANO DE TESTE",
              "obito": false,
              "qualificacao": "Sócio-Administrador",
              "tipo_pessoa": "fisica"
            },
            {
              "baixada": false,
              "data_abertura": "06/06/2005",
              "data_baixa": null,
              "data_nascimento": null,
              "data_obito": null,
              "documento": "11.222.333/0002-62",
              "genero": null,
              "nome": "HOLDING TESTE S.A.",
              "obito": null,
              "qualificacao": "Sócio",
              "tipo_pessoa": "juridica"
            }
          ]
        },
        {
          "baixada": true,
          "cnpj": "11.222.333/0003-43",
          "data_abertura": "07/07/2000",
          "data_baixa": "08/08/2012",
          "nome_fantasia": null,
          "razao_social": "COMERCIO TESTE ME",
          "socios": []
        }
      ]
    }
  }
}
```

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/279f71e5-2af1-424f-80d5-069e445e4c4c/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/279f71e5-2af1-424f-80d5-069e445e4c4c
