• Home
  • APIs
  • Documentação API Receita Federal

API: Receita Federal


O SintegraWS provê uma API para recuperação de dados de empresas brasileiras através de seu CNPJ. Existem quatro tipos de consulta:

Documentação da API Receita Federal


Recuperar dados de uma empresa no Receita Federal

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

    URL para requisição

https://www.sintegraws.com.br/api/v1/execute-api.php?token=TOKEN_DE_ACESSO&cnpj=CNPJ_DESEJADO&plugin=RF

Parâmetros passados na API da Receita Federal


token

string

OBRIGATÓRIO

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


cnpj

string

OBRIGATÓRIO

CNPJ que deseja obter as informações da Receita Federal.


plugin

string

OBRIGATÓRIO

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

Exemplo de resposta da API Receita Federal


Uma resposta típica é composta por um JSON.

Atenção: utilize o CNPJ 06990590000123 como modo SandBox (teste) para que não seja efetuada cobrança nos créditos contratados.





Campos de retorno da API Receita Federal
Campo Tipo Descrição
code string Código de retorno utilizado para informar o status da requisição.
status string Indica a situação da requisição. Valores possíveis: OK, ERROR.
message string Mensagem explicativa indicando o campo status.
cnpj string CNPJ no formato 00.000.000/0000-00.
tipo string Valores possíveis: MATRIZ, FILIAL.
abertura string Data de abertura no formato dd/mm/aaaa.
nome string Razão social.
fantasia string Nome fantasia.
atividade_principal Array<objeto> Atividade principal. Um array com um elemento.
atividade_principal.code string Código CNAE da atividade no formato 00.00-0-00.
atividade_principal.text string Descrição da atividade.
atividades_secundarias Array<objeto> Atividades secundárias.
atividades_secundarias.code string Código CNAE da atividade no formato 00.00-0-00.
atividades_secundarias.text string Descrição da atividade.
natureza_juridica string Natureza jurídica.
logradouro string Logradouro.
numero string Número.
complemento string Complemento.
cep string CEP no formato 00.000-000.
bairro string Bairro.
municipio string Município.
uf string Sigla da Unidade da Federação.
email string Email.
telefone string Telefone.
efr string Ente Federativo Responsável, disponibilizado apenas para CNPJs da administração pública.
situacao string Situação.
data_situacao string Data da situação no formato dd/mm/aaaa.
motivo_situacao string Motivo da situação.
situacao_especial string Situação especial.
data_situacao_especial string Data da situação especial no formato dd/mm/aaaa.
capital_social string Valor do capital social no formato 0.00.
qsa Array<objeto> Quadro de Sócios e Administradores.
qsa.nome string Nome do sócio.
qsa.qual string Qualificação do sócio.
qsa.pais_origem string País de origem do sócio. Disponível apenas para sócios estrangeiros.
qsa.nome_rep_legal string Nome do representante legal. Disponível apenas para sócios com representantes.
qsa.qual_rep_legal string Qualificação do representante legal. Disponível apenas para sócios com representantes.
extra objeto Campo reservado para uso futuro.
Retornos disponíveis
code status message
0 OK Pesquisa realizada com sucesso.
1 OK CNPJ não tem cadastro na Receita federal.
2 ERROR CNPJ 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 esta com instabilidade.
8 ERROR Ocorreu um erro interno, por favor contatar o nosso suporte.
Exemplos
$.ajax({ var token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; var cnpj = "06990590000123"; var plugin = "RF"; url: "https://sintegraws.com.br/api/v1/execute-api.php?token="+token+"&cnpj="+cnpj+"&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); //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"; $cnpj = "06990590000123"; $plugin = "RF"; //URL do serviço $service_url = "https://sintegraws.com.br/api/v1/execute-api.php?token=" . $token . "&cnpj=" . $cnpj . "&plugin=" . $plugin; //Faz a chamada do serviço utilizando o curl $curl = curl_init($service_url); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); $curl_response = curl_exec($curl); curl_close($curl); //Aqui fazemos o parse do json retornado $decoded = json_decode($curl_response); //Aqui exibimos uma mensagem caso tenha ocorrido algum erro if ($decoded->status == 'ERROR') { die("Erro: " . $decoded->message); } //Mostra informações da receita federal echo "Razão social: " . $decoded->nome; //preencher os outros campos // ... ?>
import requests token = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" cnpj = "06990590000123"; plugin = "RF"; url = "https://sintegraws.com.br/api/v1/execute-api.php?token=" + token + "&cnpj=" + cnpj + "&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", "06990590000123", "ST"); } private static void consultaCNPJSintegraWS(String token, String cnpj, String plugin) { ReceitaFederal sn = new ReceitaFederal(); string jsonRetorno = ""; using (HttpClient client = new HttpClient()) { String url = "https://www.sintegraws.com.br/api/v1/execute-api.php?token=" + token + "&cnpj=" + cnpj + "&plugin=" + plugin; var response = client.GetAsync(url).Result; using (HttpContent content = response.Content) { Task result = content.ReadAsStringAsync(); jsonRetorno = result.Result; sn = Newtonsoft.Json.JsonConvert.DeserializeObject(jsonRetorno); if (sn.status.Equals("OK")) { Console.WriteLine("Razão social: " + sn.nome); } else { Console.WriteLine("Erro: " + sn.message); } } } } } public class ReceitaFederal { public String code { get; set; } public string status { get; set; } public String message { get; set; } public List atividade_principal { get; set; } public string data_situacao { get; set; } public string complemento { get; set; } public string nome { get; set; } public string uf { get; set; } public string telefone { get; set; } public string email { get; set; } public List atividades_secundarias { get; set; } public List qsa { get; set; } public string situacao { get; set; } public string bairro { get; set; } public string logradouro { get; set; } public string numero { get; set; } public string cep { get; set; } public string municipio { get; set; } public string abertura { get; set; } public string natureza_juridica { get; set; } public string cnpj { get; set; } public string ultima_atualizacao { get; set; } public string tipo { get; set; } public string fantasia { get; set; } public string efr { get; set; } public string motivo_situacao { get; set; } public string situacao_especial { get; set; } public string data_situacao_especial { get; set; } public string capital_social { get; set; } public Extra extra { get; set; } public string porte { get; set; } } public class AtividadePrincipal { public string text { get; set; } public string code { get; set; } } public class AtividadesSecundaria { public string text { get; set; } public string code { get; set; } } public class Qsa { public string qual { get; set; } public string qual_rep_legal { get; set; } public string nome_rep_legal { get; set; } public string pais_origem { get; set; } public string nome { get; set; } } public class Extra { } }