---
title: "Documentação da APIBrasil"
description: "Documentação oficial das APIs brasileiras da APIBrasil: 175 APIs no mesmo gateway e no mesmo token, mais os SDKs, os webhooks, o Socket.IO e o guia MCP. Este índice e as páginas ligadas a ele são texto puro, abertos a assistentes de IA e agentes, sem login."
lang: pt-BR
canonical: https://doc.apibrasil.io
markdown: https://doc.apibrasil.io/index.md
source: apibrasil-documentation
---

# Documentação da APIBrasil

> Documentação oficial das APIs brasileiras da APIBrasil: 175 APIs no mesmo gateway e no mesmo token, mais os SDKs, os webhooks, o Socket.IO e o guia MCP. Este índice e as páginas ligadas a ele são texto puro, abertos a assistentes de IA e agentes, sem login.

- Toda página desta documentação existe em Markdown: acrescente `.md` ao endereço da página HTML (a home é `/index.md`). Uma requisição com `Accept: text/markdown` a qualquer página recebe a mesma versão.
- O idioma sai do parâmetro `idioma` (`pt-BR`, `en` ou `es-419`) ou do cabeçalho Accept-Language. Sem os dois, português.
- Para achar uma página sem ler o índice inteiro: `/busca.md?q=termo` devolve as páginas que casam com o termo, com link e resumo.
- Cada API tem uma especificação OpenAPI 3.1 em `/openapi.json` depois do endereço da página (por exemplo `/apis/creditos/…/openapi.json`), com métodos, cabeçalhos e exemplos de corpo e resposta.
- `llms-full.txt` reúne as seções fixas num arquivo só. As páginas de API ficam fora dele por tamanho: cada uma tem o próprio endereço abaixo, com os endpoints, os corpos e as respostas de exemplo.
- Nada aqui é deduzido. O catálogo de APIs, os endpoints e a frota de servidores vêm do gateway a cada leitura; SDKs, webhooks, Socket.IO e MCP vêm do conteúdo apurado no código dos serviços.

## Comece por aqui

**Endereço base:** `https://gateway.apibrasil.io/api/v2`

**Autenticação**

- `Authorization: Bearer $APIBRASIL_TOKEN` em toda chamada. É o mesmo token para todas as APIs, emitido no painel da APIBrasil ou pela rota de login da API de autenticação da plataforma.
- `DeviceToken: $APIBRASIL_DEVICE_TOKEN` só nas APIs cobradas por plano, que são as de WhatsApp. As cobradas por consulta não pedem.

As chamadas são POST com corpo em JSON, salvo onde o endpoint declara outro método.

**Homologação:** 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.

**A primeira chamada, em cURL**

```bash
curl -X POST https://gateway.apibrasil.io/api/v2/dados/cpf \
  -H "Authorization: Bearer $APIBRASIL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cpf": "00000000000", "homolog": true}'
```

**A resposta:** Além do resultado em `data`, o corpo de sucesso traz `error` (booleano), `message`, `balance` (saldo restante), `tax` (o que a consulta custou), `valor_consulta` e `api_limit_for`. O erro pode chegar com HTTP 200: confira `error === false` antes de ler `data`.

## Catálogo de APIs (175)

O catálogo completo, com a descrição, o preço e o link de cada API, está numa página só:

- [Catálogo de APIs](https://doc.apibrasil.io/apis.md): As 175 APIs do gateway, por categoria, com a primeira frase da descrição, o preço e o link da página de cada uma.

- [Análise de Crédito (33)](https://doc.apibrasil.io/apis.md#analise-de-credito-33)
- [Segurança Veicular (29)](https://doc.apibrasil.io/apis.md#seguranca-veicular-29)
- [Análise Antifraude (20)](https://doc.apibrasil.io/apis.md#analise-antifraude-20)
- [CRLV (15)](https://doc.apibrasil.io/apis.md#crlv-15)
- [Consulta CNPJ (13)](https://doc.apibrasil.io/apis.md#consulta-cnpj-13)
- [Comunicação (11)](https://doc.apibrasil.io/apis.md#comunicacao-11)
- [Precificação Veicular (10)](https://doc.apibrasil.io/apis.md#precificacao-veicular-10)
- [Busca & Cobrança (9)](https://doc.apibrasil.io/apis.md#busca-cobranca-9)
- [Emissão de Certidões (8)](https://doc.apibrasil.io/apis.md#emissao-de-certidoes-8)
- [Consultas Assíncronas (6)](https://doc.apibrasil.io/apis.md#consultas-assincronas-6)
- [Relatórios Whitelabel (5)](https://doc.apibrasil.io/apis.md#relatorios-whitelabel-5)
- [Serviços Digitais (4)](https://doc.apibrasil.io/apis.md#servicos-digitais-4)
- [Conselhos Profissionais (3)](https://doc.apibrasil.io/apis.md#conselhos-profissionais-3)
- [Dados e Utilidades (2)](https://doc.apibrasil.io/apis.md#dados-e-utilidades-2)
- [Regularidade Fiscal (2)](https://doc.apibrasil.io/apis.md#regularidade-fiscal-2)
- [Dados Abertos (1)](https://doc.apibrasil.io/apis.md#dados-abertos-1)
- [Geolocalização e Logística (1)](https://doc.apibrasil.io/apis.md#geolocalizacao-e-logistica-1)
- [Governança & Due Diligence (1)](https://doc.apibrasil.io/apis.md#governanca-due-diligence-1)
- [Segurança Cibernética (1)](https://doc.apibrasil.io/apis.md#seguranca-cibernetica-1)
- [Serviços de Cartório (1)](https://doc.apibrasil.io/apis.md#servicos-de-cartorio-1)

## APIs da plataforma

As rotas de conta e de operação do gateway (login, dispositivos, planos, servidores), no mesmo endereço das APIs.

- [Autenticação](https://doc.apibrasil.io/apis/plataforma/autenticacao.md): Sistema de autenticação
- [Requests](https://doc.apibrasil.io/apis/plataforma/requests.md): Gerenciamento de requisições
- [Dispositivos](https://doc.apibrasil.io/apis/plataforma/dispositivos.md): Controle de dispositivos
- [APIs](https://doc.apibrasil.io/apis/plataforma/apis.md): Gerenciamento de APIs
- [Usuário](https://doc.apibrasil.io/apis/plataforma/usuario.md): Perfil do usuário
- [Servidores](https://doc.apibrasil.io/apis/plataforma/servidores.md): Infraestrutura de servidores
- [Status](https://doc.apibrasil.io/apis/plataforma/status.md): Monitoramento de status

## SDKs oficiais

- [SDKs oficiais](https://doc.apibrasil.io/sdks.md): As bibliotecas oficiais embrulham o mesmo gateway: um comando para instalar, o token no lugar certo e o catálogo inteiro de APIs.
- [C++](https://doc.apibrasil.io/sdks/cpp.md): `git clone https://github.com/APIBrasil/apigratis-sdk-cpp`
- [Python](https://doc.apibrasil.io/sdks/python.md): `pip install api-brasil`
- [Lua](https://doc.apibrasil.io/sdks/lua.md): `luarocks install apibrasil`
- [PHP](https://doc.apibrasil.io/sdks/php.md): `composer require jhowbhz/apigratis-sdk-php`
- [Java](https://doc.apibrasil.io/sdks/java.md): `mvn dependency:get -Dartifact=br.com.apibrasil:apigratis-sdk-java:0.0.1`
- [Ruby](https://doc.apibrasil.io/sdks/ruby.md): `gem install apigratis-sdk-ruby`
- [C# / .NET](https://doc.apibrasil.io/sdks/csharp.md): `dotnet add package ApiBrasil`
- [Scala](https://doc.apibrasil.io/sdks/scala.md): código público, ainda sem pacote
- [Node.js / TypeScript](https://doc.apibrasil.io/sdks/javascript.md): `npm install apigratis-sdk-nodejs`
- [Go](https://doc.apibrasil.io/sdks/go.md): `go get github.com/APIBrasil/apigratis-sdk-go`
- [Rust](https://doc.apibrasil.io/sdks/rust.md): `cargo add apibrasil`
- [Dart / Flutter](https://doc.apibrasil.io/sdks/flutter.md): `flutter pub add apigratis_sdk_flutter`
- [Elixir](https://doc.apibrasil.io/sdks/elixir.md): `mix deps.get  # com {:apibrasil, "~> 0.0.1"} no mix.exs`

Anunciadas, ainda sem código público: Erlang, Haskell, Delphi, F#, Clojure, Nim, Kotlin, Crystal, Zig. Para essas linguagens a saída é a API por HTTP, abaixo.

## Webhooks

- [Webhooks](https://doc.apibrasil.io/webhooks.md): O índice dos canais e o envio assíncrono, com as rotas que terminam em `/queue`.
- [Webhook de SMS](https://doc.apibrasil.io/webhooks/api-sms.md): Avisos do percurso de cada mensagem — e, quando alguém responde, o texto da resposta.
- [Webhook de WhatsApp Wpp](https://doc.apibrasil.io/webhooks/api-whatsapp-wpp.md): Mensagens que chegam e que saem, confirmação de leitura, chamadas, e o ciclo de vida da sessão.
- [Webhook de WhatsApp Baileys](https://doc.apibrasil.io/webhooks/api-whatsapp-baileys.md): Mensagens, confirmações de leitura, contatos e o ciclo da conexão — num envelope que não diz qual evento é.
- [Webhook de WhatsApp WhatsMeow](https://doc.apibrasil.io/webhooks/api-whatsapp-whatsmeow.md): Mensagens, recibos de leitura, chamadas, grupos e conexão — com o nome do evento vindo junto, e um filtro para escolher o que chega.

## Socket.IO

- [Socket.IO](https://doc.apibrasil.io/socket-io.md): A conexão, os quadros que chegam, o envio pela mesma conexão e as armadilhas do serviço.
- [Socket.IO: Servidor](https://doc.apibrasil.io/socket-io/server.md): O evento `server` existe no serviço, mas nenhum produtor foi encontrado nos repositórios — ele não dispara hoje.
- [Socket.IO: Plataforma](https://doc.apibrasil.io/socket-io/platform.md): As notificações da sua conta em tempo real: saldo, planos, faturas, dispositivos, login e tickets.
- [Socket.IO: Enviar texto (WPP)](https://doc.apibrasil.io/socket-io/send-text-wpp.md): Disparar mensagem de texto pelo motor WPP sem abrir uma requisição HTTP por envio.
- [Socket.IO: Enviar arquivos (WPP)](https://doc.apibrasil.io/socket-io/send-files-wpp.md): Enviar mídia ou documento por URL pública, pelo motor WPP.
- [Socket.IO: Enviar texto (Baileys)](https://doc.apibrasil.io/socket-io/send-text-baileys.md): Disparar mensagem de texto pelo motor Baileys, com controle de presença e atraso.
- [Socket.IO: Enviar arquivos (Base64)](https://doc.apibrasil.io/socket-io/send-files-base64.md): Enviar arquivo sem URL pública, embutido em Base64 no próprio corpo — útil para conteúdo gerado na hora.
- [Socket.IO: Todos os dispositivos](https://doc.apibrasil.io/socket-io/all-devices.md): Acompanhar TODOS os dispositivos do seu Profile ID numa conexão só.
- [Socket.IO: Dispositivo único](https://doc.apibrasil.io/socket-io/unique-device.md): Receber apenas os eventos de UM dispositivo.

## Guia MCP (10, 6 MCP)

- [Guia MCP](https://doc.apibrasil.io/mcp.md): O servidor MCP, os guias por ferramenta e a comparação com o gateway REST.
- [IDEs e Editores](https://doc.apibrasil.io/mcp/ide-editores.md): Integre o servidor MCP ao seu editor de código favorito para acessar as APIs brasileiras enquanto programa
  - [Cursor IDE](https://doc.apibrasil.io/mcp/ide-editores/cursor.md): IDE de IA com suporte nativo ao MCP (conecta ao servidor MCP)
  - [Visual Studio Code](https://doc.apibrasil.io/mcp/ide-editores/vscode.md): Editor mais popular do mundo, com MCP por extensão (conecta ao servidor MCP)
  - [Zed Editor](https://doc.apibrasil.io/mcp/ide-editores/zed.md): Editor de código ultrarrápido com suporte nativo a MCP (conecta ao servidor MCP)
- [Chatbots](https://doc.apibrasil.io/mcp/chatbots.md): Construa chatbots inteligentes com acesso a dados brasileiros em tempo real
  - [Dify.ai](https://doc.apibrasil.io/mcp/chatbots/dify.md): Plataforma de LLMOps para construir aplicações de IA (chama o gateway REST por HTTP)
  - [Typebot](https://doc.apibrasil.io/mcp/chatbots/typebot.md): Plataforma open-source para criar chatbots conversacionais (chama o gateway REST por HTTP)
- [Linguagens de Programação](https://doc.apibrasil.io/mcp/programacao.md): Exemplos de código em várias linguagens para integrar pelo MCP
  - [Node.js / TypeScript](https://doc.apibrasil.io/mcp/programacao/nodejs.md): SDK oficial em TypeScript, com tipagem completa (conecta ao servidor MCP)
  - [Python](https://doc.apibrasil.io/mcp/programacao/python.md): SDK oficial em Python, com asyncio para aplicações modernas (conecta ao servidor MCP)
- [Clientes de IA](https://doc.apibrasil.io/mcp/clientes-ai.md): Conecte assistentes de IA como Claude Desktop e ChatGPT diretamente às APIs da APIBrasil
  - [Claude Desktop](https://doc.apibrasil.io/mcp/clientes-ai/claude-desktop.md): Assistente de IA da Anthropic, com suporte nativo a MCP (conecta ao servidor MCP)
- [Automação](https://doc.apibrasil.io/mcp/automacao.md): Automatize fluxos de trabalho com ferramentas low-code e no-code usando MCP
  - [n8n](https://doc.apibrasil.io/mcp/automacao/n8n.md): Plataforma de automação de fluxos, open-source (chama o gateway REST por HTTP)
- [Plataformas Cloud](https://doc.apibrasil.io/mcp/plataformas-cloud.md): Publique e integre com serviços cloud como AWS, Azure, Vercel e Cloudflare
  - [Vercel](https://doc.apibrasil.io/mcp/plataformas-cloud/vercel.md): Plataforma de deploy para Next.js e serverless (chama o gateway REST por HTTP)

## Servidores

- [Servidores](https://doc.apibrasil.io/servidores.md): A frota que atende o gateway, com o estado de cada servidor no minuto da leitura.

## Opcional

- [llms-full.txt](https://doc.apibrasil.io/llms-full.txt): As seções fixas desta documentação num arquivo só, para carregar de uma vez.
- [Busca na documentação](https://doc.apibrasil.io/busca.md?q=cpf): A busca cobre nome, descrição e categoria das APIs, os SDKs, os canais de webhook, os destinos do Socket.IO e os guias MCP. Não diferencia acento nem maiúsculas.
- [Versão HTML desta página](https://doc.apibrasil.io): A mesma documentação para pessoas, com simulador de requisições. Exige login.