Get files

Retrieve files associated with a session

Redirects the client to a download URL for the requested file.

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

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

Endpoint

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

Path parameters

Parameter	Type	Required	Description
vaultEntryId	string (UUID)	Yes	The unique identifier containing the file
environment	string	Yes	The logical environments ( live or staging )

Request

No request body is required for this endpoint.

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

The server responds with an HTTP 302 redirect. Follow the Location header to download the file.

Response headers

Header	Description
Location	URL to follow to download the file

The redirect destination is an implementation detail that may vary. Simply follow the redirect — standard HTTP clients drop the Authorization header on cross-origin redirects automatically, so no special handling is needed.

The redirect URL has a limited lifetime. Do not cache it or retry a failed request with the same URL. On a 401 response, re-request the original GET /api/v1/{environment}/files/{vaultEntryId} endpoint to obtain a fresh redirect URL.

warning

Do not use curl --location-trusted. It forwards the Authorization header to all redirect destinations, which could cause a 400 Bad Request. Use -L instead.

Example

curl https://localhost:3000/api/v1/live/files/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer YOUR_API_KEY" \
-L \
-o downloaded_file.jpg

Use cases

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

Notes

• File access is recorded in application logs
• Files are stored securely and access requires proper authentication

---