Get File

Usage

This API is used to retrieve a file the applicant uploaded in a questionnaire. The file identifier is provided as part of the request path and is obtained from the answer_value of a file_upload answer in the Get Journey Result API. The response will be the binary content of the file.

A file_upload answer can hold more than one file, so answer_value is an array of identifiers. Call this API once for each identifier. The original file names are in the answer's answer_label, in the same order.

Base URL by Region

The base URL you should use depends on the region where your services are hosted. Below are the available URLs for each region. By default, the EU region URL is used.

Authentication

Please refer to the API Credentials and Authentication page for more detailed information

Request Response

The response will be the binary content of the file. The Content-Type header matches the file type (for example application/pdf or image/jpeg), and the Content-Disposition header gives a file name.

Path Params
string
required

The file identifier, taken from the answer_value of a file_upload answer in the Get Journey Result API.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/octet-stream
application/json