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://api2.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 IP's 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
.
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 no header da requisição no formato Bearer Token.
Token para testes de integração:
Token:
5ae973d7a997af13f0aaf2bf60e65803
Atenção! Este token retornará apenas dados fictícios para testes de integração.
ID's dos Pacotes
Em cada requisição, será necessário informar no corpo da requisição o ID do Pacote desejado, aqui nomeado de {pacote}
.
Para contratar os pacotes desejados, acesse o Painel de Controle. Consulte-os em nosso site.
CPF
ID | Pacote | Dados Retornados | Custo por Consulta (BRL) |
---|---|---|---|
1 | A |
| R$0,13 |
7 | B |
| R$0,20 |
2 | C |
| R$0,23 |
8 | D |
| R$0,34 |
9 | E |
| R$0,45 |
3 | F | Disponível apenas sob vias contratuais no plano pós-pago. | R$1,10 |
13 | G |
Clique aqui e leia nosso artigo para mais informações. | R$1,00 |
14 | H |
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² |
15 | I |
Lista de CNPJs em que o titular faz parte do quadro societário. | R$0,20 |
CNPJ
ID | Pacote | Dados Retornados | Custo por Consulta (BRL) |
---|---|---|---|
4 | A |
| R$0,13 |
5 | B |
| R$0,24 |
10 | C |
| R$0,32 |
6 | D |
| R$0,45 |
11 | F |
| R$0,50 |
12 | G |
Clique aqui e leia nosso artigo para mais informações. | R$1,00 |
16 | H |
| R$0,15 |