Orientações e respostas da equipe da Direct Data

Restituição Imposto de Renda - IRPF

Permite consultar a Restituição de Imposto de Renda - IRPF para pessoas físicas pelo portal da Receita Federal do Brasil.


Casos de Uso

  • Integração com Restituição Imposto de Renda - IRPF
  • Validação e padronização de dados cadastrais
  • Automação de consultas para decisões operacionais
  • Integração com fluxos de risco, crédito e compliance

Aplicações

  • Prevenção de Autuações Fiscais
  • Onboarding de Clientes e Fornecedores

Benefícios

  • Documentação de Restituição Imposto de Renda - IRPF acessível e atualizada
  • Reduz custos e erros manuais
  • Aumenta confiabilidade das decisões
  • Integração simples e escalável

O endpoint /api/RestituicaoIRPF permite consultar a Restituição de Imposto de Renda - IRPF para pessoas físicas pelo portal da Receita Federal do Brasil.

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br/api/IRPF

Endpoint

GET https://apiv3.directd.com.br/api/IRPF?Cpf={0}&DataNascimento={1}&AnoExercicio={2}&Token=Seu_Token

Descrição: Endpoint para realizar consultas Restituição Imposto de Renda - IRPF.

Nota: Esta consulta não gera comprovantes.

Campos Retornados

  • Agência: Informa a agência.
  • Banco: Informa o nome do banco da entidade
  • Chave Pix: Informa a chave PIX consultada.
  • Conta: Informa a conta.
  • Dados Bancários: Detalhes dos dados bancários do indivíduo.
  • Data de disponibilidade: Informa a data de disponibilidade.
  • Débito Automático: Detalhes sobre o débito automático.
  • Exercício: Informa o ano de exercício.
  • Flag Fila: Informa se está na fila ou não. True(verdadeiro) ou false(falso).
  • Lote: Informa o número do lote.
  • Mensagem PERES: Informa a mensagem a respeito do PERES (Pedido de Restituição não resgatada no banco).
  • Nome do Contribuinte: Informa o nome do contribuinte.
  • Observações: Informa as observações do registro.
  • Restituição: Detalha os dados sobre a restituição.
  • Resultado: Informa o resultado.
  • Situação: Situação do registro em questão
  • Situação da Restituição: Informa a situação da restituição.
  • Tipo de Declaração: Detalhes sobre o tipo de declaração.

Parâmetros

ParâmetroTipoObrigatórioDescrição
ANOEXERCICIOstring
Não
DATANASCIMENTOstring
Não

O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.

CPFstring
Sim

O parâmetro CPF pode ser enviado com ou sem formatação.

TOKENstring
Sim

O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "string",
    "consultaUid": "string",
    "chave": "string",
    "usuario": "string",
    "mensagem": "string",
    "ip": "string",
    "resultadoId": 0,
    "resultado": "string",
    "apiVersao": "v3",
    "enviarCallback": false,
    "gerarComprovante": false,
    "urlComprovante": "string",
    "assincrono": true,
    "data": "dd/MM/yyyy HH:mm:ss",
    "tempoExecucaoMs": 0
  },
  "retorno": {
    "exercicio": 0,
    "nomeContribuinte": "string",
    "resultado": "string",
    "restituicao": {
      "lote": "string",
      "dataDisponibilidade": "string",
      "situacaoRestituicao": "string",
      "mensagemPeres": "string",
      "dadosBancarios": {
        "chavePix": "string",
        "banco": "string",
        "agencia": "string",
        "conta": "string"
      }
    },
    "debitoAutomatico": "string",
    "situacao": "string",
    "observacoes": "string",
    "fila": true,
    "tipoDeclaracao": "string"
  }
}

Erros Comuns

CódigoDescrição
400

Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos.

401

Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso.

403

Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível.

404

Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado.

408

Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido.

500

Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte.

503

Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte.

Notas Importantes

  • Informe apenas um único documento por requisição
  • Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
  • Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228