Pular para o conteúdo principal
GET
curl
O relatório é gerado sob demanda a partir dos dados atuais da transação, então chame o endpoint novamente após uma mudança de status para obter uma cópia atualizada. Diferentemente dos outros endpoints de transações, ele fica em um caminho no escopo da aplicação: coloque na URL o ID da sua organização e o ID da aplicação à qual sua chave de API pertence. Veja Encontre o ID da sua organização.
Um relatório em PDF é considerado mídia. Uma chave de API com escopo precisa de media: read além de transactions: read, e uma chave sem acesso a mídia recebe 403 mesmo quando consegue ler a transação em JSON com Obter transação.

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

organization_id
string<uuid>
obrigatório

UUID da organização.

application_id
string<uuid>
obrigatório

UUID da aplicação. Deve ser a aplicação à qual a chave de API pertence: uma chave usada em qualquer outra aplicação recebe 403.

transaction_uuid
string<uuid>
obrigatório

UUID da transação na Didit: o uuid retornado por POST /v3/transactions/ e GET /v3/transactions/. O seu próprio txn_id não é aceito.

Resposta

O PDF renderizado, retornado diretamente como binário application/pdf.

The response is of type file.

Última modificação em 1 de novembro de 2026