For the complete documentation index, see llms.txt. This page is also available as Markdown.

Download File

Downloads a specific file from the storage system by its unique ID. Returns the raw file content with appropriate Content-Type headers for direct file access or display in browsers.

Endpoint

GET/v2/storage/file/{id}

Link

Request

Path Parameters

Parameter

Type

Description

Required

Example

id

string

File unique ID to download.

Yes

"file_78901"

Query Parameters

Parameter

Type

Description

Required

Example

customerId

string

Customer ID for additional authorization context.

No

"cust_12345"

Headers

Key

Value

Required

Authorization

123

Yes

Accept

*/* or specific MIME type

No


Response (200 OK)

Returns the raw binary content of the file with appropriate Content-Type header.

Response Headers

Header

Value

Description

Content-Type

application/pdf

MIME type of the downloaded file

Content-Length

2048576

Size of the file in bytes

Content-Disposition

attachment; filename="document.pdf"

File download behavior

Response Body

Raw binary content of the requested file.


Examples

Request (Download PDF Document)

bash

Response Headers (PDF Example)

text

Request (Download Image with Customer Context)

bash

Response Headers (Image Example)

text

Request (Direct Browser Display)

bash

Response Headers (Inline Display)

text


Alternative JSON Response Format

If Accept header is set to application/json, returns file metadata with base64-encoded content:

Response Fields

Field

Type

Description

Example

contentType

string

MIME type of the file content.

"application/pdf"

data

string

File content as base64-encoded bytes.

"JVBERi0xLjQK..."

extensions

array

Additional metadata (optional).

-

JSON Response Example

json


Error Responses

  1. File Not Found:

    json

  2. Access Denied:

    json

  3. File Locked:

    json

  4. Unauthorized:

    json


Notes

  • Binary Response: Default behavior returns raw file bytes with proper Content-Type

  • JSON Alternative: Use Accept: application/json for base64-encoded content in JSON

  • Security: Files are subject to access control based on customer association

  • Performance: Large files are streamed efficiently

  • Browser Behavior: Content-Disposition controls whether file is displayed or downloaded

  • Caching: Appropriate cache headers may be included for static files

Common Use Cases:

  • Downloading customer documents for verification

  • Retrieving operation-related files

  • Accessing identity verification documents

  • Displaying files directly in web applications

  • Batch processing of stored documents

Content-Disposition Options:

  • attachment: Browser downloads the file

  • inline: Browser attempts to display the file

  • Filename preserves original file name for downloads

Last updated