Skip to main content
GET
curl
The report is generated on demand from the transaction’s current data, so call it again after a status change to get an up-to-date copy. Unlike the other transaction endpoints, it lives on an application-scoped path: put your organization ID and the ID of the application your API key belongs to in the URL. See Find your organization ID.
A PDF report counts as media. A scoped API key needs media: read as well as transactions: read, and a key without media access gets 403 even when it can read the transaction as JSON with Get transaction.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

organization_id
string<uuid>
required

Organization UUID.

application_id
string<uuid>
required

Application UUID. Must be the application the API key belongs to: a key used on any other application gets 403.

transaction_uuid
string<uuid>
required

Didit transaction UUID: the uuid returned by POST /v3/transactions/ and GET /v3/transactions/. Your own txn_id is not accepted.

Response

The rendered PDF, returned directly as binary application/pdf.

The response is of type file.