Use o cupom FACIL5 e ganhe 5% de desconto!

Documentação Lobby

Guia completo de integração com WhatsApp

Começando

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

Criar uma conta na plataforma
Obter suas credenciais de API
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

Importante:

As consultas de CPF consome crédito. A consulta COMPLETA tem custos diferentes conforme a tabela de preços.

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.

API Receita

Consulta dados cadastrais do CPF diretamente na Receita Federal. Ideal para validação de identidade e conferência de situação cadastral.

POST /api/v1/receita/cpf

Parâmetros

Nome	Tipo	Obrigatório	Descrição
documento	string	Sim	CPF a ser consultado (somente números)
data_nascimento	string (dd/mm/aaaa)	Sim	Data de nascimento do titular do CPF

Exemplo de Requisição

{
    "documento": "12345678909",
    "data_nascimento": "01/01/1980"
}

Exemplo de cURL

curl -X POST \
  https://apifacil.dev/api/v1/receita/cpf \
  -H "Authorization: SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "documento": "12345678909",
    "data_nascimento": "01/01/1980"
}'

Exemplo de Resposta

{
    "cpf": "12345678909",
    "nome_completo": "João da Silva",
    "nome_social": null,
    "data_nascimento": "1980-01-01",
    "situacao_cadastral": "REGULAR",
    "data_inscricao": "2000-05-10",
    "data_inscricao_anterior_1990": false,
    "digito_verificador": "09",
    "data_emissao": "2022-01-01",
    "codigo_controle_comprovante": "ABC123456",
    "data_consulta": "2025-05-14",
    "possui_obito": false,
    "ano_obito": null
}

API Negativado

Consulta detalhada de pendências financeiras, protestos, ações judiciais, recuperações judiciais/falência e cheques sem fundo vinculados ao CPF.

POST /api/v1/negativado/cpf

Parâmetros

Nome	Tipo	Obrigatório	Descrição
documento	string	Sim	CPF a ser consultado (somente números)

Exemplo de Requisição

{
    "documento": "12345678909"
}

Exemplo de cURL

curl -X POST \
  https://apifacil.dev/api/v1/negativado/cpf \
  -H "Authorization: SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "documento": "12345678909"
}'

Exemplo de Resposta

{
    "data": {
        "status": "Não Consta Pendência",
        "total_pendencia": 2,
        "protestos": [
            {
                "situacao": "Ativo",
                "valor_total": 500.00,
                "cartorios": [
                    {
                        "codigo_cidade": "1234",
                        "codigo_cartorio": "5678",
                        "nome": "Cartório Central",
                        "telefone": "(11) 1234-5678",
                        "endereco": "Rua Exemplo, 100",
                        "cidade": "São Paulo",
                        "quantidade_protestos": 2,
                        "valor_protestado": 500.00
                    }
                ],
                "observacao": "Observação sobre o protesto"
            }
        ],
        "acoes_judiciais": [
            {
                "numero_processo_principal": "0001234-56.2020.8.26.0000",
                "numero_processo_antigo": "123456789",
                "comarca": "São Paulo",
                "forum": "Central",
                "vara": "1ª Vara",
                "parte_acusada": "João da Silva",
                "data_ajuizamento": "2021-01-10",
                "tipo_processo": "Cível",
                "status": "Em andamento",
                "valor": 1000.75,
                "autor_processo": "Banco XYZ",
                "cidade": "São Paulo",
                "tipo_tribunal": "TJSP",
                "documento": "12345678909"
            }
        ],
        "recuperacoes_judiciais_falencia": [
            {
                "documento": "12345678909",
                "nome_empresa": "Empresa ABC Ltda",
                "motivo": "Recuperação Judicial",
                "valor": 50000.00,
                "numero_contrato": "CON123456",
                "tipo_participacao": "Devedor",
                "status": "Ativo",
                "data_ocorrencia": "2022-03-15",
                "data_inclusao": "2022-03-16",
                "data_modificacao": "2022-03-20",
                "endereco": {
                    "logradouro": "Rua das Flores",
                    "numero": "123",
                    "complemento": "Sala 101",
                    "bairro": "Centro",
                    "cidade": "São Paulo",
                    "uf": "SP",
                    "cep": "01234567"
                }
            }
        ],
        "cheques_sem_fundo": [
            {
                "tipo_pessoa": "F",
                "documento": "12345678909",
                "codigo_banco": "341",
                "nome_agencia": "Agência Centro",
                "numero_agencia": "1234",
                "data_ultima_ocorrencia": "2022-01-15",
                "quantidade_ocorrencia": 3
            }
        ]
    }
}

Observação: A API retorna apenas os campos que possuem dados válidos. Campos nulos, vazios ou arrays vazios são automaticamente filtrados da resposta para otimizar o tamanho do payload.

Possíveis Respostas de Erro

401 - Não Autenticado

{
    "error": true,
    "message": "Não autenticado."
}

403 - Créditos Insuficientes

{
    "error": true,
    "message": "Você não possui créditos suficientes para realizar esta consulta."
}

422 - Dados Inválidos

{
    "message": "The given data was invalid.",
    "errors": {
        "documento": ["O campo documento é obrigatório."]
    }
}

500 - Erro Interno

{
    "error": true,
    "message": "Erro ao consultar Documento"
}