Get File

Returns file metadata and, for clean-scanned files, a short-lived presigned download URL scoped to the owning sales channel. Files that are still scanning or quarantined are not downloadable.

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Path parameters

file_idstringRequired
The public file identifier.

Response

Successful response
content_typestring

The file’s MIME type, e.g. application/pdf.

download_urlstring

Short-lived presigned download URL (5 minutes). Always present in a 200 response; non-clean files return 409 rather than a 200 with this field absent.

file_idstring
The public file identifier.
filenamestring
The stored filename.
scan_statusenum

Malware-scan status. Downloads are only available once the file is clean.

size_bytesinteger
The file size in bytes.

Errors

400
Bad Request Error
404
Not Found Error
405
Method Not Allowed Error
500
Internal Server Error
501
Not Implemented Error