Create a document download link

Required scope: documents:download.

Returns a URL for downloading the document file directly from storage. The URL expires after five minutes; call this endpoint again for a new one.

Choose a variant: best (the default) returns the OCR version when it is readable and otherwise the original, while original and ocr return exactly that version. If the requested file is unavailable the response is 409 file_unavailable; a temporary storage problem returns 503.

Anyone holding the URL can download the file until it expires, even if the API key is revoked, so do not log or share it. Creating a link does not refresh the client's eFolder.

This is a read-only request, so it does not use an Idempotency-Key.

POST /api/v2/documents/{id}/download-access
Bearer token scope documents:download

Path parameters

· 1
id string required

Document ID.

Body

required application/json
variant string · default: best· enum required

values

  • best
  • original
  • ocr

Responses