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
vaultEntryIdstring (UUID)YesThe 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 server responds with an HTTP 302 redirect to a presigned URL for the file.

  • 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 presigned URL is returned in the Location header.

Response headers

HeaderDescription
LocationPresigned URL to download the file (follow the redirect)
info

When following the redirect, the file host returns standard content headers (Content-Type, Content-Length, Content-Disposition). Most HTTP clients follow the redirect automatically.

Example

curl https://api.eu.platform.idnow.io/api/v1/live/files/550e8400-e29b-41d4-a716-446655440000 \
-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