Saltar para o conteúdo principal
GET
curl
O relatório é gerado a pedido a partir dos dados atuais da transação, por isso chame o endpoint novamente após uma alteração de estado para obter uma cópia atualizada. Ao contrário dos outros endpoints de transações, este está num caminho específico da aplicação: coloque o ID da sua organização e o ID da aplicação a que pertence a sua chave de API no URL. Consulte Encontre o ID da sua organização.
Um relatório PDF conta como multimédia. Uma chave de API com âmbito limitado precisa de media: read e também de transactions: read, e uma chave sem acesso a multimédia recebe 403, mesmo que consiga ler a transação em JSON com Obter transação.

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. 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 Didit: o uuid devolvido por POST /v3/transactions/ e GET /v3/transactions/. O seu próprio txn_id não é aceite.

Resposta

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

The response is of type file.

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