Documentação Lobby

Guia completo de integração com WhatsApp

Começando

Para começar a usar nossas APIs, você precisa:

  1. Criar uma conta na plataforma
  2. Obter suas credenciais de API
  3. Incluir o token de autenticação nas requisições

URL Base da API

https://apifacil.dev/api/v1

Autenticação

Todas as requisições devem incluir o token de autenticação no header: 

Authorization: seu_token_aqui

Exemplos de Requisição

cURL

curl -X GET "https://apifacil.dev/api/v1/cep/90230060" \
     -H "Authorization: seu_token_aqui"

PHP

$token = "seu_token_aqui";
                $curl = curl_init();
                curl_setopt_array($curl, [
                CURLOPT_URL => "https://apifacil.dev/api/v1/cep/90230060",
                CURLOPT_RETURNTRANSFER => true,
                CURLOPT_HTTPHEADER => [
                "Authorization: {$token}"
                ]
                ]);
                $response = curl_exec($curl);

Mantenha seu token em segurança e nunca compartilhe com terceiros. Em caso de comprometimento, gere um novo token imediatamente no painel.

Consulta CNPJ

GET /api/v1/cnpj/{cnpj}

Consulta dados de um CNPJ

Exemplo de requisição

curl https://apifacil.dev/api/v1/cnpj/12345678000199 \
-H "Authorization: seu_token"

Exemplo de resposta

{
  "error": false,
  "data": {
    "cnpj": "12345678000199",
    "razao_social": "EMPRESA EXEMPLO LTDA",
    "nome_fantasia": "EXEMPLO COMERCIO",
    "situacao_cadastral": "ATIVA",
    "data_situacao_cadastral": "01/01/2010",
    "motivo_situacao_cadastral": "Motivo Exemplo",
    "municipio": "PORTO ALEGRE",
    "capital_social": "1000000.00",
    "contatos": {
      "telefone1": {
        "formatado": "(51) 9999-9999",
        "sem_formatacao": "5199999999"
      },
      "telefone2": "* * * * *",
      "email": "exemplo@empresa.com"
    },
    "cnae_fiscal": {
      "principal": "CNAE Principal",
      "secundarias": [
        {
          "codigo": "123456",
          "descricao": "CNAE Secundária 1"
        },
        {
          "codigo": "654321",
          "descricao": "CNAE Secundária 2"
        }
      ]
    },
    "endereco": {
      "logradouro": "RUA EXEMPLO",
      "numero": "123",
      "complemento": "SALA 1",
      "bairro": "CENTRO",
      "cep": "90230060",
      "uf": "RS",
      "municipio": "PORTO ALEGRE"
    }
  }
}

Consulta CEP

GET /api/v1/cep/{cep}

Consulta dados de um CEP

Exemplo de requisição

curl https://apifacil.dev/api/v1/cep/90230060 \
-H "Authorization: seu_token"

Exemplo de resposta

{
  "error": false,
  "data": {
    "cep": "90230060",
    "logradouro": "Avenida Exemplo",
    "bairro": "Centro",
    "cidade": "Porto Alegre",
    "estado": "RS",
    "ibge": "4314902",
    "pais": "Brasil"
  }
}

API CPF

A API de CPF permite consultar dados de pessoas físicas usando o número de CPF. Oferecemos duas modalidades de consulta: básica e completa, além de uma versão para testes sem autenticação.

Importante:

As consultas de CPF consomem tokens de crédito. A consulta básica e completa tem custos diferentes conforme a tabela de preços.

Consulta de CPF Básica

Retorna informações básicas sobre o titular do CPF, como nome completo, data de nascimento e situação cadastral.

GET v1/cpf/{cpf}/basico

Parâmetros de URL:

Nome Tipo Descrição
cpf string CPF a ser consultado (apenas números ou com formatação)

Cabeçalhos:

Nome Descrição Obrigatório
Authorization Token de autenticação (seu token pessoal) Sim

Exemplo de Requisição:

curl -X GET "https://apifacil.dev/api/v1/cpf/12345678909/basico" \
    -H "Content-Type: application/json" \
    -H "Authorization: seu_token_aqui"

Resposta de Sucesso:

{
  "data": {
    "cpf": "123.456.789-09",
    "nome_completo": "NOME DO TITULAR",
    "genero": "M",
    "data_nascimento": "01/01/1980",
    "nome_mae": "NOME DA MÃE DO TITULAR",
    "idade": 43,
    "signo": "Capricórnio",
    "renda": {
      "estimada": "2500.00",
      "faixa_salarial": "C"
    },
    "telefones": [],
    "enderecos": [],
    "emails": []
  }
}

Consulta de CPF Completa

Retorna informações detalhadas sobre o titular do CPF, incluindo telefones, endereços, e-mails e outros dados adicionais.

GET v1/cpf/{cpf}/completo

Parâmetros de URL:

Nome Tipo Descrição
cpf string CPF a ser consultado (apenas números ou com formatação)

Cabeçalhos:

Nome Descrição Obrigatório
Authorization Token de autenticação (seu token pessoal) Sim

Exemplo de Requisição:

curl -X GET "https://apifacil.dev/api/v1/cpf/12345678909/completo" \
    -H "Content-Type: application/json" \
    -H "Authorization: seu_token_aqui"

Resposta de Sucesso:

{
  "data": {
    "cpf": "123.456.789-09",
    "nome_completo": "NOME DO TITULAR",
    "genero": "M",
    "data_nascimento": "01/01/1980",
    "nome_mae": "NOME DA MÃE DO TITULAR",
    "nome_pai": "NOME DO PAI DO TITULAR",
    "idade": 43,
    "signo": "Capricórnio",
    "renda": {
      "estimada": "2500.00",
      "faixa_salarial": "C"
    },
    "situacao_cadastral": {
      "status": "REGULAR",
      "data": "01/01/2010"
    },
    "obito": {
      "possui_obito": false
    },
    "telefones": [
      {
        "numero": "11999999999",
        "tipo": "CELULAR",
        "operadora": "VIVO",
        "whatsapp": true,
        "telemarketing_bloqueado": false
      }
    ],
    "enderecos": [
      {
        "logradouro": "RUA EXEMPLO",
        "numero": "123",
        "complemento": "APTO 45",
        "bairro": "CENTRO",
        "cidade": "SÃO PAULO",
        "uf": "SP",
        "cep": "01234-567"
      }
    ],
    "emails": [
      "exemplo@email.com"
    ]
  }
}

Códigos de Resposta:

Código Descrição
200 Sucesso. Retorna os dados do CPF consultado.
400 Erro de validação. CPF inválido ou mal formatado.
403 Sem permissão ou créditos insuficientes para realizar a consulta.
404 CPF não encontrado.
500 Erro interno do servidor.

Observações:

  • Os dados retornados dependem da disponibilidade de informações nas bases consultadas.
  • Os campos `telefones`, `enderecos` e `emails` podem retornar arrays vazios se não houver dados disponíveis.
  • É necessário ter saldo de créditos suficiente para realizar as consultas autenticadas.