Skip to main content

Get files

Retrieve files associated with a session

Generates a presigned URL for secure file download and redirects the client to it.

The {vaultEntryId} is the Vault file ID found in your session data blocks wherever a file is referenced as:

{ "$ref": "vault", "$id": "..." }

Endpoint

GET v1/{environment}/files/{vaultEntryId}

Path parameters

ParameterTypeRequiredDescription
vaultEntryIdstringYesThe unique identifier containing the file
environmentStringYesThe logical environments ( live or staging )

Request

No request body is required for this endpoint.

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token for authentication

Response

The response returns the requested file as a binary stream with appropriate content type headers.

  • The server validates the vaultEntryId and the environment.
  • A presigned URL is generated that allows temporary access to the file (default expiry: 3600 seconds).
  • The server responds with an HTTP 302 redirect, setting the presigned URL in the Location header.

Response headers

HeaderDescription
Content-TypeMIME type of the file (e.g., image/jpeg, application/pdf)
Content-LengthSize of the file in bytes
Content-DispositionSuggested filename for download

Example

curl https://api.eu.platform.idnow.io/api/v1/live/files/file_abc123xyz \
-H "Authorization: Bearer YOUR_API_KEY" \
-o downloaded_file.jpg

Use cases

  • Retrieve document images (passport, ID card photos)
  • Access uploaded supporting documents
  • Retrieve facial biometric images

Notes

  • All file access attempts are logged for compliance and auditability
  • Files are stored securely and access requires proper authentication