API: Receita Federal CPF




Documentação da API Receita Federal CPF


Recuperar dados de uma empresa no Receita Federal CPF

Método para recuperar as informações de uma empresa brasileira através do seu CPF. As informações são exatamente as mesmas retornadas pelo site do Receita Federal CPF.

    URL para requisição

https://www.sintegraws.com.br/api/v1/execute-api.php?token=TOKEN_DE_ACESSO&cpf=CPF_DESEJADO&data-nascimento=DATA_NASCIMENTO&plugin=CPF

Parâmetros passados na API do Receita Federal CPF


token

string

OBRIGATÓRIO

Após seu cadastro seu token está localizado em: Nossas APIs > Meu Token.


cpf

string

OBRIGATÓRIO

CPF que deseja obter as informações da Receita Federal. No formato 00000000000.


data-nascimento

string

OBRIGATÓRIO

Data de nascimento do CPF informado. No formato ddmmaaaa.


plugin

string

OBRIGATÓRIO

Site no qual deseja as informações, no caso da Receita Federal CPF informar "CPF".

Exemplo de resposta da API Receita Federal CPF


Uma resposta típica é composta por um JSON.






Campos de retorno da API Receita Federal CPF
Campo Tipo Descrição
status string Indica a situação da requisição. Valores possíveis: OK, ERROR.
code string Código de retorno utilizado para informar o status da requisição.
message string Mensagem explicativa indicando o campo status.
cpf string CPF no formato 00000000000.
nome string Nome.
data_nascimento string Data Nascimento. dd/mm/aaaa.
situacao_cadastral string Situação no Receita Federal CPF.
data_inscricao string Data da inscrição. dd/mm/aaaa.
digito_verificador string Digito verificador.
comprovante string Comprovante
Retornos disponíveis
code status message
0 OK Pesquisa realizada com sucesso.
1 OK Nenhum CPF encontrado na Receita Federal.
2 ERROR CPF inválido.
3 ERROR Token inválido.
4 ERROR Usuário não contratou nenhum pacote de créditos.
5 ERROR Os créditos contratados acabaram.
6 ERROR Plugin não existe.
7 ERROR Site da Receita Federal CPF está com instabilidade.
8 ERROR Ocorreu um erro interno, por favor contatar o nosso suporte.
9 OK Data de nascimento informada está divergente da base de dados da Receita Federal do Brasil.
Exemplos
$.ajax({ var token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; var cpf = "00000000000"; var data_nascimento = "01051986"; var plugin = "CPF"; url: "https://sintegraws.com.br/api/v1/execute-api.php?token="+token+"&cpf="+cpf+"&data-nascimento="+data_nascimento+"&plugin="+ plugin, method:'GET', complete: function(xhr){ // Aqui recuperamos o JSON retornado response = xhr.responseJSON; if(response.status == 'OK') { // Agora preenchemos os campos com os valores retornados $('#nome_empresarial').val(response.nome_empresarial); //preencher os outros campos // ... // Aqui exibimos uma mensagem caso tenha ocorrido algum erro } else { alert(response.message); } } });
<? // Seu token de acesso $token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; $cpf = "00000000000"; $data_nascimento = "01051986"; $plugin = "CPF"; //URL do serviço $service_url = "https://sintegraws.com.br/api/v1/execute-api.php?token=" . $token . "&cpf=" . $cpf . "&data-nascimento=" . $data_nascimento . "&plugin=" . $plugin; $response = file_get_contents($service_url); //Aqui fazemos o parse do json retornado $json = json_decode($response); //Aqui exibimos uma mensagem caso tenha ocorrido algum erro if ($json->code != '0') { die("Erro " . $json->code . ": " . $json->message); } //Mostra informações do CPF echo "Nome empresarial: " . $json->nome; //preencher os outros campos // ... ?>
import requests token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" cpf = "00000000000"; data_nascimento = "01051986"; plugin = "CPF"; url = "https://sintegraws.com.br/api/v1/execute-api.php?token=" + token + "&cpf=" + cpf + "&data-nascimento=" + data_nascimento + "&plugin=" + plugin; response = requests.request("GET", url) print(response.text)
using System; using System.Collections.Generic; using System.Net.Http; using System.Threading.Tasks; namespace Consumo_Sintegra_WS_Exemplo { public class Program { static void Main(string[] args) { consultaCNPJSintegraWS("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "00000000000", "ddmmaaaa", "CPF"); } public static void consultaCNPJSintegraWS(String token, String numero_cpf, String data_nascimento, String plugin) { CPF cpf = new CPF(); using (HttpClient client = new HttpClient()) { String url = "https://www.sintegraws.com.br/api/v1/execute-api.php?token=" + token + "&cpf=" + numero_cpf + "&data-nascimento=" + data_nascimento + "&plugin=" + plugin; var response = client.GetAsync(url).Result; using (HttpContent content = response.Content) { Task result = content.ReadAsStringAsync(); string jsonRetorno = jsonRetorno = result.Result; cpf = Newtonsoft.Json.JsonConvert.DeserializeObject(jsonRetorno); if (cpf.code.Equals("0")) { Console.WriteLine("nome: " + cpf.nome); } else { Console.WriteLine("Erro: " + cpf.message); } } } } } public class CPF { public String code { get; set; } public String status { get; set; } public String message { get; set; } public String cpf { get; set; } public String nome { get; set; } public String data_nascimento { get; set; } public String situacao_cadastral { get; set; } public String data_inscricao { get; set; } public String digito_verificador { get; set; } public String comprovante { get; set; } } }

O SintegraWS provê uma API para recuperação de dados de empresas brasileiras através de seu CNPJ. Existem quatro tipos de consulta, veja as documentações abaixo: