Solicitar extração de declaração de IR de um cliente

POST

/assets/ir/import/{clientId}

Solicita a extração dos dados de uma declaração de Imposto de Renda do cliente informado em clientId, a partir do arquivo indicado em url, para o ano-base informado em year. A extração é feita de forma assíncrona: a resposta 200 indica que o pedido foi aceito e enviado para processamento, não que a extração terminou. A rota cria a pasta IR nos documentos do cliente, se ainda não existir, e a informa no pedido. Para acompanhar, use o irExtractionStatusId: quando originBucket é enviado, a resposta traz o queryId da solicitação e o irExtractionStatusId; sem originBucket, a resposta traz só uma mensagem, e o irExtractionStatusId aparece como _id na rota de listar extrações de IR recentes do cliente. Com o irExtractionStatusId, a rota de consultar resultado de extração de IR devolve os dados extraídos. year é obrigatório; sem ele, a resposta é 400. Requer autenticação via Bearer JWT ou header x-api-key. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 404 (Usuário não encontrado).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Extração solicitada (processamento assíncrono)

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Ano-base ausente

Request Example

Shell

JavaScript

Java

Swift

curl --location '/assets/ir/import/7c9e6679-7425-40de-944b-e07fc1f90ae7' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "ir/declaracao-2026.pdf",
    "year": "2026",
    "originBucket": "documentos-exemplo"
}'

Response Example

200 - Com originBucket

{
    "queryId": "f1a2b3c4-0000-4000-8000-000000000701",
    "irExtractionStatusId": "f1a2b3c4-0000-4000-8000-000000000601"
}

Modificado em 2026-10-13 09:47:06

Página anterior

Importar passivo bancário do SCR de um cliente

Próxima página

Listar extrações de IR recentes de um cliente