v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

Show/download stored file

<small>Requires an API token with the Document Reader role.</small>

Returns the details of a single file in the file storage of the given document.

The download_url field of the response contains a temporary URL that can be used to fetch the file content. The URL is pre-authenticated - i.e. it can be requested without sending any additional HTTP headers.

Note that the download_url will expire a short time after the response is returned. If the URL has expired, this endpoint can be requested again to obtain a new download_url.

get/documents/{document}/file-storage/{storedFile}

Path parameters

documentstring required

The document UUID

storedFilestring required

The stored file UUID

Response

StoredFileResource

Example response

{
  "data": {
    "uuid": "c3f8ca57-b1a4-4560-b3fe-5f3fffb333dd",
    "sha256": "697651f6ceea8a931289ff64cb62f78ceea5d36f7e84590fe9d5920b2dce52cf",
    "file_name": "NDA_BigCorp.pdf",
    "file_size": 544600,
    "mime_type": "application/pdf",
    "download_url": "https:..."
  }
}