## Receita Federal / IRPF
Consulta Restituições de Imposto de Renda na Receita Federal a partir do CPF, data de nascimento e ano informados. A API automatiza a consulta de dados em tempo real no site ou no aplicativo de celular da Receita Federal.


### URL do site
- https://www.restituicao.receita.fazenda.gov.br/#/

### Requisição
URL para POST: `https://api.infosimples.com/api/v2/consultas/receita-federal/irpf`



| Parâmetro  | Descrição                                                                                                                                                                                                       |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token*     | Chave de autenticação da API. É com o token que a API reconhece e autoriza quem está fazendo a consulta.                                                                                                        |
| cpf*       | CPF do indivíduo a ser consultado.                                                                                                                                                                              |
| birthdate* | Data de nascimento no formato ISO 8601. Por exemplo, 22 de Abril de 1985 é representado em ISO 8601 da forma "1985-04-22". Preste atenção que é necessário incluir zeros, o formato "1985-4-22" seria inválido. |
| year**     | Ano com quatro dígitos. Por exemplo, 2021. Se não for informado, será usado o ano atual.                                                                                                                        |

> * Parâmetro obrigatório.

> ** Parâmetro opcional. Pode ser necessário informar algum dos parâmetros opcionais para que a consulta funcione adequadamente.


### Exemplos de respostas (OK)
```json
{
  "code": 200,
  "code_message": "A requisição foi processada com sucesso.",
  "errors": [],
  "header": {
    "api_version": "v2",
    "product": "Consultas",
    "service": "receita-federal/irpf",
    "parameters": {
      "birthdate": "11/11/1111",
      "cpf": "123.456.789-01",
      "year": "2022"
    },
    "client_name": "Minha Empresa",
    "token_name": "Token de Produção",
    "billable": true,
    "price": "0.00001",
    "requested_at": "2022-06-08T22:11:16.000-03:00",
    "elapsed_time_in_milliseconds": 528,
    "remote_ip": "111.111.111.111",
    "signature": "U2FsdGVkX1/NJpO3oPBSCJqTjbU+SBNAf39LUphM+4qyZRBDGt1rlnt3rCgnHLasuOJFXjtS3Fx/yIIxsGTNPw=="
  },
  "data_count": 1,
  "data": [
    {
      "agencia": "0000",
      "ano_exercicio": 2022,
      "banco": "0000",
      "chave_pix": "000.000.000-00",
      "consulta_datahora": "08/06/2022 22:11",
      "cpf": "123.456.789-01",
      "disponivel_data": "31/05/2022",
      "lote": "1111111111",
      "nome": "Exemplo de Nome",
      "normalizado_consulta_datahora": "08/06/2022 22:11:00",
      "normalizado_cpf": "12345678901",
      "origem": "web",
      "resultado_encontrado": "",
      "situacao_debito_automatico": "",
      "situacao_restituicao": "Enviada para crédito no banco. Para obter maiores informações sobre a situação da restitução, consulte o Meu Imposto de Renda (Extrato da DIRPF).",
      "status": "",
      "tipo_declaracao": "Declaração de Ajuste Anual Original",
      "site_receipt": "https://www.exemplo.com/exemplo-de-url"
    }
  ],
  "site_receipts": [
    "https://www.exemplo.com/exemplo-de-url"
  ]
}
```


### Arquivo de visualização de consulta

O arquivo de visualização de consulta (`site_receipts`) disponibilizado no retorno da API **pode ser sintetizado pela Infosimples** usando as informações originais da fonte quando o arquivo emitido pela fonte não for adequado para visualização.

### Exemplos de códigos para integração com a API


#### Python
```python
# Testado com: Python 3.10.19, Python 3.14.0
import requests

url = 'https://api.infosimples.com/api/v2/consultas/receita-federal/irpf'
args = {
  "cpf":       "VALOR_DO_PARAMETRO_CPF",
  "birthdate": "VALOR_DO_PARAMETRO_BIRTHDATE",
  "year":      "VALOR_DO_PARAMETRO_YEAR",
  "token":     "INFORME_AQUI_O_TOKEN_DA_CHAVE_DE_ACESSO",
  "timeout":   "300"
}

response = requests.post(url, args)
response_json = response.json()
response.close()

if response_json['code'] == 200:
  print("Retorno com sucesso: ", response_json['data'])
elif response_json['code'] in range(600, 799):
  mensagem = "Resultado sem sucesso. Leia para saber mais: \n"
  mensagem += "Código: {} ({})\n".format(response_json['code'], response_json['code_message'])
  mensagem += "; ".join(response_json['errors'])
  print(mensagem)

print("Cabeçalho da consulta: ", response_json['header'])
print("URLs com arquivos de visualização (HTML/PDF): ", response_json['site_receipts'])
```


## Estamos prontos para ajudar
Ainda tem alguma dúvida ou precisa de ajuda na sua integração? Entre em contato em [suporte@infosimples.com.br](mailto:suporte@infosimples.com.br) e receba ajuda da nossa equipe técnica altamente qualificada.
