@onfido/api 4.6.0 → 5.0.0

package/dist/esm/api.d.ts

@@ -1658,12 +1658,6 @@ export interface DeviceIntelligenceReport {
      * @memberof DeviceIntelligenceReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof DeviceIntelligenceReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -1688,7 +1682,7 @@ export interface Document {
      * @type {string}
      * @memberof Document
      */
-    'file_type'?: DocumentFileTypeEnum;
+    'file_type'?: string;
     /**
      * The type of document
      * @type {DocumentTypes}
@@ -1750,14 +1744,6 @@ export interface Document {
      */
     'file_size'?: number;
 }
-export declare const DocumentFileTypeEnum: {
-    readonly Jpg: "jpg";
-    readonly Jpeg: "jpeg";
-    readonly Png: "png";
-    readonly Pdf: "pdf";
-    readonly UnknownDefaultOpenApi: "11184809";
-};
-export type DocumentFileTypeEnum = typeof DocumentFileTypeEnum[keyof typeof DocumentFileTypeEnum];
 export declare const DocumentSideEnum: {
     readonly Front: "front";
     readonly Back: "back";
@@ -3577,18 +3563,18 @@ export interface DocumentReport {
      * @memberof DocumentReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof DocumentReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
      * @memberof DocumentReport
      */
     'name': ReportName;
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof DocumentReport
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {DocumentBreakdown}
@@ -3602,6 +3588,19 @@ export interface DocumentReport {
      */
     'properties'?: DocumentProperties;
 }
+/**
+ *
+ * @export
+ * @interface DocumentReportShared
+ */
+export interface DocumentReportShared {
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof DocumentReportShared
+     */
+    'documents'?: Array<ReportDocument>;
+}
 /**
  *
  * @export
@@ -3656,7 +3655,7 @@ export interface DocumentShared {
      * @type {string}
      * @memberof DocumentShared
      */
-    'file_type'?: DocumentSharedFileTypeEnum;
+    'file_type'?: string;
     /**
      * The type of document
      * @type {DocumentTypes}
@@ -3682,14 +3681,6 @@ export interface DocumentShared {
      */
     'applicant_id'?: string;
 }
-export declare const DocumentSharedFileTypeEnum: {
-    readonly Jpg: "jpg";
-    readonly Jpeg: "jpeg";
-    readonly Png: "png";
-    readonly Pdf: "pdf";
-    readonly UnknownDefaultOpenApi: "11184809";
-};
-export type DocumentSharedFileTypeEnum = typeof DocumentSharedFileTypeEnum[keyof typeof DocumentSharedFileTypeEnum];
 export declare const DocumentSharedSideEnum: {
     readonly Front: "front";
     readonly Back: "back";
@@ -3829,18 +3820,18 @@ export interface DocumentVideoReport {
      * @memberof DocumentVideoReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof DocumentVideoReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
      * @memberof DocumentVideoReport
      */
     'name': ReportName;
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof DocumentVideoReport
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {DocumentBreakdown}
@@ -3902,18 +3893,18 @@ export interface DocumentVideoWithAddressInformationReport {
      * @memberof DocumentVideoWithAddressInformationReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof DocumentVideoWithAddressInformationReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
      * @memberof DocumentVideoWithAddressInformationReport
      */
     'name': ReportName;
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof DocumentVideoWithAddressInformationReport
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {DocumentBreakdown}
@@ -3975,18 +3966,18 @@ export interface DocumentWithAddressInformationReport {
      * @memberof DocumentWithAddressInformationReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof DocumentWithAddressInformationReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
      * @memberof DocumentWithAddressInformationReport
      */
     'name': ReportName;
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof DocumentWithAddressInformationReport
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {DocumentBreakdown}
@@ -4048,18 +4039,18 @@ export interface DocumentWithDriverVerificationReport {
      * @memberof DocumentWithDriverVerificationReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof DocumentWithDriverVerificationReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
      * @memberof DocumentWithDriverVerificationReport
      */
     'name': ReportName;
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof DocumentWithDriverVerificationReport
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {DocumentBreakdown}
@@ -4517,18 +4508,18 @@ export interface DocumentWithDrivingLicenceInformationReport {
      * @memberof DocumentWithDrivingLicenceInformationReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof DocumentWithDrivingLicenceInformationReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
      * @memberof DocumentWithDrivingLicenceInformationReport
      */
     'name': ReportName;
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof DocumentWithDrivingLicenceInformationReport
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {DocumentBreakdown}
@@ -5115,18 +5106,18 @@ export interface FacialSimilarityMotionReport {
      * @memberof FacialSimilarityMotionReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof FacialSimilarityMotionReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
      * @memberof FacialSimilarityMotionReport
      */
     'name': ReportName;
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof FacialSimilarityMotionReport
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      * Array of objects with live photo ids that were used in the Onfido engine.
      * @type {Array<FacialSimilarityReportMedia>}
@@ -5542,18 +5533,18 @@ export interface FacialSimilarityPhotoFullyAutoReport {
      * @memberof FacialSimilarityPhotoFullyAutoReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof FacialSimilarityPhotoFullyAutoReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
      * @memberof FacialSimilarityPhotoFullyAutoReport
      */
     'name': ReportName;
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof FacialSimilarityPhotoFullyAutoReport
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      * Array of objects with live photo ids that were used in the Onfido engine.
      * @type {Array<FacialSimilarityReportMedia>}
@@ -5652,18 +5643,18 @@ export interface FacialSimilarityPhotoReport {
      * @memberof FacialSimilarityPhotoReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof FacialSimilarityPhotoReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
      * @memberof FacialSimilarityPhotoReport
      */
     'name': ReportName;
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof FacialSimilarityPhotoReport
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      * Array of objects with live photo ids that were used in the Onfido engine.
      * @type {Array<FacialSimilarityReportMedia>}
@@ -5720,6 +5711,12 @@ export interface FacialSimilarityReportMedia {
  * @interface FacialSimilarityReportShared
  */
 export interface FacialSimilarityReportShared {
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof FacialSimilarityReportShared
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      * Array of objects with live photo ids that were used in the Onfido engine.
      * @type {Array<FacialSimilarityReportMedia>}
@@ -6002,18 +5999,18 @@ export interface FacialSimilarityVideoReport {
      * @memberof FacialSimilarityVideoReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof FacialSimilarityVideoReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
      * @memberof FacialSimilarityVideoReport
      */
     'name': ReportName;
+    /**
+     * Array of objects with document ids that were used in the Onfido engine.
+     * @type {Array<ReportDocument>}
+     * @memberof FacialSimilarityVideoReport
+     */
+    'documents'?: Array<ReportDocument>;
     /**
      * Array of objects with live photo ids that were used in the Onfido engine.
      * @type {Array<FacialSimilarityReportMedia>}
@@ -6585,12 +6582,6 @@ export interface IdentityEnhancedReport {
      * @memberof IdentityEnhancedReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof IdentityEnhancedReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -6658,12 +6649,6 @@ export interface IndiaPanReport {
      * @memberof IndiaPanReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof IndiaPanReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -6916,12 +6901,6 @@ export interface KnownFacesReport {
      * @memberof KnownFacesReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof KnownFacesReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -7579,12 +7558,6 @@ export interface ProofOfAddressReport {
      * @memberof ProofOfAddressReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof ProofOfAddressReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -7858,12 +7831,6 @@ export interface ReportShared {
      * @memberof ReportShared
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof ReportShared
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -8583,12 +8550,6 @@ export interface UsDrivingLicenceReport {
      * @memberof UsDrivingLicenceReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof UsDrivingLicenceReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -8871,11 +8832,11 @@ export interface WatchlistAmlBreakdownSanction {
 export interface WatchlistAmlProperties {
     /**
      * Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
-     * @type {Array<string>}
+     * @type {Array<object>}
      * @memberof WatchlistAmlProperties
      * @deprecated
      */
-    'records'?: Array<string>;
+    'records'?: Array<object>;
 }
 /**
  *
@@ -8925,12 +8886,6 @@ export interface WatchlistAmlReport {
      * @memberof WatchlistAmlReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof WatchlistAmlReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -9308,12 +9263,6 @@ export interface WatchlistEnhancedReport {
      * @memberof WatchlistEnhancedReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof WatchlistEnhancedReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -9593,12 +9542,6 @@ export interface WatchlistPepsOnlyReport {
      * @memberof WatchlistPepsOnlyReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof WatchlistPepsOnlyReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -9666,12 +9609,6 @@ export interface WatchlistSanctionsOnlyReport {
      * @memberof WatchlistSanctionsOnlyReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof WatchlistSanctionsOnlyReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -9724,11 +9661,11 @@ export interface WatchlistStandardBreakdown {
 export interface WatchlistStandardProperties {
     /**
      * Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
-     * @type {Array<string>}
+     * @type {Array<object>}
      * @memberof WatchlistStandardProperties
      * @deprecated
      */
-    'records'?: Array<string>;
+    'records'?: Array<object>;
 }
 /**
  *
@@ -9778,12 +9715,6 @@ export interface WatchlistStandardReport {
      * @memberof WatchlistStandardReport
      */
     'check_id'?: string;
-    /**
-     * Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
-     * @type {Array<ReportDocument>}
-     * @memberof WatchlistStandardReport
-     */
-    'documents'?: Array<ReportDocument>;
     /**
      *
      * @type {ReportName}
@@ -10015,7 +9946,7 @@ export interface WebhookEventPayloadObject {
      * @type {string}
      * @memberof WebhookEventPayloadObject
      */
-    'href': string;
+    'href'?: string;
 }
 /**
  * The resource affected by this event.
@@ -10159,7 +10090,6 @@ export declare const WebhookEventType: {
     readonly ReportAwaitingApproval: "report.awaiting_approval";
     readonly ReportCompleted: "report.completed";
     readonly WorkflowTimelineFileCreated: "workflow_timeline_file.created";
-    readonly WorkflowSignedEvidenceFileCreated: "workflow_signed_evidence_file.created";
     readonly WorkflowRunEvidenceFolderCreated: "workflow_run_evidence_folder.created";
     readonly UnknownDefaultOpenApi: "11184809";
 };
@@ -10853,6 +10783,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     downloadMotionCaptureFrame: (motionCaptureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
+     * @summary Download NFC face
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadNfcFace: (documentId: 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
@@ -11122,10 +11060,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
      * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
      * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
+     * @param {string} [applicantId] the applicant\&#39;s id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listWorkflowRuns: (page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listWorkflowRuns: (page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Run a health check on the Onfido API
      * @summary Ping
@@ -11206,7 +11145,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @param {DocumentTypes} type The type of document
      * @param {string} applicantId The ID of the applicant whose document is being uploaded.
      * @param {FileTransfer} file The file to be uploaded.
-     * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
+     * @param {string} [fileType] The file type of the uploaded file
      * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
      * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
      * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -11214,7 +11153,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    uploadDocument: (type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    uploadDocument: (type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
      * @summary Upload ID photo
@@ -11410,6 +11349,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
+    /**
+     * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
+     * @summary Download NFC face
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadNfcFace(documentId: 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
@@ -11679,10 +11626,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
      * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
      * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
+     * @param {string} [applicantId] the applicant\&#39;s id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowRun>>>;
+    listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowRun>>>;
     /**
      * Run a health check on the Onfido API
      * @summary Ping
@@ -11763,7 +11711,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @param {DocumentTypes} type The type of document
      * @param {string} applicantId The ID of the applicant whose document is being uploaded.
      * @param {FileTransfer} file The file to be uploaded.
-     * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
+     * @param {string} [fileType] The file type of the uploaded file
      * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
      * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
      * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -11771,7 +11719,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Document>>;
+    uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Document>>;
     /**
      * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
      * @summary Upload ID photo
@@ -11967,6 +11915,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
+    /**
+     * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
+     * @summary Download NFC face
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
     /**
      * Retrieves the signed document or application form depending on the file_id provided.
      * @summary Retrieves the signed document or application form
@@ -12236,10 +12192,11 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
      * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
      * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
+     * @param {string} [applicantId] the applicant\&#39;s id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowRun>>;
+    listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowRun>>;
     /**
      * Run a health check on the Onfido API
      * @summary Ping
@@ -12320,7 +12277,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @param {DocumentTypes} type The type of document
      * @param {string} applicantId The ID of the applicant whose document is being uploaded.
      * @param {FileTransfer} file The file to be uploaded.
-     * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
+     * @param {string} [fileType] The file type of the uploaded file
      * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
      * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
      * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -12328,7 +12285,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Document>;
+    uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Document>;
     /**
      * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
      * @summary Upload ID photo
@@ -12547,6 +12504,15 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
+    /**
+     * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
+     * @summary Download NFC face
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadNfcFace(documentId: 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
@@ -12848,11 +12814,12 @@ export declare class DefaultApi extends BaseAPI {
      * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
      * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
      * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
+     * @param {string} [applicantId] the applicant\&#39;s id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun[], any>>;
+    listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun[], any>>;
     /**
      * Run a health check on the Onfido API
      * @summary Ping
@@ -12942,7 +12909,7 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DocumentTypes} type The type of document
      * @param {string} applicantId The ID of the applicant whose document is being uploaded.
      * @param {FileTransfer} file The file to be uploaded.
-     * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
+     * @param {string} [fileType] The file type of the uploaded file
      * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
      * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
      * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -12951,7 +12918,7 @@ export declare class DefaultApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any>>;
+    uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any>>;
     /**
      * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
      * @summary Upload ID photo
@@ -12983,17 +12950,6 @@ export declare const ListWorkflowRunsSortEnum: {
     readonly UnknownDefaultOpenApi: "11184809";
 };
 export type ListWorkflowRunsSortEnum = typeof ListWorkflowRunsSortEnum[keyof typeof ListWorkflowRunsSortEnum];
-/**
- * @export
- */
-export declare const UploadDocumentFileTypeEnum: {
-    readonly Jpg: "jpg";
-    readonly Jpeg: "jpeg";
-    readonly Png: "png";
-    readonly Pdf: "pdf";
-    readonly UnknownDefaultOpenApi: "11184809";
-};
-export type UploadDocumentFileTypeEnum = typeof UploadDocumentFileTypeEnum[keyof typeof UploadDocumentFileTypeEnum];
 /**
  * @export
  */