@onfido/api 3.2.0 → 3.4.0

package/dist/api.d.ts

@@ -1766,6 +1766,7 @@ export interface Document {
 }
 export declare const DocumentFileTypeEnum: {
     readonly Jpg: "jpg";
+    readonly Jpeg: "jpeg";
     readonly Png: "png";
     readonly Pdf: "pdf";
     readonly UnknownDefaultOpenApi: "11184809";
@@ -2834,19 +2835,25 @@ export interface DocumentProperties {
      * @type {string}
      * @memberof DocumentProperties
      */
-    'gender'?: string;
+    'middle_name'?: string;
     /**
      *
      * @type {string}
      * @memberof DocumentProperties
      */
-    'issuing_country'?: string;
+    'last_name'?: string;
     /**
      *
      * @type {string}
      * @memberof DocumentProperties
      */
-    'last_name'?: string;
+    'gender'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentProperties
+     */
+    'issuing_country'?: string;
     /**
      *
      * @type {string}
@@ -3691,6 +3698,7 @@ export interface DocumentShared {
 }
 export declare const DocumentSharedFileTypeEnum: {
     readonly Jpg: "jpg";
+    readonly Jpeg: "jpeg";
     readonly Png: "png";
     readonly Pdf: "pdf";
     readonly UnknownDefaultOpenApi: "11184809";
@@ -4075,19 +4083,25 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
      * @type {string}
      * @memberof DocumentWithDriverVerificationReportAllOfProperties
      */
-    'gender'?: string;
+    'middle_name'?: string;
     /**
      *
      * @type {string}
      * @memberof DocumentWithDriverVerificationReportAllOfProperties
      */
-    'issuing_country'?: string;
+    'last_name'?: string;
     /**
      *
      * @type {string}
      * @memberof DocumentWithDriverVerificationReportAllOfProperties
      */
-    'last_name'?: string;
+    'gender'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentWithDriverVerificationReportAllOfProperties
+     */
+    'issuing_country'?: string;
     /**
      *
      * @type {string}
@@ -9498,6 +9512,12 @@ export interface WebhookEventPayloadObject {
      * @memberof WebhookEventPayloadObject
      */
     'status'?: string;
+    /**
+     * The date and time when the operation was started, if available.
+     * @type {string}
+     * @memberof WebhookEventPayloadObject
+     */
+    'started_at_iso8601'?: string;
     /**
      * The date and time when the operation was completed, if available.
      * @type {string}
@@ -9718,6 +9738,12 @@ export interface WorkflowRun {
      * @memberof WorkflowRun
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRun
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}
@@ -9778,6 +9804,12 @@ export interface WorkflowRun {
      * @memberof WorkflowRun
      */
     'error'?: WorkflowRunResponseError;
+    /**
+     * Client token to use when loading this workflow run in the Onfido SDK.
+     * @type {string}
+     * @memberof WorkflowRun
+     */
+    'sdk_token'?: string | null;
 }
 export declare const WorkflowRunStatusEnum: {
     readonly AwaitingInput: "awaiting_input";
@@ -9814,6 +9846,12 @@ export interface WorkflowRunBuilder {
      * @memberof WorkflowRunBuilder
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRunBuilder
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}
@@ -9904,6 +9942,12 @@ export interface WorkflowRunResponse {
      * @memberof WorkflowRunResponse
      */
     'error'?: WorkflowRunResponseError;
+    /**
+     * Client token to use when loading this workflow run in the Onfido SDK.
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    'sdk_token'?: string | null;
 }
 export declare const WorkflowRunResponseStatusEnum: {
     readonly AwaitingInput: "awaiting_input";
@@ -9959,6 +10003,12 @@ export interface WorkflowRunShared {
      * @memberof WorkflowRunShared
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRunShared
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}
@@ -10193,6 +10243,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     downloadMotionCaptureFrame: (motionCaptureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided.
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadQesDocument: (workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieves the signed evidence file for the designated Workflow Run
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -10733,6 +10792,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided.
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
     /**
      * Retrieves the signed evidence file for the designated Workflow Run
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -11273,6 +11341,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     downloadMotionCaptureFrame(motionCaptureId: string, options?: any): AxiosPromise<FileTransfer>;
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided.
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadQesDocument(workflowRunId: string, fileId: string, options?: any): AxiosPromise<FileTransfer>;
     /**
      * Retrieves the signed evidence file for the designated Workflow Run
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -11835,6 +11912,16 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided.
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
     /**
      * Retrieves the signed evidence file for the designated Workflow Run
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -12266,6 +12353,7 @@ export type ListWorkflowRunsSortEnum = typeof ListWorkflowRunsSortEnum[keyof typ
  */
 export declare const UploadDocumentFileTypeEnum: {
     readonly Jpg: "jpg";
+    readonly Jpeg: "jpeg";
     readonly Png: "png";
     readonly Pdf: "pdf";
     readonly UnknownDefaultOpenApi: "11184809";

package/dist/api.js

@@ -373,6 +373,7 @@ exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = {
 };
 exports.DocumentFileTypeEnum = {
     Jpg: 'jpg',
+    Jpeg: 'jpeg',
     Png: 'png',
     Pdf: 'pdf',
     UnknownDefaultOpenApi: '11184809'
@@ -408,6 +409,7 @@ exports.DocumentPropertiesSecurityTierEnum = {
 };
 exports.DocumentSharedFileTypeEnum = {
     Jpg: 'jpg',
+    Jpeg: 'jpeg',
     Png: 'png',
     Pdf: 'pdf',
     UnknownDefaultOpenApi: '11184809'
@@ -1352,6 +1354,45 @@ const DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Retrieves the signed document or application form depending on the file_id provided.
+         * @summary Retrieves the signed document or application form
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} fileId The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadQesDocument: (workflowRunId, fileId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'workflowRunId' is not null or undefined
+            (0, common_1.assertParamExists)('downloadQesDocument', 'workflowRunId', workflowRunId);
+            // verify required parameter 'fileId' is not null or undefined
+            (0, common_1.assertParamExists)('downloadQesDocument', 'fileId', fileId);
+            const localVarPath = `/qualified_electronic_signature/documents`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Token required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
+            if (workflowRunId !== undefined) {
+                localVarQueryParameter['workflow_run_id'] = workflowRunId;
+            }
+            if (fileId !== undefined) {
+                localVarQueryParameter['file_id'] = fileId;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Retrieves the signed evidence file for the designated Workflow Run
          * @summary Retrieve Workflow Run Evidence Summary File
@@ -3172,6 +3213,23 @@ const DefaultApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Retrieves the signed document or application form depending on the file_id provided.
+         * @summary Retrieves the signed document or application form
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} fileId The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadQesDocument(workflowRunId, fileId, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadQesDocument(workflowRunId, fileId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.downloadQesDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Retrieves the signed evidence file for the designated Workflow Run
          * @summary Retrieve Workflow Run Evidence Summary File
@@ -4108,6 +4166,17 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
         downloadMotionCaptureFrame(motionCaptureId, options) {
             return localVarFp.downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves the signed document or application form depending on the file_id provided.
+         * @summary Retrieves the signed document or application form
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} fileId The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadQesDocument(workflowRunId, fileId, options) {
+            return localVarFp.downloadQesDocument(workflowRunId, fileId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieves the signed evidence file for the designated Workflow Run
          * @summary Retrieve Workflow Run Evidence Summary File
@@ -4800,6 +4869,18 @@ class DefaultApi extends base_1.BaseAPI {
     downloadMotionCaptureFrame(motionCaptureId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided.
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadQesDocument(workflowRunId, fileId, options) {
+        return (0, exports.DefaultApiFp)(this.configuration).downloadQesDocument(workflowRunId, fileId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Retrieves the signed evidence file for the designated Workflow Run
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -5319,6 +5400,7 @@ exports.ListWorkflowRunsSortEnum = {
  */
 exports.UploadDocumentFileTypeEnum = {
     Jpg: 'jpg',
+    Jpeg: 'jpeg',
     Png: 'png',
     Pdf: 'pdf',
     UnknownDefaultOpenApi: '11184809'

package/dist/configuration.js

@@ -32,7 +32,7 @@ class Configuration {
         }
         this.apiKey = 'Token token=' + param.apiToken;
         this.basePath = param.basePath || base_1.BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
-        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.2.0' }) });
+        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.4.0' }) });
         this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
     }
     /**

package/dist/esm/api.d.ts

@@ -1766,6 +1766,7 @@ export interface Document {
 }
 export declare const DocumentFileTypeEnum: {
     readonly Jpg: "jpg";
+    readonly Jpeg: "jpeg";
     readonly Png: "png";
     readonly Pdf: "pdf";
     readonly UnknownDefaultOpenApi: "11184809";
@@ -2834,19 +2835,25 @@ export interface DocumentProperties {
      * @type {string}
      * @memberof DocumentProperties
      */
-    'gender'?: string;
+    'middle_name'?: string;
     /**
      *
      * @type {string}
      * @memberof DocumentProperties
      */
-    'issuing_country'?: string;
+    'last_name'?: string;
     /**
      *
      * @type {string}
      * @memberof DocumentProperties
      */
-    'last_name'?: string;
+    'gender'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentProperties
+     */
+    'issuing_country'?: string;
     /**
      *
      * @type {string}
@@ -3691,6 +3698,7 @@ export interface DocumentShared {
 }
 export declare const DocumentSharedFileTypeEnum: {
     readonly Jpg: "jpg";
+    readonly Jpeg: "jpeg";
     readonly Png: "png";
     readonly Pdf: "pdf";
     readonly UnknownDefaultOpenApi: "11184809";
@@ -4075,19 +4083,25 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
      * @type {string}
      * @memberof DocumentWithDriverVerificationReportAllOfProperties
      */
-    'gender'?: string;
+    'middle_name'?: string;
     /**
      *
      * @type {string}
      * @memberof DocumentWithDriverVerificationReportAllOfProperties
      */
-    'issuing_country'?: string;
+    'last_name'?: string;
     /**
      *
      * @type {string}
      * @memberof DocumentWithDriverVerificationReportAllOfProperties
      */
-    'last_name'?: string;
+    'gender'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentWithDriverVerificationReportAllOfProperties
+     */
+    'issuing_country'?: string;
     /**
      *
      * @type {string}
@@ -9498,6 +9512,12 @@ export interface WebhookEventPayloadObject {
      * @memberof WebhookEventPayloadObject
      */
     'status'?: string;
+    /**
+     * The date and time when the operation was started, if available.
+     * @type {string}
+     * @memberof WebhookEventPayloadObject
+     */
+    'started_at_iso8601'?: string;
     /**
      * The date and time when the operation was completed, if available.
      * @type {string}
@@ -9718,6 +9738,12 @@ export interface WorkflowRun {
      * @memberof WorkflowRun
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRun
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}
@@ -9778,6 +9804,12 @@ export interface WorkflowRun {
      * @memberof WorkflowRun
      */
     'error'?: WorkflowRunResponseError;
+    /**
+     * Client token to use when loading this workflow run in the Onfido SDK.
+     * @type {string}
+     * @memberof WorkflowRun
+     */
+    'sdk_token'?: string | null;
 }
 export declare const WorkflowRunStatusEnum: {
     readonly AwaitingInput: "awaiting_input";
@@ -9814,6 +9846,12 @@ export interface WorkflowRunBuilder {
      * @memberof WorkflowRunBuilder
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRunBuilder
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}
@@ -9904,6 +9942,12 @@ export interface WorkflowRunResponse {
      * @memberof WorkflowRunResponse
      */
     'error'?: WorkflowRunResponseError;
+    /**
+     * Client token to use when loading this workflow run in the Onfido SDK.
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    'sdk_token'?: string | null;
 }
 export declare const WorkflowRunResponseStatusEnum: {
     readonly AwaitingInput: "awaiting_input";
@@ -9959,6 +10003,12 @@ export interface WorkflowRunShared {
      * @memberof WorkflowRunShared
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRunShared
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}
@@ -10193,6 +10243,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     downloadMotionCaptureFrame: (motionCaptureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided.
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadQesDocument: (workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieves the signed evidence file for the designated Workflow Run
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -10733,6 +10792,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided.
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
     /**
      * Retrieves the signed evidence file for the designated Workflow Run
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -11273,6 +11341,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     downloadMotionCaptureFrame(motionCaptureId: string, options?: any): AxiosPromise<FileTransfer>;
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided.
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadQesDocument(workflowRunId: string, fileId: string, options?: any): AxiosPromise<FileTransfer>;
     /**
      * Retrieves the signed evidence file for the designated Workflow Run
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -11835,6 +11912,16 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided.
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
     /**
      * Retrieves the signed evidence file for the designated Workflow Run
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -12266,6 +12353,7 @@ export type ListWorkflowRunsSortEnum = typeof ListWorkflowRunsSortEnum[keyof typ
  */
 export declare const UploadDocumentFileTypeEnum: {
     readonly Jpg: "jpg";
+    readonly Jpeg: "jpeg";
     readonly Png: "png";
     readonly Pdf: "pdf";
     readonly UnknownDefaultOpenApi: "11184809";

package/dist/esm/api.js

@@ -369,6 +369,7 @@ export const DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = {
 };
 export const DocumentFileTypeEnum = {
     Jpg: 'jpg',
+    Jpeg: 'jpeg',
     Png: 'png',
     Pdf: 'pdf',
     UnknownDefaultOpenApi: '11184809'
@@ -404,6 +405,7 @@ export const DocumentPropertiesSecurityTierEnum = {
 };
 export const DocumentSharedFileTypeEnum = {
     Jpg: 'jpg',
+    Jpeg: 'jpeg',
     Png: 'png',
     Pdf: 'pdf',
     UnknownDefaultOpenApi: '11184809'
@@ -1348,6 +1350,45 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Retrieves the signed document or application form depending on the file_id provided.
+         * @summary Retrieves the signed document or application form
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} fileId The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadQesDocument: (workflowRunId, fileId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'workflowRunId' is not null or undefined
+            assertParamExists('downloadQesDocument', 'workflowRunId', workflowRunId);
+            // verify required parameter 'fileId' is not null or undefined
+            assertParamExists('downloadQesDocument', 'fileId', fileId);
+            const localVarPath = `/qualified_electronic_signature/documents`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Token required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (workflowRunId !== undefined) {
+                localVarQueryParameter['workflow_run_id'] = workflowRunId;
+            }
+            if (fileId !== undefined) {
+                localVarQueryParameter['file_id'] = fileId;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Retrieves the signed evidence file for the designated Workflow Run
          * @summary Retrieve Workflow Run Evidence Summary File
@@ -3167,6 +3208,23 @@ export const DefaultApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Retrieves the signed document or application form depending on the file_id provided.
+         * @summary Retrieves the signed document or application form
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} fileId The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadQesDocument(workflowRunId, fileId, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadQesDocument(workflowRunId, fileId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.downloadQesDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Retrieves the signed evidence file for the designated Workflow Run
          * @summary Retrieve Workflow Run Evidence Summary File
@@ -4102,6 +4160,17 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
         downloadMotionCaptureFrame(motionCaptureId, options) {
             return localVarFp.downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves the signed document or application form depending on the file_id provided.
+         * @summary Retrieves the signed document or application form
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} fileId The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadQesDocument(workflowRunId, fileId, options) {
+            return localVarFp.downloadQesDocument(workflowRunId, fileId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieves the signed evidence file for the designated Workflow Run
          * @summary Retrieve Workflow Run Evidence Summary File
@@ -4793,6 +4862,18 @@ export class DefaultApi extends BaseAPI {
     downloadMotionCaptureFrame(motionCaptureId, options) {
         return DefaultApiFp(this.configuration).downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided.
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadQesDocument(workflowRunId, fileId, options) {
+        return DefaultApiFp(this.configuration).downloadQesDocument(workflowRunId, fileId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Retrieves the signed evidence file for the designated Workflow Run
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -5311,6 +5392,7 @@ export const ListWorkflowRunsSortEnum = {
  */
 export const UploadDocumentFileTypeEnum = {
     Jpg: 'jpg',
+    Jpeg: 'jpeg',
     Png: 'png',
     Pdf: 'pdf',
     UnknownDefaultOpenApi: '11184809'

package/dist/esm/configuration.js

@@ -29,7 +29,7 @@ export class Configuration {
         }
         this.apiKey = 'Token token=' + param.apiToken;
         this.basePath = param.basePath || BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
-        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.2.0' }) });
+        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.4.0' }) });
         this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onfido/api",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "description": "Node.js library for the Onfido API",
   "author": "OpenAPI-Generator Contributors",
   "repository": {