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) |
---|---|---|---|
1 | CPF A |
|
R$0,15 |
7 | CPF B |
|
R$0,22 |
2 | CPF C |
|
R$0,25 |
8 | CPF D |
Consultas em tempo real com a Receita Federal e resposta em 1 segundo! |
R$0,36 |
9 | CPF E |
Consultas em tempo real com a Receita Federal e resposta em 1 segundo! |
R$0,47 |
3 | CPF F |
|
R$1,20 |
13 | CPF G |
Clique aqui e leia nosso artigo para mais informações. |
R$1,00 |
14 | CPF H |
Também retorna relacionados familiares. Clique aqui e leia nosso artigo para mais informações. ¹ Caso não seja uma PPE/PEP (ou relacionado), 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 |
17 | CPF J |
|
R$0,18 |
18 | CPF K |
Apenas a Situação Cadastral em tempo real, sem comprovante. |
R$1,40 |
21 | CPF Lookalike |
|
R$0,24 |
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 |
19 | CNPJ Lookalike |
Cobrança feita por cada sócio retornado. |
R$0,26 |
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
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 e 0 para falha (ver tabela de erros). |
cpf | string | Número formatado do CPF consultado com 14 dígitos. |
nome | string | Nome completo do titular (sem acentuação). |
nomeSocial | string | Nome social, conforme Decreto nº 8.727/2016. |
nascimento | string | Data de nascimento, formato DD/MM/AAAA. |
mae | string | Nome completo da mãe (sem acentuação). |
genero | string | M (Masculino) ou F (Feminino). |
situacao | string | Situação cadastral: Regular , Cancelada , Suspensa , Pendente , Nula . |
situacaoDigito | string | Código da situação (00, 02, 03, 04, 05, 08, 09). |
situacaoMotivo | string | Motivo da situação cadastral. |
situacaoAnoObito | string | Ano de óbito (DD/MM/AAAA), se houver. |
situacaoInscricao | string | Data de inscrição na Receita (DD/MM/AAAA ou texto do tipo "anterior a ..."). |
situacaoComprovante | string | Código de controle do comprovante em tempo real. |
risco | risco[] | Matriz de probabilidade de inadimplência futura (Score SERASA). |
endereco | string | Endereço residencial (logradouro). |
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 | Estado (UF) com 2 letras. |
ppe | ppe[] | Lista de cargos da PPE, se for uma Pessoa Politicamente Exposta. |
pacoteUsado | int | ID do pacote usado. |
saldo | int | Saldo do pacote após a consulta. |
consultaID | string | ID da consulta (16 dígitos). |
delay | float | Tempo total da consulta em segundos. |
Matriz PPE
Matriz ppe[]
contendo lista de cargos da PPE:
Parâmetro | Tipo | Descrição |
---|---|---|
sigla | string | Sigla do cargo político. |
funcao | string | Função do cargo. |
nivel | string | Nível de hierarquia política. |
orgao | string | Órgão de atuação. |
inicioexercicio | string | Data de início (DD/MM/AAAA). |
fimexercicio | string | Data de término do exercício (DD/MM/AAAA). |
fimcarencia | string | Data de fim de carência (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, 0 para falha (ver erros). |
cnpj | string | CNPJ formatado (18 dígitos). |
razao | string | Razão social da empresa. |
fantasia | string | Nome fantasia da empresa. |
inicioAtividade | string | Data de início das atividades (DD/MM/AAAA). |
string | E-mail de cadastro da empresa. | |
responsavel | string | Nome do responsável legal (sem acentuação). |
simplesNacional | simplesNacional[] | Dados de possível adesão ao Simples Nacional. |
simei | simei[] | Dados de possível adesão ao SIMEI. |
matrizEndereco | matrizEndereco[] | Matriz do endereço completo. |
matrizfilial | matrizfilial[] | Dados do órgão competente (matriz/filial). |
telefones | telefones[] | Telefones da empresa (até 2). |
fax | fax[] | Fax da empresa. |
situacao | situacao[] | Situação cadastral na Receita Federal. |
naturezaJuridica | naturezaJuridica[] | Dados da natureza jurídica. |
cnae | cnae[] | CNAE principal. |
porte | porte[] | Dados do porte da empresa. |
socios | socios[] | QSA: sócios/administradores. |
risco | risco[] | Nível de probabilidade de inadimplência (SERASA). |
pacoteUsado | int | ID do pacote usado. |
saldo | int | Saldo do pacote após a consulta. |
consultaID | string | ID da consulta (16 dígitos). |
delay | float | Tempo para processar a consulta (segundos). |
Matriz simplesNacional
Matriz simplesNacional[]
contendo informações de Simples Nacional:
Parâmetro | Tipo | Descrição |
---|---|---|
optante | string | Sim ou Não . |
inicio | string | Data início (DD/MM/AAAA). |
fim | string | Data fim (DD/MM/AAAA). |
Matriz simei
Matriz simei[]
contendo informações de SIMEI:
Parâmetro | Tipo | Descrição |
---|---|---|
optante | string | Sim ou Não . |
anteriores | matriz | Matriz anteriores[] com registros anteriores. |
Matriz anteriores
Parâmetro | Tipo | Descrição |
---|---|---|
inicio | string | Data início (DD/MM/AAAA). |
fim | string | Data fim (DD/MM/AAAA). |
detalhamento | string | Descrição do registro. |
Matriz matrizEndereco
Parâmetro | Tipo | Descrição |
---|---|---|
cep | string | CEP com 9 dígitos. |
tipo | string | Tipo de endereço (ex: Rua, Avenida etc.). |
logradouro | string | Logradouro da empresa. |
numero | string | Número no endereço. |
complemento | string | Complemento do endereço. |
bairro | string | Bairro do endereço. |
cidade | string | Cidade do endereço. |
uf | string | Estado (UF) com 2 letras. |
Matriz matrizfilial
Informações sobre o órgão competente (matriz ou filial):
Parâmetro | Tipo | Descrição |
---|---|---|
id | int | ID do órgão. |
tipo | string |
Órgão:
id 1 : Matriz id 2 : Filial |
Matriz telefones
Parâmetro | Tipo | Descrição |
---|---|---|
ddd | string | DDD do telefone. |
numero | string | Número do telefone. |
Matriz fax
Parâmetro | Tipo | Descrição |
---|---|---|
ddd | string | DDD do fax. |
numero | string | Número do fax. |
Matriz situacao
Parâmetro | Tipo | Descrição |
---|---|---|
id | int | ID da situação cadastral. |
nome | string |
Nome da situação, por exemplo:
id 1 : Baixada id 2 : Ativa id 3 : Suspensa id 4 : Inapta id 8 : Baixada |
data | string | Data da situação (DD/MM/AAAA). |
Matriz naturezaJuridica
Matriz naturezaJuridica[]
com dados da natureza jurídica.
Lista oficial
Parâmetro | Tipo | Descrição |
---|---|---|
codigo | string | Código da natureza jurídica (4 dígitos). |
descricao | string | Descrição da natureza jurídica. |
Matriz cnae
Matriz cnae[]
com dados do CNAE principal.
Tabela CNAE
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 subclasse. |
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, por exemplo:
id 0 : Demais id 1 : Matriz id 3 : Demais id 5 : Demais |
Matriz socios
Matriz socios[]
contendo dados do QSA:
Parâmetro | Tipo | Descrição |
---|---|---|
nome | string | Nome do sócio PF ou PJ (sem acentuação). |
cnpj | string | CNPJ formatado, se sócio PJ. |
tipo | string | Tipo do sócio. |
capitalSocial | float | Porcentagem de capital social. |
pais | string | País de origem do sócio. |
Matriz risco
Matriz risco[]
com dados do Score SERASA:
Parâmetro | Tipo | Descrição |
---|---|---|
nivel | int | ID do nível de risco (0 a 4). |
descricao | string | Descrição do nível: Desconhecido, Baixo, Médio, Alto, Altíssimo. |
score | string | Faixa de pontuação associada ao nível. |
Consultando Saldos
Sem custos, consulte o saldo do pacote desejado.
Definição
Endpoint que conterá o Token e ID do Pacote, 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 (ver tabela). |
Parâmetros da Resposta
Matriz pacote[]
com informações de saldo:
Parâmetro | Tipo | Descrição |
---|---|---|
id | int | ID do pacote. |
nome | string | Nome do pacote. |
saldo | int | Saldo disponível. |
Códigos de Erro
Lista de erros retornados nos parâmetros 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 (...) | CPF válido, mas não consta em bases da Receita. |
|
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 (...) | CNPJ válido, mas não consta em bases da Receita. |
|
CPF/CNPJ | Token inválido! (...) | Token não pertence ao IP de origem. |
|
CPF/CNPJ | Créditos insuficientes! | Sem créditos no pacote selecionado. |
|
CPF/CNPJ | Conta suspensa e/ou inativa! | Entre em contato com o suporte. |
|
CPF/CNPJ | Blacklist até *DATA* | IP e Token suspenso temporariamente. |
|
CPF/CNPJ | Pacote indisponível para consultas! | ID do pacote inválido ou indisponível. |
|
CPF/CNPJ | Não é possível consultar *CPF/CNPJ* neste pacote! | Falha no fornecedor ou erro interno. |
|
CPF/CNPJ | Supplier 2 offline. Contact us! | Fornecedor de dados off-line. |
|
CPF/CNPJ | Limite de requisições (20) por segundo excedido... | Máximo de 20 consultas por segundo. |