Sobre
API para consulta da síntese cadastral e dados de CPF e CNPJ na Receita Federal, sem a necessidade de informar data de nascimento ou captchas. Com resposta inferior a 1 segundo, automatize sistemas e aumente a integridade do seu banco de dados com informações completas e seguras.
Saiba mais em: www.cpfcnpj.com.br
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.
Atenção!
Antes de prosseguir, será necessário ter um cadastro ativo em nosso sistema.
Caso não tenha, cadastre-se agora mesmo!
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;
- 3 Consultas consecutivas sem créditos em menos de 1 minuto: Bloqueio por 5 minutos;
URL Base
As requisições GET são feitas em uma URL base sob protocolo HTTPS.
URL: https://api.cpfcnpj.com.br/
Atenção!
Todas as requisições passam pela CloudFlare antes de chegar aos nossos servidores.
Versão de TLS mínima aceitável: 1.2
Firewall
Certifique-se de conceder permissões em seu firewall para os IPs da CloudFlare.
Acesse a lista de IPs para liberação: https://www.cloudflare.com/pt-br/ips/
Content-Type
O retorno de dados da API será via JSON
.
application/json
.
Timeout
Use o timeout padrão de 60 segundos. Caso utilize um valor inferior, em uma instabilidade da API poderá ocorrer de sua requisição ser abortada antes de receber a resposta, consumindo créditos.
Atualmente, a média de retorno das consultas está em 2 segundos.
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.
Token para testes de integração:
Token: 5ae973d7a997af13f0aaf2bf60e65803
ATENÇÃO! Este token retornará apenas dados fictícios para testes de integração.
IDs dos Pacotes
Em cada requisição, será necessário informar na URL o ID do Pacote desejado, aqui nomeado de {pacote}
.
Para contratar os pacotes desejados, acesse o Painel de Controle. Consulte-os em nosso site.
|
Pacote | Dados Retornados | Custo por Consulta (BRL) |
---|---|---|---|
19 | CNPJ Lookalike |
|
R$0,24 |
1 | CPF A |
|
R$0,15 |
7 | CPF B |
|
R$0,22 |
2 | CPF C |
|
R$0,25 |
8 | CPF D |
|
R$0,36 |
9 | CPF E |
|
R$0,47 |
3 | CPF F |
Disponível apenas sob vias contratuais no plano pós-pago. |
R$1,20 |
13 | CPF G |
Clique aqui e leia nosso artigo para mais informações. |
R$1,00 |
14 | CPF H |
Clique aqui e leia nosso artigo para mais informações. ¹ Caso não seja uma PPE, o retorno será |
R$0,20² |
15 | CPF I |
Lista de CNPJs em que o titular faz parte do quadro societário. |
R$0,20 |
4 | CNPJ A |
|
R$0,13 |
5 | CNPJ B |
|
R$0,24 |
10 | CNPJ C |
|
R$0,32 |
6 | CNPJ D |
|
R$0,45 |
11 | CNPJ F |
|
R$0,30 |
12 | CNPJ G |
Clique aqui e leia nosso artigo para mais informações. |
R$1,00 |
16 | CNPJ H |
|
R$0,15 |
17 | CPF J |
|
R$0,18 |
18 | CPF K |
|
R$1,40 |
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 | 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/00000000000
Consultar CNPJ no pacote CNPJ D: https://api.cpfcnpj.com.br/5ae973d7a997af13f0aaf2bf60e65803/6/27272134000118/0
Atenção!
Informando /0
no final da URL dos pacotes CPF F, CNPJ B, C e D, a API não buscará o endereço (rua, bairro, cidade e estado) na base de dados do Brasil API (brasilapi.com.br), reduzindo em média 0,8 segundos no tempo de resposta.
Parâmetros das Respostas
Confira abaixo os campos retornados para CPFs e CNPJs.
Cada pacote de consultas possui seus respectivos parâmetros de respostas. Sendo assim, integre de acordo.
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 (sem acentuação). |
nascimento | string | Data de nascimento do titular no formato DD/MM/AAAA. |
mae | string | Nome completo da mãe do titular (sem acentuação). |
genero | string | M para Masculino;F para Feminino. |
situacao | string | Situação cadastral na Receita Federal:Regular , Cancelada , Suspensa , Pendente ou Nula |
risco | risco[] | Matriz de objetos contendo o nível de probabilidade de inadimplência futura, segundo a SERASA. Clique aqui e saiba mais. |
endereco | string | Endereço residencial do titular. |
numero | string | Número no endereço. |
complemento | string | Complemento do endereço. |
bairro | string | Bairro do endereço. |
cep | string | CEP do endereço. |
cidade | string | Cidade do endereço. |
uf | string | Unidade da Federação do endereço com 2 letras. |
ppe | ppe[] | Matriz contendo lista de possíveis cargos da Pessoa Politicamente Exposta do CPF consultado no pacote CPF H. Caso não seja uma PPE, a matriz estará vazia. |
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 PPE
Matriz ppe[]
contendo lista de possíveis cargos da PPE:
Parâmetro | Tipo | Descrição |
---|---|---|
sigla | string | Sigla da função do cargo político |
funcao | string | Função do cargo político |
nivel | string | Nível de hierarquia política |
orgao | string | Órgão de atuação política |
inicioexercicio | string | Data de início do cargo no formato DD/MM/AAAA |
fimexercicio | string | Data de fim do cargo no formato DD/MM/AAAA |
fimcarencia | string | Data de fim da carência do cargo no formato DD/MM/AAAA |
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. |
string | Endereço de e-mail no cadastro da empresa. | |
responsavel | string | Nome do responsável legal pela empresa (sem acentuação). |
simplesNacional | simplesNacional[] | Matriz contendo possíveis informações de Simples Nacional. |
simei | simei[] | Matriz contendo possíveis informações de SIMEI. |
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. |
risco | risco[] | Matriz de objetos contendo o nível de probabilidade de inadimplência futura, segundo a SERASA. Clique aqui e saiba mais. |
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 simei
Matriz simei[]
contendo informações sobre possível optante pelo SIMEI:
Parâmetro | Tipo | Descrição |
---|---|---|
optante | string | Sim ou Não atualmente. |
anteriores | matriz | Matriz anteriores[] contendo a lista de registros anteriores como SEMEI. |
Matriz anteriores
Matriz anteriores[]
contendo a lista de registros anteriores como SEMEI:
Parâmetro | Tipo | Descrição |
---|---|---|
inicio | string | Data de início como SIMEI no formato DD/MM/AAAA |
fim | string | Data de fim como SIMEI no formato DD/MM/AAAA |
detalhamento | string | Descrição sobre o registro |
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, podendo ser:Aeroporto , Avenida , Caminho , Colonia , Esplanada , Estrada , Fazenda , Ladeira , Lago , Loteamento , Nao Informado , Passarela , Quadra , Recanto , 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 . |
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 (sem acentuação). |
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. |
Matriz risco
Matriz risco[]
contendo informações do score na SERASA.
Parâmetro | Tipo | Descrição |
---|---|---|
nivel | int | ID do nível. |
descricao | string | Descrição do nível de risco, sendo: nivel 0 : Desconhecido nivel 1 : Baixo nivel 2 : Médio nivel 3 : Alto nivel 4 : Altíssimo |
score | string |
Faixa de pontuação do nível de score.
CPF:
CNPJ: |
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 | Token gerado no Painel de Controle. | |
pacote | int | ID do pacote a ser utilizado, conforme tabela. |
Parâmetros da Resposta
Matriz pacote[]
contendo informações de saldo do pacote.
Parâmetro | Tipo | Descrição |
---|---|---|
id | int | ID do pacote. |
nome | string | Nome do pacote consultado. |
saldo | int | Saldo do pacote consultado. |
Códigos de Erro
Confira abaixo todos os tipos de erros retornados no parâmetro erro
e erroCodigo
:
erroCodigo |
Valor | erro |
Descrição |
---|---|---|---|
|
CPF | CPF inválido! | Número digitado não é um CPF válido. |
|
CPF | Informe um CPF com 11 dígitos! | CPF informado possui menos de 11 dígitos. |
|
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. |
|
CNPJ | CNPJ inválido! | Número digitado não é um CNPJ válido. |
|
CNPJ | Informe um CNPJ com 14 dígitos! | CNPJ informado possui menos de 14 dígitos. |
|
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. |
|
CPF/CNPJ | Token inválido! (...) | O token informado não pertence ao IP que está realizando a consulta. |
|
CPF/CNPJ | Créditos insuficientes! | Você não possui créditos no pacote informado, para realizar consultas. |
|
CPF/CNPJ | Conta suspensa e/ou inativa! | Entre em contato conosco para verificar o motivo. |
|
CPF/CNPJ | Blacklist até *DATA* | IP e Token suspenso temporariamente por descumprir uma das Regras de Uso. |
|
CPF/CNPJ | Pacote indisponível para consultas! | O ID do pacote informado é inválido ou não está disponível para consultas. |
|
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. |
|
CPF/CNPJ | Supplier 2 offline. Contact us! | Fornecedor de dados off-line ou enfrentando instabilidades. Tente novamente ou entre em contato conosco. |
|
CPF/CNPJ | Limite de requisições (20) por segundo excedido. Por favor, tente novamente. | Limite máximo de 20 consultas por segundo. |