CPF.CNPJ - Documentação da API v1 (2023)

Sobre

Esta é a API para consulta da síntese cadastral de CPFs e CNPJs 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.

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.

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.

ID
PacoteDados RetornadosCusto por Consulta (BRL)
1CPF A
  • Nome Completo
R$0,13
7CPF B
  • Nome Completo
  • Data de Nascimento
R$0,20
2CPF C
  • Nome Completo
  • Data de Nascimento
  • Nome Completo da Mãe
  • Gênero
R$0,23
8CPF D
  • Nome Completo
  • Data de Nascimento
  • Situação Cadastral na Receita Federal
R$0,34
9CPF E
  • Nome Completo
  • Nome Completo da Mãe
  • Data de Nascimento
  • Gênero
  • Situação Cadastral na Receita Federal
R$0,45
3CPF F
  • Nome Completo
  • Data de Nascimento
  • Gênero
  • Endereço Completo

Disponível apenas sob vias contratuais no plano pós-pago.

R$1,10
13CPF G
  • Nome Completo
  • Nível de probabilidade de inadimplência futura, segundo a SERASA.

Clique aqui e leia nosso artigo para mais informações.

R$1,00
14CPF H
  • Nome Completo¹
  • Pessoa Politicamente Exposta (PPE)

Clique aqui e leia nosso artigo para mais informações.

¹ Caso não seja uma PPE, o retorno será null.
² A cobrança também é feita se o CPF consultado não for uma PPE.

R$0,10²
4CNPJ A
  • Razão Social
R$0,13
5CNPJ B
  • Razão Social
  • Nome Fantasia
  • Endereço Completo
R$0,24
10CNPJ 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,32
6CNPJ 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
  • Situação Cadastral na Receita Federal
  • Informações sobre Simples Nacional
R$0,45
12CNPJ G
  • Razão Social
  • Nível de probabilidade de inadimplência futura, segundo a SERASA.

Clique aqui e leia nosso artigo para mais informações.

R$1,00

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âmetroTipoDescriçãoObrigatório?
tokenstringToken gerado no Painel de Controle.
pacoteintID do pacote a ser utilizado, conforme tabela.
cpfcnpjstringNú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 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âmetroTipoDescrição
statusbool1 para sucesso na requisição e 0 para falha na requisição. Caso retorne 0, consulte a tabela de erros.
cpfstringNúmero formatado do CPF consultado com 14 dígitos.
nomestringNome completo do titular (sem acentuação).
nascimentostringData de nascimento do titular no formato DD/MM/AAAA.
maestringNome completo da mãe do titular (sem acentuação).
generostringM para Masculino;
F para Feminino.
situacaostringSituação cadastral na Receita Federal:
Regular, Cancelada, Suspensa, Pendente ou Nula
riscorisco[]Matriz de objetos contendo o nível de probabilidade de inadimplência futura, segundo a SERASA. Clique aqui e saiba mais.
enderecostringEndereço residencial do titular.
numerostringNúmero no endereço.
complementostringComplemento do endereço.
bairrostringBairro do endereço.
cidadestringCidade do endereço.
ufstringUnidade da Federação do endereço com 2 letras.
ppeppe[]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.
pacoteUsadointID do pacote usado.
saldointSaldo do pacote usado após consulta.
consultaIDstringID da consulta com 16 dígitos.
delayfloatTempo levado para realizar a consulta em segundos.
Matriz PPE

Matriz ppe[] contendo lista de possíveis cargos da PPE:

ParâmetroTipoDescrição
siglastringSigla da função do cargo político
funcaostringFunção do cargo político
nivelstringNível de hierarquia política
orgaostringÓrgão de atuação política
inicioexerciciostringData de início do cargo no formato DD/MM/AAAA
fimexerciciostringData de fim do cargo no formato DD/MM/AAAA
fimcarenciastringData 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âmetroTipoDescrição
statusbool1 para sucesso na requisição e 0 para falha na requisição. Caso retorne 0, consulte a tabela de erros.
cnpjstringNúmero formatado do CNPJ consultado com 18 dígitos.
razaostringNome da razão social da empresa.
fantasiastringNome fantasia da empresa.
inicioAtividadestringData de início das atividades no formato DD/MM/AAAA.
emailstringEndereço de e-mail no cadastro da empresa.
responsavelstringNome do responsável legal pela empresa (sem acentuação).
simplesNacionalsimplesNacional[]Matriz contendo possíveis informações de Simples Nacional.
simeisimei[]Matriz contendo possíveis informações de SIMEI.
matrizEnderecomatrizEndereco[] Matriz de objetos do endereço.
matrizfilialmatrizfilial[]Matriz de objetos do órgão competente.
telefonestelefones[]Matriz de objetos contendo o(s) telefone(s) da empresa. No máximo 2 telefones.
faxfax[]Matriz de objetos contendo o(s) fax(es) da empresa.
situacaosituacao[]Matriz de objetos contendo dados da situação cadastral da empresa na Receita Federal.
naturezaJuridicanaturezaJuridica[]Matriz de objetos contendo dados da natureza jurídica.
cnaecnae[]Matriz de objetos contendo dados do CNAE principal.
porteporte[]Matriz de objetos contendo dados do porte da empresa.
sociossocios[]Matriz de objetos contendo dados do(s) sócio(s), QSA.
riscorisco[]Matriz de objetos contendo o nível de probabilidade de inadimplência futura, segundo a SERASA. Clique aqui e saiba mais.
pacoteUsadointID do pacote usado.
saldointSaldo do pacote usado após consulta.
consultaID stringID da consulta com 16 dígitos.
delayfloatTempo levado para realizar a consulta em segundos.
Matriz simplesNacional

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

ParâmetroTipoDescrição
optantestringSim ou Não atualmente.
iniciostringData de início como Simples Nacional no formato DD/MM/AAAA
fimstringData de fim como Simples Nacional no formato DD/MM/AAAA
Matriz simei

Matriz simei[] contendo informações sobre possível optante pelo SIMEI:

ParâmetroTipoDescrição
optantestringSim ou Não atualmente.
anterioresmatrizMatriz anteriores[] contendo a lista de registros anteriores como SEMEI.
Matriz anteriores

Matriz anteriores[] contendo a lista de registros anteriores como SEMEI:

ParâmetroTipoDescrição
iniciostringData de início como SIMEI no formato DD/MM/AAAA
fimstringData de fim como SIMEI no formato DD/MM/AAAA
detalhamentostringDescrição sobre o registro
Matriz matrizEndereco

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

ParâmetroTipoDescrição
cepstringCEP do endereço com 9 dígitos.
tipostringTipo 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

logradourostringEndereço da empresa.
numerostringNúmero no endereço da empresa.
complementostringComplemento do endereço.
bairrostringBairro do endereço.
cidadestringCidade do endereço.
ufstringUnidade 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âmetroTipoDescrição
idintID do órgão
tipostringÓrgão:

id 1: Matriz
id 2: Filial

Matriz telefones

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

ParâmetroTipoDescrição
dddstringNúmero de DDD do telefone
numerostringNúmero de telefone
Matriz fax

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

ParâmetroTipoDescrição
dddstringNúmero de DDD do fax
numerostringNúmero de fax
Matriz situacao

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

ParâmetroTipoDescrição
idintID da situação cadastral.
nomestringNome da situação cadastral, sendo:

id 1: Baixada
id 2: Ativa
id 3: Suspensa
id 4: Inapta
id 8: Baixada

datastringData 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âmetroTipoDescrição
codigostringCódigo da natureza jurídica com 4 dígitos sem hífen.
descricaostringDescriçã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âmetroTipoDescrição
divisaostringCódigo da divisão.
grupostringCódigo do grupo.
classestringCódigo da classe.
subClassestringCódigo da sub classe.
fiscalstringCódigo completo do CNAE, somente números.
descricaostringDescrição do CNAE.
Matriz porte

Matriz porte[] contendo dados do porte da empresa.

ParâmetroTipoDescrição
idstringID do porte.
descricaostringDescriçã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âmetroTipoDescrição
nomestringNome do sócio PF ou PJ (sem acentuação).
cnpjstringNúmero do CNPJ formatado caso seja um sócio PJ.
tipostringTipo de sócio.
capitalSocialfloatPorcentagem de capital social do sócio na empresa.
paisstringPaís de origem do sócio.
Matriz risco

Matriz risco[] contendo informações do score na SERASA.

ParâmetroTipoDescrição
nivelintID do nível.
descricaostringDescrição do nível de risco, sendo:

nivel 0: Desconhecido
nivel 1: Baixo
nivel 2: Médio
nivel 3: Alto
nivel 4: Altíssimo

scorestring

Faixa de pontuação do nível de score.

CPF:
Baixo: 701-1000
Médio: 501-700
Alto: 301-500
Altíssimo: 0-300

CNPJ:
Baixo: 601-1000
Médio: 251-600
Alto: 101-250
Altíssimo: 0-100

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âmetroTipoDescriçãoObrigatório?
tokenstringToken gerado no Painel de Controle.
pacoteintID do pacote a ser utilizado, conforme tabela.

Parâmetros da Resposta

Matriz pacote[] contendo informações de saldo do pacote.

ParâmetroTipoDescrição
idintID do pacote.
nomestringNome do pacote consultado.
saldointSaldo do pacote consultado.

Códigos de Erro

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

erroCodigo
ValorerroDescrição
100
CPFCPF inválido!Número digitado não é um CPF válido.
101
CPFInforme um CPF com 11 dígitos!CPF informado possui menos de 11 dígitos.
102
CPFO 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
CNPJCNPJ inválido!Número digitado não é um CNPJ válido.
201
CNPJInforme um CNPJ com 14 dígitos!CNPJ informado possui menos de 14 dígitos.
202
CNPJO 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/CNPJToken inválido! (...)O token informado não pertence ao IP que está realizando a consulta.
1001
CPF/CNPJCréditos insuficientes!Você não possui créditos no pacote informado, para realizar consultas.
1002
CPF/CNPJConta suspensa e/ou inativa!Entre em contato conosco para verificar o motivo.
1003
CPF/CNPJBlacklist até *DATA*IP e Token suspenso temporariamente por descumprir uma das Regras de Uso.
1004
CPF/CNPJPacote indisponível para consultas!O ID do pacote informado é inválido ou não está disponível para consultas.
1005
CPF/CNPJNã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/CNPJSupplier 2 offline. Contact us!Fornecedor de dados off-line ou enfrentando instabilidades. Tente novamente ou entre em contato conosco.
Top Articles
Latest Posts
Article information

Author: Fredrick Kertzmann

Last Updated: 10/22/2022

Views: 5611

Rating: 4.6 / 5 (46 voted)

Reviews: 93% of readers found this page helpful

Author information

Name: Fredrick Kertzmann

Birthday: 2000-04-29

Address: Apt. 203 613 Huels Gateway, Ralphtown, LA 40204

Phone: +2135150832870

Job: Regional Design Producer

Hobby: Nordic skating, Lacemaking, Mountain biking, Rowing, Gardening, Water sports, role-playing games

Introduction: My name is Fredrick Kertzmann, I am a gleaming, encouraging, inexpensive, thankful, tender, quaint, precious person who loves writing and wants to share my knowledge and understanding with you.