---
title: "APIs: API da plataforma"
description: "API da plataforma APIBrasil (Gerenciamento de APIs). Os endpoints abaixo são os da conta e da operação do gateway."
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/plataforma/apis
markdown: https://doc.apibrasil.io/apis/plataforma/apis.md
source: apibrasil-documentation
---

# APIs: API da plataforma

> API da plataforma APIBrasil (Gerenciamento de APIs). Os endpoints abaixo são os da conta e da operação do gateway.

- **Especificação OpenAPI:** https://doc.apibrasil.io/apis/plataforma/apis/openapi.json

## Como chamar

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

## Endpoints (4 endpoints)

**Sumário**

1. `GET /apis`
2. `GET /apis/list`
3. `GET /apis/list`
4. `POST /apis`

### 1. GET /apis

Com esse endpoint é possivel obter a lista de todas as API's

- **Método:** `GET`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/apis`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X GET "https://gateway.apibrasil.io/api/v2/apis" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "message": "Lista de apis",
  "apis": [
    {
      "type": "generic",
      "secretkey": "7569badc-18b3-4702-bb3c-8d134faf807c",
      "name": "API Placa FIPE",
      "limit": 10000,
      "limit_for": "request",
      "value": 0.008,
      "description": "Com essa API é possível chegar ao valor FIPE de um veiculo",
      "version": "v2"
    },
    {
      "type": "generic",
      "secretkey": "d119c8e7-c0b4-4ff3-8f57-c5745ea7844d",
      "name": "API Correios ",
      "limit": 10000,
      "limit_for": "request",
      "value": 0.008,
      "description": "Com essa API Correios é possível obter informações de encomendas, CEP e muito mais",
      "version": "v2"
    },
    {
      "type": "whatsapp",
      "secretkey": "747bc316-1bbf-4e5e-9e88-f5c78e1425a7",
      "name": "API WhatsApp Wpp",
      "limit": 15,
      "limit_for": "device",
      "value": 12.9,
      "description": "Com essa API do WhatsApp, você pode enviar e receber mensagens via Rest, é possível integrar com Webhook",
      "version": "v2"
    },
    {
      "type": "generic",
      "secretkey": "52963d98-abc3-4723-a84c-9cf53e358792",
      "name": "API Geolocation Business",
      "limit": 10000,
      "limit_for": "request",
      "value": 0.08,
      "description": "Com essa API de geolocalização é possível obter os dados de localização com as coordenadas geográficas",
      "version": "v2"
    }
  ]
}
```

### 2. GET /apis/list

Com esse endpoint é possivel obter a lista de todas as API's do seu plano

- **Método:** `GET`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/apis/list`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X GET "https://gateway.apibrasil.io/api/v2/apis/list" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "error": false,
  "message": "APIs do usuario listadas com sucesso.",
  "apis": [
    {
      "name": "API WhatsApp Baileys",
      "type": "baileys",
      "version": "0.0.1",
      "service_name": "whatsapp-baileys",
      "description": "Com essa API do WhatsApp, você pode enviar e receber mensagens via Rest, é possível integrar com Webhook, ideal para conexões a longo prazototal de 2 valor unitário de R$ 9.9 45.6",
      "value": 9.9,
      "limit": 2,
      "limit_cicle": "month",
      "limit_for": "device",
      "icon": null,
      "documentation_1": null,
      "documentation_2": null,
      "search": "07c079b4-e4d4-43d4-a904-35cc302957a8",
      "home_disponible": "active",
      "status": "active",
      "created_at": "2025-11-04T02:09:28.000000Z",
      "updated_at": "2025-11-04T02:09:28.000000Z",
      "deleted_at": null,
      "is_oficial": 0,
      "pj_is_required": 0
    },
    {
      "name": "API WhatsApp Wpp",
      "type": "whatsapp",
      "version": "1.0.59",
      "service_name": "whatsapp-wpp",
      "description": "Com essa API do WhatsApp, você pode enviar e receber mensagens via Rest, é possível integrar com Webhook, ideal para disparos em massatotal de 2 valor unitário de R$ 12.9 25.8",
      "value": 12.9,
      "limit": 2,
      "limit_cicle": "month",
      "limit_for": "device",
      "icon": null,
      "documentation_1": null,
      "documentation_2": null,
      "search": "4c486fe2-36aa-4787-8ec8-12768e1bfb4e",
      "home_disponible": "active",
      "status": "active",
      "created_at": "2025-11-04T02:09:28.000000Z",
      "updated_at": "2025-11-04T02:09:28.000000Z",
      "deleted_at": null,
      "is_oficial": 0,
      "pj_is_required": 0
    }
  ]
}
```

### 3. GET /apis/list

Com esse endpoint é possivel obter a lista de todas as API's pelo Device Token

- **Método:** `GET`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/apis/list`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `DeviceToken` | `$APIBRASIL_DEVICE_TOKEN` |

**Em cURL**

```bash
curl -X GET "https://gateway.apibrasil.io/api/v2/apis/list" \
  -H "Content-Type: application/json" \
  -H "DeviceToken: $APIBRASIL_DEVICE_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "error": false,
  "message": "API Placa Dados encontrada.",
  "api": {
    "name": "API Placa Dados",
    "type": "generic",
    "version": "v2",
    "service_name": "placadados-pro",
    "description": "Com essa API é possível buscar informações completas de um veículo informando apenas a placa, em 92% da Base Nacional",
    "value": 0.009,
    "limit": 50000,
    "limit_cicle": "month",
    "limit_for": "request",
    "search": "b7a0667e-b6L5-4db2-baa2-c9dfcb172021",
    "status": "active",
    "server_lite": {
      "servername": "SRV01 - Data Veículos",
      "server_search": "110fe94a-eae6-497a-b351-8c35068bc310",
      "status": "active",
      "host_public": "https://gateway.apibrasil.io/api/v2"
    }
  }
}
```

### 4. POST /apis

Com esse endpoint é possivel detalhes de uma determinada api pelo search, o respectivo id da api internamente

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/apis`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Corpo da requisição**

```json
{
  "search": "abc-1234-abc124"
}
```

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/apis" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN" \
  -d '{"search":"abc-1234-abc124"}'
```

**Resposta de exemplo, do catálogo**

```json
{
  "error": false,
  "message": "CPF Busca encontrada.",
  "api": {
    "search": "0caa81e4-abc12345-4661-a0d5-abc12345",
    "service_name": "cpf-search",
    "type": "cpf",
    "limit_cicle": "month",
    "secretkey": "abc12345-9c22-4661-a0d5-abc12345",
    "value": 1.6,
    "limit": 990000,
    "limit_for": "request",
    "limit_end": "1970-01-11T03:00:00.000000Z",
    "new": "yes",
    "mode": "credit",
    "name": "CPF Busca",
    "version": "0.0.1",
    "description": "API CPF Search – Enriquecimento Completo de Pessoa Física\n\nA API CPF Search retorna um panorama completo de uma pessoa física a partir do CPF, incluindo dados cadastrais, contato, óbito, perfil socioeconômico, vínculos empregatícios, parentesco e possíveis colegas de trabalho.\n\nIdeal para KYC, análise de crédito, fraude, score interno, onboarding e cadastro único.\n\nEsta consulta é feita em modo produção (\"homolog\": false), retornando dados reais conforme integrações contratadas.",
    "tags": null,
    "is_oficial": 0,
    "pj_is_required": 1,
    "production": true,
    "deprecated": false,
    "in_promotion": false,
    "integration_difficulty": "simple",
    "status": "active",
    "created_at": "2025-10-17T15:58:41.000000Z",
    "updated_at": "2025-11-05T16:35:28.000000Z",
    "categories": {
      "id": "f9f4f530-8e1a-44f9-99a9-a88f1776177",
      "name": "Busca & Cobrança",
      "description": null,
      "order": 6,
      "tags": null,
      "sub_categories": []
    }
  },
  "documentations": {
    "name": "Dados Cadastrais Plano",
    "description": "A API de CPF Completo permite realizar a validação e o enriquecimento de dados cadastrais a partir do CPF, sendo indicada para processos de prevenção à fraude, análise de risco e verificação de identidade. A consulta retorna informações estruturadas que auxiliam na confirmação da legitimidade de um cadastro e na identificação de possíveis inconsistências.\n\nOs dados disponibilizados são utilizados para validar a coerência das informações fornecidas pelo próprio usuário, apoiar mecanismos de antifraude e reforçar processos de KYC e compliance, sempre com foco em segurança e integridade das operações. A API possibilita a detecção de padrões suspeitos, reduzindo tentativas de fraude em cadastros, transações financeiras e acessos indevidos.\n\nEssa solução é adequada para uso em fluxos de onboarding digital, validação de clientes e proteção contra fraudes, devendo ser utilizada em conformidade com a LGPD, exclusivamente para finalidades legítimas, com base legal adequada e respeito aos princípios de necessidade, finalidade e minimização de dados.",
    "url": null,
    "author": "Jonathan",
    "status": "active",
    "endpoints": [
      {
        "method": "POST",
        "endpoint": null,
        "action": "cpf",
        "use_value": null,
        "operation": null,
        "description": "Apresenta informações cadastrais completas de uma pessoa física a partir do número do CPF, incluindo dados como nome, data de nascimento, nome da mãe e situação cadastral.",
        "url": "https://gateway.apibrasil.io/api/v2/dados/cpf",
        "status": "active",
        "parameters": null,
        "version": "v2/",
        "header": "{ \r\n    \"Content-Type': 'application/json\", \r\n    \"DeviceToken': '73b76b21-1790-4936-ad9d.....\", \r\n    \"Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.e......\"\r\n  }",
        "body": {
          "cpf": "63166223096"
        },
        "order_list": 1,
        "responses": {
          "error": false,
          "message": "Requisição processada com sucesso",
          "balance": "13497,84",
          "response": {
            "code": "000",
            "message": "Pesquisa feita com sucesso",
            "date": "2024-07-25",
            "hour": "13:33:29",
            "revision": "Tempo de execução: 0.355 segundos",
            "server": "02APIBRASIL",
            "content": {}
          },
          "tax": "0.19",
          "api_limit_for": "credit"
        }
      }
    ]
  }
}
```

## Ver também

- Especificação OpenAPI: https://doc.apibrasil.io/apis/plataforma/apis/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/plataforma/apis