Documentação Técnica

Consulta de Restituição do Imposto de Renda

Descrição

A consulta de Restituição do Imposto de Renda retorna os dados referentes ao status e características da restituição de imposto de renda do indivíduo consultado, tais como o número do lote de restituição, o banco e a agência que irão receber o valor restituido, se existe ou não restituição, e assim por diante. Embora a consulta no site exija a data de nascimento como um parâmetro de entrada, ele não é obrigatório para esse dataset. Caso não seja informada, será utilizada a informação de data de nasicmento disponível dentro da base da BigData Corp.
Todos os dados de consultas online executadas em um modelo "on-demand" são retornados em uma mesma estrutura de objetos, e os objetos em si são retornados no campo de OnlineQueries do objeto principal de retorno.

Origem da Informação

As informações retornadas nesta consulta são retiradas da consulta pública de restituição do imposto de Renda no site da Receita Federal. O link de acesso a essa consulta pode ser visto aqui.

Tabela de preços para esse dataset

Consultas Realizadas no MêsValor por consulta
1 - 10000R$ 0,050
10001 - 50000R$ 0,048
50001 - 100000R$ 0,046
100001 - 500000R$ 0,044
500001 - 1000000R$ 0,042
1000001 - 5000000R$ 0,040
5000001 - 10000000R$ 0,038
10000001 - 50000000R$ 0,036
50000001 e acimaR$ 0,034

Parâmetros de consulta

A tabela abaixo detalha os campos aceitos na consulta a este dataset.

CampoDescriçãoValores PossíveisTipo de Campo
docDocumento de identificaçãoCPF🛑 Obrigatório
birthdateData de nascimento do indivíduo. Preenchemos automaticamente este dado na API. Mas caso não encontremos a data em nossas bases, ela deverá ser informada na chamada para que se tenha sucesso.Data⚠️ Semi-Obrigatório
dateformatFormato da data inserida (Padrão: yyyy-MM-dd)Textoℹ️  Opcional
yearAno de referência da restituição (Padrão: Ano anterior)Númeroℹ️  Opcional

Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.

Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:

{  
    "Datasets": "ondemand_restituicao_person",
    "q": "doc{CPF}"  
}  

Descrição dos campos do objeto principal de retorno

CampoDescrição
OriginFonte dos Dados Entregues
InputParametersParâmetros de entrada
ProtocolNumberNúmero de protocolo da consulta
BaseStatusStatus retornado pela consulta
QueryDateData de realização da consulta.
AdditionalOutputData.BankBanco de onde ocorreu a restituição
AdditionalOutputData.AgencyNúmero de agência de onde ocorreu a restituição
AdditionalOutputData.LotNúmero do lote
AdditionalOutputData.RestitutionDateData da restituição
Language
Authorization
Click Try It! to start a request and see the response here!