Introdução

Este documento fornecerá instruções para rápida integração aos serviços da CPF.CNPJ via HTTP (HTTP API).

Qualquer linguagem de programação pode ser utilizada.

Regras de Uso

Para que possamos combater qualquer tipo de bot que venha prejudicar a performance da API, definimos limitações de uso:

  • 3 Consultas consecutivas com o Token inválido: Bloqueio por 5 minutos;
  • 3 Consultas consecutivas do mesmo CPF/CNPJ no mesmo pacote em menos de 1 minuto: Bloqueio por 3 minutos;

URL Base

As requisições GET são feitas em uma URL base. Por questões de segurança, recomendamos o uso sob protocolo HTTPS.

URL: https://api.cpfcnpj.com.br

Content-Type

O retorno de dados da API será via JSON.

Content-Type: application/json.

Tokens

Para realizar consultas, será necessário cadastrar o IP do servidor que as farão. Para isso, acesse a opção API > Tokens em seu Painel de Controle. Após o cadastro, seu token será gerado para que seja inserido na URL da requisição.

IDs dos Pacotes

Em cada requisição, será necessário informar na URL o ID do Pacote desejado, aqui nomeado de {pacote}.

ID
Pacote Dados Retornados Custo por Consulta
1 CPF A
  • Nome Completo
R$0,07
7 CPF B
  • Nome Completo
  • Data de Nascimento
R$0,12
2 CPF C
  • Nome Completo
  • Data de Nascimento
  • Nome Completo da Mãe
  • Gênero
R$0,15
8 CPF D
  • Nome Completo
  • Data de Nascimento
  • Situação Cadastral na Receita Federal
R$0,25
9 CPF E
  • Nome Completo
  • Nome Completo da Mãe
  • Data de Nascimento
  • Gênero
  • Situação Cadastral na Receita Federal
R$0,35
3 CPF F
  • Nome Completo
  • Data de Nascimento
  • Gênero
  • Endereço Completo
R$1,00
4 CNPJ A
  • Razão Social
R$0,12
5 CNPJ B
  • Razão Social
  • Nome Fantasia
  • Endereço Completo
R$0,22
10 CNPJ C
  • Razão Social
  • Nome Fantasia
  • Endereço Completo
  • Início das Atividades
  • Telefones
  • Faxes
  • E-mail
  • Situação Cadastral na Receita Federal
R$0,30
6 CNPJ D
  • Razão Social
  • Nome Fantasia
  • Endereço Completo
  • Início das Atividades
  • Telefones
  • Faxes
  • E-mail
  • Código e Descrição da Atividade Econômica Principal
  • Código e Descrição da Natureza Jurídica
  • Nome do Responsável pela Empresa
  • Porte da Empresa
  • Quadro de Sócios e Administradores (QSA)
  • Situação Cadastral na Receita Federal
  • Informações sobre Simples Nacional
R$0,40
11 CNPJ F
  • Razão Social
  • Informações sobre Simples Nacional
  • Informações sobre SIMEI
R$0,50

Realizando Consultas

Em poucas etapas, explicaremos como a consulta é feita pela API da CPF.CNPJ.

Após gerar o token, conforme Introdução, será necessário montar a URL da requisição.

Definição

Endpoint que conterá o Token, ID do Pacote e número do CPF ou CNPJ a ser consultado, respectivamente.

URL: https://api.cpfcnpj.com.br/{token}/{pacote}/{cpfcnpj}

Parâmetros da Requisição

Parâmetro Tipo Descrição Obrigatório?
token string Código do token gerado no Painel de Controle.
pacote int ID do pacote a ser utilizado, conforme tabela.
cpfcnpj string Número do CPF com 11 dígitos ou CNPJ com 14 dígitos.

Exemplos de URL:

Consultar CPF no pacote CPF E: https://api.cpfcnpj.com.br/5ae973d7a997af13f0aaf2bf60e65803/9/45317828791

Consultar CNPJ no pacote CNPJ D: https://api.cpfcnpj.com.br/5ae973d7a997af13f0aaf2bf60e65803/6/27272134000118/0

Parâmetros das Respostas

Confira abaixo os campos retornados para CPFs e CNPJs.

Respostas CPFs

Matriz principal da resposta que varia de acordo com o pacote:

Parâmetro Tipo Descrição
status bool 1 para sucesso na requisição e 0 para falha na requisição. Caso retorne 0, consulte a tabela de erros.
cpf string Número formatado do CPF consultado com 14 dígitos.
nome string Nome completo do titular.
nascimento string Data de nascimento do titular no formato DD/MM/AAAA.
mae string Nome completo da mãe do titular.
genero string M para Masculino;
F para Feminino.
situacao string Situação cadastral na Receita Federal:
Regular, Cancelada, Suspensa, Pendente ou Nula
pacoteUsado int ID do pacote usado.
saldo int Saldo do pacote usado após consulta.
consultaID string ID da consulta com 16 dígitos.
delay float Tempo levado para realizar a consulta em segundos.

Respostas CNPJs

Matriz principal da resposta que varia de acordo com o pacote:

Parâmetro Tipo Descrição
status bool 1 para sucesso na requisição e 0 para falha na requisição. Caso retorne 0, consulte a tabela de erros.
cnpj string Número formatado do CNPJ consultado com 18 dígitos.
razao string Nome da razão social da empresa.
fantasia string Nome fantasia da empresa.
inicioAtividade string Data de início das atividades no formato DD/MM/AAAA.
email string Endereço de e-mail no cadastro da empresa.
responsavel string Nome do responsável legal pela empresa.
simplesNacional simplesNacional[] Matriz contendo possíveis informações de Simples Nacional.
matrizEndereco matrizEndereco[] Matriz de objetos do endereço.
matrizfilial matrizfilial[] Matriz de objetos do órgão competente.
telefones telefones[] Matriz de objetos contendo o(s) telefone(s) da empresa. No máximo 2 telefones.
fax fax[] Matriz de objetos contendo o(s) fax(es) da empresa.
situacao situacao[] Matriz de objetos contendo dados da situação cadastral da empresa na Receita Federal.
naturezaJuridica naturezaJuridica[] Matriz de objetos contendo dados da natureza jurídica.
cnae cnae[] Matriz de objetos contendo dados do CNAE principal.
porte porte[] Matriz de objetos contendo dados do porte da empresa.
socios socios[] Matriz de objetos contendo dados do(s) sócio(s), QSA.
pacoteUsado int ID do pacote usado.
saldo int Saldo do pacote usado após consulta.
consultaID string ID da consulta com 16 dígitos.
delay float Tempo levado para realizar a consulta em segundos.
Matriz simplesNacional

Matriz simplesNacional[] contendo informações sobre possível optante pelo Simples Nacional:

Parâmetro Tipo Descrição
optante string Sim ou Não atualmente.
inicio string Data de início como Simples Nacional no formato DD/MM/AAAA
fim string Data de fim como Simples Nacional no formato DD/MM/AAAA
Matriz matrizEndereco

Matriz matrizEndereco[] contendo informações sobre o endereço:

Parâmetro Tipo Descrição
cep string CEP do endereço com 9 dígitos.
tipo string Tipo de endereço, sendo:

Aeroporto
Avenida
Caminho
Colonia
Esplanada
Estrada
Fazenda
Ladeira
Loteamento
Passarela
Quadra
Rua
Sitio
Vale
Vereda
Via
logradouro string Endereço da empresa.
numero string Número no endereço da empresa.
complemento string Complemento do endereço.
bairro string Bairro do endereço.
cidade string Cidade do endereço.
uf string Unidade da Federação do endereço com 2 letras.
Matriz matrizfilial

Matriz matrizfilial[] contendo informações sobre o órgão competente sendo ID e Tipo, respectivamente:

Parâmetro Tipo Descrição
id int ID do órgão
tipo string Órgão:

id 1: Matriz
id 2: Filial
Matriz telefones

Matriz telefones[] contendo no mínimo 1 telefone da empresa:

Parâmetro Tipo Descrição
ddd string Número de DDD do telefone
numero string Número de telefone
Matriz fax

Matriz fax[] contendo possíveis números de fax da empresa:

Parâmetro Tipo Descrição
ddd string Número de DDD do fax
numero string Número de fax
Matriz situacao

Matriz situacao[] contendo dados da situação cadastral da empresa na Receita Federal:

Parâmetro Tipo Descrição
id int ID da situação cadastral.
nome string Nome da situação cadastral, sendo:

id 1: Baixada
id 2: Ativa
id 3: Suspensa
id 4: Inapta
id 8: Baixada
data string Data da situação cadastral no formato DD/MM/AAAA.
motivoId int ID do motivo da situação cadastral
motivo string Motivo da situação cadastral, sendo:

motivoId 0: Sem Motivo
Matriz naturezaJuridica

Matriz naturezaJuridica[] contendo dados da natureza jurídica.
Clique AQUI para acessar a lista oficial de códigos e descrições.

Parâmetro Tipo Descrição
codigo string Código da natureza jurídica com 4 dígitos sem hífen.
descricao string Descrição da natureza jurídica.
Matriz cnae

Matriz cnae[] contendo dados do CNAE principal da empresa.
Clique AQUI para acessar a tabela de códigos e descrições.

Parâmetro Tipo Descrição
divisao string Código da divisão.
grupo string Código do grupo.
classe string Código da classe.
subClasse string Código da sub classe.
fiscal string Código completo do CNAE, somente números.
descricao string Descrição do CNAE.
Matriz porte

Matriz porte[] contendo dados do porte da empresa.

Parâmetro Tipo Descrição
id string ID do porte.
descricao string Descrição do porte da empresa, sendo:

id 0: Demais
id 1: Matriz
id 3: Demais
id 5: Demais
Matriz socios

Matriz socios[] contendo dados do QSA da empresa.

Parâmetro Tipo Descrição
nome string Nome do sócio PF ou PJ.
cnpj string Número do CNPJ formatado caso seja um sócio PJ.
tipo string Tipo de sócio.
capitalSocial float Porcentagem de capital social do sócio na empresa.
pais string País de origem do sócio.

Consultando Saldos

Sem custos, consulte o saldo do pacote desejado.

Definição

Endpoint que conterá o Token e ID do Pacote a ser consultado, respectivamente.

URL: https://api.cpfcnpj.com.br/{token}/saldo/{pacote}

Parâmetros da Requisição

Parâmetro Tipo Descrição Obrigatório?
token string Código do token gerado no Painel de Controle.
pacote int ID do pacote a ser utilizado, conforme tabela.

Códigos de Erro

Confira abaixo todos os tipos de erros retornados no parâmetro erro e erroCodigo:

erroCodigo
Valor erro Descrição
100
CPF CPF inválido! Número digitado não é um CPF válido.
101
CPF Informe um CPF com 11 dígitos! CPF informado possui menos de 11 dígitos.
102
CPF O CPF informado não existe nas bases de dados da Receita Federal! Por favor, confira o número do CPF e tente novamente. O CPF é válido, porém não pertence a nenhuma pessoa. Em alguns casos, o CPF é válido, existente na Receita Federal mas ainda não propagou na API conforme prazo estipulado nos termos de uso.
200
CNPJ CNPJ inválido! Número digitado não é um CNPJ válido.
201
CNPJ Informe um CNPJ com 14 dígitos! CNPJ informado possui menos de 14 dígitos.
202
CNPJ O CNPJ informado não existe nas bases de dados da Receita Federal! Por favor, confira o número do CNPJ e tente novamente. O CNPJ é válido, porém não pertence a nenhuma empresa. Em alguns casos, o CNPJ é válido, existente na Receita Federal mas ainda não propagou na API conforme prazo estipulado nos termos de uso.
1000
CPF/CNPJ Token inválido! (...) O token informado não pertence ao IP que está realizando a consulta.
1001
CPF/CNPJ Créditos insuficientes! Você não possui créditos no pacote informado, para realizar consultas.
1002
CPF/CNPJ Conta suspensa e/ou inativa! Entre em contato conosco para verificar o motivo.
1003
CPF/CNPJ Blacklist até *DATA* IP e Token suspenso temporariamente por descumprir uma das Regras de Uso.
1004
CPF/CNPJ Pacote indisponível para consultas! O ID do pacote informado é inválido ou não está disponível para consultas.
1005
CPF/CNPJ Não é possível consultar *CPF/CNPJ* neste pacote! Falha ao processar solicitação com o fornecedor ou erro interno. Verifique com o suporte.
1006
CPF/CNPJ Supplier 2 offline. Contact us! Fornecedor de dados off-line ou enfrentando instabilidades. Tente novamente ou entre em contato conosco.