@onfido/api 5.5.0 → 5.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/api.js CHANGED
@@ -511,9 +511,29 @@ export const DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum
511
511
  UnknownDefaultOpenApi: '11184809'
512
512
  };
513
513
  export const ExtractionDocumentClassificationSubtypeEnum = {
514
+ Spe: 'SPE',
515
+ Ali: 'ali',
516
+ Alien: 'alien',
517
+ Com: 'com',
518
+ Commercial: 'commercial',
519
+ Dom: 'dom',
520
+ Domestic: 'domestic',
514
521
  Full: 'full',
515
522
  NotFull: 'not_full',
523
+ FullDrivingLicence: 'full driving licence',
524
+ HeavyVehicle: 'heavy_vehicle',
525
+ Learner: 'learner',
526
+ MinorU21OrU18: 'minor (u21 or u18)',
527
+ Mot: 'mot',
528
+ Mul: 'mul',
516
529
  Provisional: 'provisional',
530
+ ProvisionalDrivingLicence: 'provisional driving licence',
531
+ Ser: 'ser',
532
+ Spe2: 'spe',
533
+ Special: 'special',
534
+ Standard: 'standard',
535
+ Tem: 'tem',
536
+ U21: 'u21',
517
537
  UnknownDefaultOpenApi: '11184809'
518
538
  };
519
539
  export const ExtractionExtractedDataGenderEnum = {
@@ -534,6 +554,16 @@ export const IdNumberTypeEnum = {
534
554
  Other: 'other',
535
555
  UnknownDefaultOpenApi: '11184809'
536
556
  };
557
+ export const PasskeyStateEnum = {
558
+ Active: 'ACTIVE',
559
+ Inactive: 'INACTIVE',
560
+ UnknownDefaultOpenApi: '11184809'
561
+ };
562
+ export const PasskeyUpdaterStateEnum = {
563
+ Active: 'ACTIVE',
564
+ Inactive: 'INACTIVE',
565
+ UnknownDefaultOpenApi: '11184809'
566
+ };
537
567
  export const ProofOfAddressPropertiesDocumentTypeEnum = {
538
568
  BankBuildingSocietyStatement: 'bank_building_society_statement',
539
569
  UtilityBill: 'utility_bill',
@@ -546,6 +576,13 @@ export const ProofOfAddressPropertiesDocumentTypeEnum = {
546
576
  PensionPropertyStatementLetter: 'pension_property_statement_letter',
547
577
  IdentityDocumentWithAddress: 'identity_document_with_address',
548
578
  ExchangeHouseStatement: 'exchange_house_statement',
579
+ AccommodationTenancyCertificate: 'accommodation_tenancy_certificate',
580
+ AddressCertificate: 'address_certificate',
581
+ ElectricityBill: 'electricity_bill',
582
+ GasBill: 'gas_bill',
583
+ InternetBill: 'internet_bill',
584
+ PhoneBill: 'phone_bill',
585
+ WaterBill: 'water_bill',
549
586
  UnknownDefaultOpenApi: '11184809'
550
587
  };
551
588
  export const RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum = {
@@ -1092,6 +1129,72 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
1092
1129
  options: localVarRequestOptions,
1093
1130
  };
1094
1131
  }),
1132
+ /**
1133
+ * Deletes a passkey.
1134
+ * @summary Delete passkey
1135
+ * @param {string} username Username that owns the passkey.
1136
+ * @param {string} passkeyId Passkey ID.
1137
+ * @param {*} [options] Override http request option.
1138
+ * @throws {RequiredError}
1139
+ */
1140
+ deletePasskey: (username, passkeyId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1141
+ // verify required parameter 'username' is not null or undefined
1142
+ assertParamExists('deletePasskey', 'username', username);
1143
+ // verify required parameter 'passkeyId' is not null or undefined
1144
+ assertParamExists('deletePasskey', 'passkeyId', passkeyId);
1145
+ const localVarPath = `/passkeys/{username}/{passkey_id}`
1146
+ .replace(`{${"username"}}`, encodeURIComponent(String(username)))
1147
+ .replace(`{${"passkey_id"}}`, encodeURIComponent(String(passkeyId)));
1148
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1149
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1150
+ let baseOptions;
1151
+ if (configuration) {
1152
+ baseOptions = configuration.baseOptions;
1153
+ }
1154
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
1155
+ const localVarHeaderParameter = {};
1156
+ const localVarQueryParameter = {};
1157
+ // authentication Token required
1158
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1159
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1160
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1161
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1162
+ return {
1163
+ url: toPathString(localVarUrlObj),
1164
+ options: localVarRequestOptions,
1165
+ };
1166
+ }),
1167
+ /**
1168
+ * Removes every passkey for the username.
1169
+ * @summary Delete passkeys
1170
+ * @param {string} username Username whose passkeys will be deleted.
1171
+ * @param {*} [options] Override http request option.
1172
+ * @throws {RequiredError}
1173
+ */
1174
+ deletePasskeys: (username, options = {}) => __awaiter(this, void 0, void 0, function* () {
1175
+ // verify required parameter 'username' is not null or undefined
1176
+ assertParamExists('deletePasskeys', 'username', username);
1177
+ const localVarPath = `/passkeys/{username}`
1178
+ .replace(`{${"username"}}`, encodeURIComponent(String(username)));
1179
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1180
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1181
+ let baseOptions;
1182
+ if (configuration) {
1183
+ baseOptions = configuration.baseOptions;
1184
+ }
1185
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
1186
+ const localVarHeaderParameter = {};
1187
+ const localVarQueryParameter = {};
1188
+ // authentication Token required
1189
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1190
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1191
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1192
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1193
+ return {
1194
+ url: toPathString(localVarUrlObj),
1195
+ options: localVarRequestOptions,
1196
+ };
1197
+ }),
1095
1198
  /**
1096
1199
  * Deactivates the given monitor
1097
1200
  * @summary Delete monitor
@@ -1573,6 +1676,45 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
1573
1676
  options: localVarRequestOptions,
1574
1677
  };
1575
1678
  }),
1679
+ /**
1680
+ * Retrieves the signed document or signing transaction receipt depending on the id provided.
1681
+ * @summary Retrieves the signed document or signing transaction receipt
1682
+ * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
1683
+ * @param {string} id The unique identifier of the file which you want to retrieve.
1684
+ * @param {*} [options] Override http request option.
1685
+ * @throws {RequiredError}
1686
+ */
1687
+ downloadSesDocument: (workflowRunId, id, options = {}) => __awaiter(this, void 0, void 0, function* () {
1688
+ // verify required parameter 'workflowRunId' is not null or undefined
1689
+ assertParamExists('downloadSesDocument', 'workflowRunId', workflowRunId);
1690
+ // verify required parameter 'id' is not null or undefined
1691
+ assertParamExists('downloadSesDocument', 'id', id);
1692
+ const localVarPath = `/simple_electronic_signature/documents`;
1693
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1694
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1695
+ let baseOptions;
1696
+ if (configuration) {
1697
+ baseOptions = configuration.baseOptions;
1698
+ }
1699
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1700
+ const localVarHeaderParameter = {};
1701
+ const localVarQueryParameter = {};
1702
+ // authentication Token required
1703
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1704
+ if (workflowRunId !== undefined) {
1705
+ localVarQueryParameter['workflow_run_id'] = workflowRunId;
1706
+ }
1707
+ if (id !== undefined) {
1708
+ localVarQueryParameter['id'] = id;
1709
+ }
1710
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1711
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1712
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1713
+ return {
1714
+ url: toPathString(localVarUrlObj),
1715
+ options: localVarRequestOptions,
1716
+ };
1717
+ }),
1576
1718
  /**
1577
1719
  * Retrieves the signed evidence file for the designated Workflow Run
1578
1720
  * @summary Retrieve Workflow Run Evidence Summary File
@@ -1604,6 +1746,37 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
1604
1746
  options: localVarRequestOptions,
1605
1747
  };
1606
1748
  }),
1749
+ /**
1750
+ * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
1751
+ * @summary Download signing document
1752
+ * @param {string} signingDocumentId
1753
+ * @param {*} [options] Override http request option.
1754
+ * @throws {RequiredError}
1755
+ */
1756
+ downloadSigningDocument: (signingDocumentId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1757
+ // verify required parameter 'signingDocumentId' is not null or undefined
1758
+ assertParamExists('downloadSigningDocument', 'signingDocumentId', signingDocumentId);
1759
+ const localVarPath = `/signing_documents/{signing_document_id}/download`
1760
+ .replace(`{${"signing_document_id"}}`, encodeURIComponent(String(signingDocumentId)));
1761
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1762
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1763
+ let baseOptions;
1764
+ if (configuration) {
1765
+ baseOptions = configuration.baseOptions;
1766
+ }
1767
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1768
+ const localVarHeaderParameter = {};
1769
+ const localVarQueryParameter = {};
1770
+ // authentication Token required
1771
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1772
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1773
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1774
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1775
+ return {
1776
+ url: toPathString(localVarUrlObj),
1777
+ options: localVarRequestOptions,
1778
+ };
1779
+ }),
1607
1780
  /**
1608
1781
  * Extract information from a document
1609
1782
  * @summary Autofill
@@ -1917,6 +2090,41 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
1917
2090
  options: localVarRequestOptions,
1918
2091
  };
1919
2092
  }),
2093
+ /**
2094
+ * Returns a passkey\'s details.
2095
+ * @summary Retrieve passkey
2096
+ * @param {string} username Username that owns the passkey.
2097
+ * @param {string} passkeyId Passkey ID.
2098
+ * @param {*} [options] Override http request option.
2099
+ * @throws {RequiredError}
2100
+ */
2101
+ findPasskey: (username, passkeyId, options = {}) => __awaiter(this, void 0, void 0, function* () {
2102
+ // verify required parameter 'username' is not null or undefined
2103
+ assertParamExists('findPasskey', 'username', username);
2104
+ // verify required parameter 'passkeyId' is not null or undefined
2105
+ assertParamExists('findPasskey', 'passkeyId', passkeyId);
2106
+ const localVarPath = `/passkeys/{username}/{passkey_id}`
2107
+ .replace(`{${"username"}}`, encodeURIComponent(String(username)))
2108
+ .replace(`{${"passkey_id"}}`, encodeURIComponent(String(passkeyId)));
2109
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2110
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2111
+ let baseOptions;
2112
+ if (configuration) {
2113
+ baseOptions = configuration.baseOptions;
2114
+ }
2115
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
2116
+ const localVarHeaderParameter = {};
2117
+ const localVarQueryParameter = {};
2118
+ // authentication Token required
2119
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
2120
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2121
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2122
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2123
+ return {
2124
+ url: toPathString(localVarUrlObj),
2125
+ options: localVarRequestOptions,
2126
+ };
2127
+ }),
1920
2128
  /**
1921
2129
  * A single report can be retrieved using this endpoint with the corresponding unique identifier.
1922
2130
  * @summary Retrieve report
@@ -1948,6 +2156,37 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
1948
2156
  options: localVarRequestOptions,
1949
2157
  };
1950
2158
  }),
2159
+ /**
2160
+ * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
2161
+ * @summary Retrieve signing document
2162
+ * @param {string} signingDocumentId
2163
+ * @param {*} [options] Override http request option.
2164
+ * @throws {RequiredError}
2165
+ */
2166
+ findSigningDocument: (signingDocumentId, options = {}) => __awaiter(this, void 0, void 0, function* () {
2167
+ // verify required parameter 'signingDocumentId' is not null or undefined
2168
+ assertParamExists('findSigningDocument', 'signingDocumentId', signingDocumentId);
2169
+ const localVarPath = `/signing_documents/{signing_document_id}`
2170
+ .replace(`{${"signing_document_id"}}`, encodeURIComponent(String(signingDocumentId)));
2171
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2172
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2173
+ let baseOptions;
2174
+ if (configuration) {
2175
+ baseOptions = configuration.baseOptions;
2176
+ }
2177
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
2178
+ const localVarHeaderParameter = {};
2179
+ const localVarQueryParameter = {};
2180
+ // authentication Token required
2181
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
2182
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2183
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2184
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2185
+ return {
2186
+ url: toPathString(localVarUrlObj),
2187
+ options: localVarRequestOptions,
2188
+ };
2189
+ }),
1951
2190
  /**
1952
2191
  * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
1953
2192
  * @summary Retrieve Task
@@ -2411,6 +2650,37 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2411
2650
  options: localVarRequestOptions,
2412
2651
  };
2413
2652
  }),
2653
+ /**
2654
+ * Returns every passkey registered under the supplied username.
2655
+ * @summary List passkeys
2656
+ * @param {string} username Username that owns the passkeys.
2657
+ * @param {*} [options] Override http request option.
2658
+ * @throws {RequiredError}
2659
+ */
2660
+ listPasskeys: (username, options = {}) => __awaiter(this, void 0, void 0, function* () {
2661
+ // verify required parameter 'username' is not null or undefined
2662
+ assertParamExists('listPasskeys', 'username', username);
2663
+ const localVarPath = `/passkeys/{username}`
2664
+ .replace(`{${"username"}}`, encodeURIComponent(String(username)));
2665
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2666
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2667
+ let baseOptions;
2668
+ if (configuration) {
2669
+ baseOptions = configuration.baseOptions;
2670
+ }
2671
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
2672
+ const localVarHeaderParameter = {};
2673
+ const localVarQueryParameter = {};
2674
+ // authentication Token required
2675
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
2676
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2677
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2678
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2679
+ return {
2680
+ url: toPathString(localVarUrlObj),
2681
+ options: localVarRequestOptions,
2682
+ };
2683
+ }),
2414
2684
  /**
2415
2685
  * Returns all repeat attempts for a given Document report
2416
2686
  * @summary Retrieve repeat attempts
@@ -2475,6 +2745,39 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2475
2745
  options: localVarRequestOptions,
2476
2746
  };
2477
2747
  }),
2748
+ /**
2749
+ * All signing documents belonging to an applicant can be listed from this endpoint
2750
+ * @summary List signing documents
2751
+ * @param {string} applicantId
2752
+ * @param {*} [options] Override http request option.
2753
+ * @throws {RequiredError}
2754
+ */
2755
+ listSigningDocuments: (applicantId, options = {}) => __awaiter(this, void 0, void 0, function* () {
2756
+ // verify required parameter 'applicantId' is not null or undefined
2757
+ assertParamExists('listSigningDocuments', 'applicantId', applicantId);
2758
+ const localVarPath = `/signing_documents`;
2759
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2760
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2761
+ let baseOptions;
2762
+ if (configuration) {
2763
+ baseOptions = configuration.baseOptions;
2764
+ }
2765
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
2766
+ const localVarHeaderParameter = {};
2767
+ const localVarQueryParameter = {};
2768
+ // authentication Token required
2769
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
2770
+ if (applicantId !== undefined) {
2771
+ localVarQueryParameter['applicant_id'] = applicantId;
2772
+ }
2773
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2774
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2775
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2776
+ return {
2777
+ url: toPathString(localVarUrlObj),
2778
+ options: localVarRequestOptions,
2779
+ };
2780
+ }),
2478
2781
  /**
2479
2782
  * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
2480
2783
  * @summary List Tasks
@@ -2876,6 +3179,46 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2876
3179
  options: localVarRequestOptions,
2877
3180
  };
2878
3181
  }),
3182
+ /**
3183
+ * Updates a passkey\'s state.
3184
+ * @summary Update passkey
3185
+ * @param {string} username Username that owns the passkey.
3186
+ * @param {string} passkeyId Passkey ID.
3187
+ * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
3188
+ * @param {*} [options] Override http request option.
3189
+ * @throws {RequiredError}
3190
+ */
3191
+ updatePasskey: (username, passkeyId, passkeyUpdater, options = {}) => __awaiter(this, void 0, void 0, function* () {
3192
+ // verify required parameter 'username' is not null or undefined
3193
+ assertParamExists('updatePasskey', 'username', username);
3194
+ // verify required parameter 'passkeyId' is not null or undefined
3195
+ assertParamExists('updatePasskey', 'passkeyId', passkeyId);
3196
+ // verify required parameter 'passkeyUpdater' is not null or undefined
3197
+ assertParamExists('updatePasskey', 'passkeyUpdater', passkeyUpdater);
3198
+ const localVarPath = `/passkeys/{username}/{passkey_id}`
3199
+ .replace(`{${"username"}}`, encodeURIComponent(String(username)))
3200
+ .replace(`{${"passkey_id"}}`, encodeURIComponent(String(passkeyId)));
3201
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3202
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3203
+ let baseOptions;
3204
+ if (configuration) {
3205
+ baseOptions = configuration.baseOptions;
3206
+ }
3207
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
3208
+ const localVarHeaderParameter = {};
3209
+ const localVarQueryParameter = {};
3210
+ // authentication Token required
3211
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
3212
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3213
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3214
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3215
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
3216
+ localVarRequestOptions.data = serializeDataIfNeeded(passkeyUpdater, localVarRequestOptions, configuration);
3217
+ return {
3218
+ url: toPathString(localVarUrlObj),
3219
+ options: localVarRequestOptions,
3220
+ };
3221
+ }),
2879
3222
  /**
2880
3223
  * Update the status of the given matches
2881
3224
  * @summary Set match status (BETA)
@@ -3096,6 +3439,48 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
3096
3439
  options: localVarRequestOptions,
3097
3440
  };
3098
3441
  }),
3442
+ /**
3443
+ * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.
3444
+ * @summary Upload a signing document
3445
+ * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
3446
+ * @param {FileTransfer} file The file to be uploaded.
3447
+ * @param {*} [options] Override http request option.
3448
+ * @throws {RequiredError}
3449
+ */
3450
+ uploadSigningDocument: (applicantId, file, options = {}) => __awaiter(this, void 0, void 0, function* () {
3451
+ // verify required parameter 'applicantId' is not null or undefined
3452
+ assertParamExists('uploadSigningDocument', 'applicantId', applicantId);
3453
+ // verify required parameter 'file' is not null or undefined
3454
+ assertParamExists('uploadSigningDocument', 'file', file);
3455
+ const localVarPath = `/signing_documents`;
3456
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3457
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3458
+ let baseOptions;
3459
+ if (configuration) {
3460
+ baseOptions = configuration.baseOptions;
3461
+ }
3462
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
3463
+ const localVarHeaderParameter = {};
3464
+ const localVarQueryParameter = {};
3465
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
3466
+ // authentication Token required
3467
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
3468
+ if (applicantId !== undefined) {
3469
+ localVarFormParams.append('applicant_id', applicantId);
3470
+ }
3471
+ if (file !== undefined) {
3472
+ localVarFormParams.append('file', file.buffer, file.filename);
3473
+ }
3474
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
3475
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3476
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3477
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
3478
+ localVarRequestOptions.data = localVarFormParams;
3479
+ return {
3480
+ url: toPathString(localVarUrlObj),
3481
+ options: localVarRequestOptions,
3482
+ };
3483
+ }),
3099
3484
  };
3100
3485
  };
3101
3486
  /**
@@ -3251,6 +3636,39 @@ export const DefaultApiFp = function (configuration) {
3251
3636
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3252
3637
  });
3253
3638
  },
3639
+ /**
3640
+ * Deletes a passkey.
3641
+ * @summary Delete passkey
3642
+ * @param {string} username Username that owns the passkey.
3643
+ * @param {string} passkeyId Passkey ID.
3644
+ * @param {*} [options] Override http request option.
3645
+ * @throws {RequiredError}
3646
+ */
3647
+ deletePasskey(username, passkeyId, options) {
3648
+ var _a, _b, _c;
3649
+ return __awaiter(this, void 0, void 0, function* () {
3650
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePasskey(username, passkeyId, options);
3651
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3652
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.deletePasskey']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3653
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3654
+ });
3655
+ },
3656
+ /**
3657
+ * Removes every passkey for the username.
3658
+ * @summary Delete passkeys
3659
+ * @param {string} username Username whose passkeys will be deleted.
3660
+ * @param {*} [options] Override http request option.
3661
+ * @throws {RequiredError}
3662
+ */
3663
+ deletePasskeys(username, options) {
3664
+ var _a, _b, _c;
3665
+ return __awaiter(this, void 0, void 0, function* () {
3666
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePasskeys(username, options);
3667
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3668
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.deletePasskeys']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3669
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3670
+ });
3671
+ },
3254
3672
  /**
3255
3673
  * Deactivates the given monitor
3256
3674
  * @summary Delete monitor
@@ -3493,6 +3911,23 @@ export const DefaultApiFp = function (configuration) {
3493
3911
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3494
3912
  });
3495
3913
  },
3914
+ /**
3915
+ * Retrieves the signed document or signing transaction receipt depending on the id provided.
3916
+ * @summary Retrieves the signed document or signing transaction receipt
3917
+ * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
3918
+ * @param {string} id The unique identifier of the file which you want to retrieve.
3919
+ * @param {*} [options] Override http request option.
3920
+ * @throws {RequiredError}
3921
+ */
3922
+ downloadSesDocument(workflowRunId, id, options) {
3923
+ var _a, _b, _c;
3924
+ return __awaiter(this, void 0, void 0, function* () {
3925
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadSesDocument(workflowRunId, id, options);
3926
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3927
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.downloadSesDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3928
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3929
+ });
3930
+ },
3496
3931
  /**
3497
3932
  * Retrieves the signed evidence file for the designated Workflow Run
3498
3933
  * @summary Retrieve Workflow Run Evidence Summary File
@@ -3509,6 +3944,22 @@ export const DefaultApiFp = function (configuration) {
3509
3944
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3510
3945
  });
3511
3946
  },
3947
+ /**
3948
+ * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
3949
+ * @summary Download signing document
3950
+ * @param {string} signingDocumentId
3951
+ * @param {*} [options] Override http request option.
3952
+ * @throws {RequiredError}
3953
+ */
3954
+ downloadSigningDocument(signingDocumentId, options) {
3955
+ var _a, _b, _c;
3956
+ return __awaiter(this, void 0, void 0, function* () {
3957
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadSigningDocument(signingDocumentId, options);
3958
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3959
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.downloadSigningDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3960
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3961
+ });
3962
+ },
3512
3963
  /**
3513
3964
  * Extract information from a document
3514
3965
  * @summary Autofill
@@ -3669,6 +4120,23 @@ export const DefaultApiFp = function (configuration) {
3669
4120
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3670
4121
  });
3671
4122
  },
4123
+ /**
4124
+ * Returns a passkey\'s details.
4125
+ * @summary Retrieve passkey
4126
+ * @param {string} username Username that owns the passkey.
4127
+ * @param {string} passkeyId Passkey ID.
4128
+ * @param {*} [options] Override http request option.
4129
+ * @throws {RequiredError}
4130
+ */
4131
+ findPasskey(username, passkeyId, options) {
4132
+ var _a, _b, _c;
4133
+ return __awaiter(this, void 0, void 0, function* () {
4134
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.findPasskey(username, passkeyId, options);
4135
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
4136
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.findPasskey']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
4137
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4138
+ });
4139
+ },
3672
4140
  /**
3673
4141
  * A single report can be retrieved using this endpoint with the corresponding unique identifier.
3674
4142
  * @summary Retrieve report
@@ -3685,6 +4153,22 @@ export const DefaultApiFp = function (configuration) {
3685
4153
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3686
4154
  });
3687
4155
  },
4156
+ /**
4157
+ * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
4158
+ * @summary Retrieve signing document
4159
+ * @param {string} signingDocumentId
4160
+ * @param {*} [options] Override http request option.
4161
+ * @throws {RequiredError}
4162
+ */
4163
+ findSigningDocument(signingDocumentId, options) {
4164
+ var _a, _b, _c;
4165
+ return __awaiter(this, void 0, void 0, function* () {
4166
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.findSigningDocument(signingDocumentId, options);
4167
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
4168
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.findSigningDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
4169
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4170
+ });
4171
+ },
3688
4172
  /**
3689
4173
  * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
3690
4174
  * @summary Retrieve Task
@@ -3913,6 +4397,22 @@ export const DefaultApiFp = function (configuration) {
3913
4397
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3914
4398
  });
3915
4399
  },
4400
+ /**
4401
+ * Returns every passkey registered under the supplied username.
4402
+ * @summary List passkeys
4403
+ * @param {string} username Username that owns the passkeys.
4404
+ * @param {*} [options] Override http request option.
4405
+ * @throws {RequiredError}
4406
+ */
4407
+ listPasskeys(username, options) {
4408
+ var _a, _b, _c;
4409
+ return __awaiter(this, void 0, void 0, function* () {
4410
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listPasskeys(username, options);
4411
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
4412
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.listPasskeys']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
4413
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4414
+ });
4415
+ },
3916
4416
  /**
3917
4417
  * Returns all repeat attempts for a given Document report
3918
4418
  * @summary Retrieve repeat attempts
@@ -3945,6 +4445,22 @@ export const DefaultApiFp = function (configuration) {
3945
4445
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3946
4446
  });
3947
4447
  },
4448
+ /**
4449
+ * All signing documents belonging to an applicant can be listed from this endpoint
4450
+ * @summary List signing documents
4451
+ * @param {string} applicantId
4452
+ * @param {*} [options] Override http request option.
4453
+ * @throws {RequiredError}
4454
+ */
4455
+ listSigningDocuments(applicantId, options) {
4456
+ var _a, _b, _c;
4457
+ return __awaiter(this, void 0, void 0, function* () {
4458
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listSigningDocuments(applicantId, options);
4459
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
4460
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.listSigningDocuments']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
4461
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4462
+ });
4463
+ },
3948
4464
  /**
3949
4465
  * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
3950
4466
  * @summary List Tasks
@@ -4142,6 +4658,24 @@ export const DefaultApiFp = function (configuration) {
4142
4658
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4143
4659
  });
4144
4660
  },
4661
+ /**
4662
+ * Updates a passkey\'s state.
4663
+ * @summary Update passkey
4664
+ * @param {string} username Username that owns the passkey.
4665
+ * @param {string} passkeyId Passkey ID.
4666
+ * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
4667
+ * @param {*} [options] Override http request option.
4668
+ * @throws {RequiredError}
4669
+ */
4670
+ updatePasskey(username, passkeyId, passkeyUpdater, options) {
4671
+ var _a, _b, _c;
4672
+ return __awaiter(this, void 0, void 0, function* () {
4673
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePasskey(username, passkeyId, passkeyUpdater, options);
4674
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
4675
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.updatePasskey']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
4676
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4677
+ });
4678
+ },
4145
4679
  /**
4146
4680
  * Update the status of the given matches
4147
4681
  * @summary Set match status (BETA)
@@ -4234,6 +4768,23 @@ export const DefaultApiFp = function (configuration) {
4234
4768
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4235
4769
  });
4236
4770
  },
4771
+ /**
4772
+ * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.
4773
+ * @summary Upload a signing document
4774
+ * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
4775
+ * @param {FileTransfer} file The file to be uploaded.
4776
+ * @param {*} [options] Override http request option.
4777
+ * @throws {RequiredError}
4778
+ */
4779
+ uploadSigningDocument(applicantId, file, options) {
4780
+ var _a, _b, _c;
4781
+ return __awaiter(this, void 0, void 0, function* () {
4782
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadSigningDocument(applicantId, file, options);
4783
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
4784
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.uploadSigningDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
4785
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4786
+ });
4787
+ },
4237
4788
  };
4238
4789
  };
4239
4790
  /**
@@ -4335,6 +4886,27 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4335
4886
  deleteApplicant(applicantId, options) {
4336
4887
  return localVarFp.deleteApplicant(applicantId, options).then((request) => request(axios, basePath));
4337
4888
  },
4889
+ /**
4890
+ * Deletes a passkey.
4891
+ * @summary Delete passkey
4892
+ * @param {string} username Username that owns the passkey.
4893
+ * @param {string} passkeyId Passkey ID.
4894
+ * @param {*} [options] Override http request option.
4895
+ * @throws {RequiredError}
4896
+ */
4897
+ deletePasskey(username, passkeyId, options) {
4898
+ return localVarFp.deletePasskey(username, passkeyId, options).then((request) => request(axios, basePath));
4899
+ },
4900
+ /**
4901
+ * Removes every passkey for the username.
4902
+ * @summary Delete passkeys
4903
+ * @param {string} username Username whose passkeys will be deleted.
4904
+ * @param {*} [options] Override http request option.
4905
+ * @throws {RequiredError}
4906
+ */
4907
+ deletePasskeys(username, options) {
4908
+ return localVarFp.deletePasskeys(username, options).then((request) => request(axios, basePath));
4909
+ },
4338
4910
  /**
4339
4911
  * Deactivates the given monitor
4340
4912
  * @summary Delete monitor
@@ -4487,6 +5059,17 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4487
5059
  downloadQesDocument(workflowRunId, fileId, options) {
4488
5060
  return localVarFp.downloadQesDocument(workflowRunId, fileId, options).then((request) => request(axios, basePath));
4489
5061
  },
5062
+ /**
5063
+ * Retrieves the signed document or signing transaction receipt depending on the id provided.
5064
+ * @summary Retrieves the signed document or signing transaction receipt
5065
+ * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
5066
+ * @param {string} id The unique identifier of the file which you want to retrieve.
5067
+ * @param {*} [options] Override http request option.
5068
+ * @throws {RequiredError}
5069
+ */
5070
+ downloadSesDocument(workflowRunId, id, options) {
5071
+ return localVarFp.downloadSesDocument(workflowRunId, id, options).then((request) => request(axios, basePath));
5072
+ },
4490
5073
  /**
4491
5074
  * Retrieves the signed evidence file for the designated Workflow Run
4492
5075
  * @summary Retrieve Workflow Run Evidence Summary File
@@ -4497,6 +5080,16 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4497
5080
  downloadSignedEvidenceFile(workflowRunId, options) {
4498
5081
  return localVarFp.downloadSignedEvidenceFile(workflowRunId, options).then((request) => request(axios, basePath));
4499
5082
  },
5083
+ /**
5084
+ * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
5085
+ * @summary Download signing document
5086
+ * @param {string} signingDocumentId
5087
+ * @param {*} [options] Override http request option.
5088
+ * @throws {RequiredError}
5089
+ */
5090
+ downloadSigningDocument(signingDocumentId, options) {
5091
+ return localVarFp.downloadSigningDocument(signingDocumentId, options).then((request) => request(axios, basePath));
5092
+ },
4500
5093
  /**
4501
5094
  * Extract information from a document
4502
5095
  * @summary Autofill
@@ -4597,6 +5190,17 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4597
5190
  findMotionCapture(motionCaptureId, options) {
4598
5191
  return localVarFp.findMotionCapture(motionCaptureId, options).then((request) => request(axios, basePath));
4599
5192
  },
5193
+ /**
5194
+ * Returns a passkey\'s details.
5195
+ * @summary Retrieve passkey
5196
+ * @param {string} username Username that owns the passkey.
5197
+ * @param {string} passkeyId Passkey ID.
5198
+ * @param {*} [options] Override http request option.
5199
+ * @throws {RequiredError}
5200
+ */
5201
+ findPasskey(username, passkeyId, options) {
5202
+ return localVarFp.findPasskey(username, passkeyId, options).then((request) => request(axios, basePath));
5203
+ },
4600
5204
  /**
4601
5205
  * A single report can be retrieved using this endpoint with the corresponding unique identifier.
4602
5206
  * @summary Retrieve report
@@ -4607,6 +5211,16 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4607
5211
  findReport(reportId, options) {
4608
5212
  return localVarFp.findReport(reportId, options).then((request) => request(axios, basePath));
4609
5213
  },
5214
+ /**
5215
+ * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
5216
+ * @summary Retrieve signing document
5217
+ * @param {string} signingDocumentId
5218
+ * @param {*} [options] Override http request option.
5219
+ * @throws {RequiredError}
5220
+ */
5221
+ findSigningDocument(signingDocumentId, options) {
5222
+ return localVarFp.findSigningDocument(signingDocumentId, options).then((request) => request(axios, basePath));
5223
+ },
4610
5224
  /**
4611
5225
  * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
4612
5226
  * @summary Retrieve Task
@@ -4751,6 +5365,16 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4751
5365
  listMotionCaptures(applicantId, options) {
4752
5366
  return localVarFp.listMotionCaptures(applicantId, options).then((request) => request(axios, basePath));
4753
5367
  },
5368
+ /**
5369
+ * Returns every passkey registered under the supplied username.
5370
+ * @summary List passkeys
5371
+ * @param {string} username Username that owns the passkeys.
5372
+ * @param {*} [options] Override http request option.
5373
+ * @throws {RequiredError}
5374
+ */
5375
+ listPasskeys(username, options) {
5376
+ return localVarFp.listPasskeys(username, options).then((request) => request(axios, basePath));
5377
+ },
4754
5378
  /**
4755
5379
  * Returns all repeat attempts for a given Document report
4756
5380
  * @summary Retrieve repeat attempts
@@ -4771,6 +5395,16 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4771
5395
  listReports(checkId, options) {
4772
5396
  return localVarFp.listReports(checkId, options).then((request) => request(axios, basePath));
4773
5397
  },
5398
+ /**
5399
+ * All signing documents belonging to an applicant can be listed from this endpoint
5400
+ * @summary List signing documents
5401
+ * @param {string} applicantId
5402
+ * @param {*} [options] Override http request option.
5403
+ * @throws {RequiredError}
5404
+ */
5405
+ listSigningDocuments(applicantId, options) {
5406
+ return localVarFp.listSigningDocuments(applicantId, options).then((request) => request(axios, basePath));
5407
+ },
4774
5408
  /**
4775
5409
  * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
4776
5410
  * @summary List Tasks
@@ -4896,6 +5530,18 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4896
5530
  updateApplicant(applicantId, applicantUpdater, options) {
4897
5531
  return localVarFp.updateApplicant(applicantId, applicantUpdater, options).then((request) => request(axios, basePath));
4898
5532
  },
5533
+ /**
5534
+ * Updates a passkey\'s state.
5535
+ * @summary Update passkey
5536
+ * @param {string} username Username that owns the passkey.
5537
+ * @param {string} passkeyId Passkey ID.
5538
+ * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
5539
+ * @param {*} [options] Override http request option.
5540
+ * @throws {RequiredError}
5541
+ */
5542
+ updatePasskey(username, passkeyId, passkeyUpdater, options) {
5543
+ return localVarFp.updatePasskey(username, passkeyId, passkeyUpdater, options).then((request) => request(axios, basePath));
5544
+ },
4899
5545
  /**
4900
5546
  * Update the status of the given matches
4901
5547
  * @summary Set match status (BETA)
@@ -4958,6 +5604,17 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4958
5604
  uploadLivePhoto(applicantId, file, advancedValidation, options) {
4959
5605
  return localVarFp.uploadLivePhoto(applicantId, file, advancedValidation, options).then((request) => request(axios, basePath));
4960
5606
  },
5607
+ /**
5608
+ * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.
5609
+ * @summary Upload a signing document
5610
+ * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
5611
+ * @param {FileTransfer} file The file to be uploaded.
5612
+ * @param {*} [options] Override http request option.
5613
+ * @throws {RequiredError}
5614
+ */
5615
+ uploadSigningDocument(applicantId, file, options) {
5616
+ return localVarFp.uploadSigningDocument(applicantId, file, options).then((request) => request(axios, basePath));
5617
+ },
4961
5618
  };
4962
5619
  };
4963
5620
  /**
@@ -5068,6 +5725,29 @@ export class DefaultApi extends BaseAPI {
5068
5725
  deleteApplicant(applicantId, options) {
5069
5726
  return DefaultApiFp(this.configuration).deleteApplicant(applicantId, options).then((request) => request(this.axios, this.basePath));
5070
5727
  }
5728
+ /**
5729
+ * Deletes a passkey.
5730
+ * @summary Delete passkey
5731
+ * @param {string} username Username that owns the passkey.
5732
+ * @param {string} passkeyId Passkey ID.
5733
+ * @param {*} [options] Override http request option.
5734
+ * @throws {RequiredError}
5735
+ * @memberof DefaultApi
5736
+ */
5737
+ deletePasskey(username, passkeyId, options) {
5738
+ return DefaultApiFp(this.configuration).deletePasskey(username, passkeyId, options).then((request) => request(this.axios, this.basePath));
5739
+ }
5740
+ /**
5741
+ * Removes every passkey for the username.
5742
+ * @summary Delete passkeys
5743
+ * @param {string} username Username whose passkeys will be deleted.
5744
+ * @param {*} [options] Override http request option.
5745
+ * @throws {RequiredError}
5746
+ * @memberof DefaultApi
5747
+ */
5748
+ deletePasskeys(username, options) {
5749
+ return DefaultApiFp(this.configuration).deletePasskeys(username, options).then((request) => request(this.axios, this.basePath));
5750
+ }
5071
5751
  /**
5072
5752
  * Deactivates the given monitor
5073
5753
  * @summary Delete monitor
@@ -5235,6 +5915,18 @@ export class DefaultApi extends BaseAPI {
5235
5915
  downloadQesDocument(workflowRunId, fileId, options) {
5236
5916
  return DefaultApiFp(this.configuration).downloadQesDocument(workflowRunId, fileId, options).then((request) => request(this.axios, this.basePath));
5237
5917
  }
5918
+ /**
5919
+ * Retrieves the signed document or signing transaction receipt depending on the id provided.
5920
+ * @summary Retrieves the signed document or signing transaction receipt
5921
+ * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
5922
+ * @param {string} id The unique identifier of the file which you want to retrieve.
5923
+ * @param {*} [options] Override http request option.
5924
+ * @throws {RequiredError}
5925
+ * @memberof DefaultApi
5926
+ */
5927
+ downloadSesDocument(workflowRunId, id, options) {
5928
+ return DefaultApiFp(this.configuration).downloadSesDocument(workflowRunId, id, options).then((request) => request(this.axios, this.basePath));
5929
+ }
5238
5930
  /**
5239
5931
  * Retrieves the signed evidence file for the designated Workflow Run
5240
5932
  * @summary Retrieve Workflow Run Evidence Summary File
@@ -5246,6 +5938,17 @@ export class DefaultApi extends BaseAPI {
5246
5938
  downloadSignedEvidenceFile(workflowRunId, options) {
5247
5939
  return DefaultApiFp(this.configuration).downloadSignedEvidenceFile(workflowRunId, options).then((request) => request(this.axios, this.basePath));
5248
5940
  }
5941
+ /**
5942
+ * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
5943
+ * @summary Download signing document
5944
+ * @param {string} signingDocumentId
5945
+ * @param {*} [options] Override http request option.
5946
+ * @throws {RequiredError}
5947
+ * @memberof DefaultApi
5948
+ */
5949
+ downloadSigningDocument(signingDocumentId, options) {
5950
+ return DefaultApiFp(this.configuration).downloadSigningDocument(signingDocumentId, options).then((request) => request(this.axios, this.basePath));
5951
+ }
5249
5952
  /**
5250
5953
  * Extract information from a document
5251
5954
  * @summary Autofill
@@ -5356,6 +6059,18 @@ export class DefaultApi extends BaseAPI {
5356
6059
  findMotionCapture(motionCaptureId, options) {
5357
6060
  return DefaultApiFp(this.configuration).findMotionCapture(motionCaptureId, options).then((request) => request(this.axios, this.basePath));
5358
6061
  }
6062
+ /**
6063
+ * Returns a passkey\'s details.
6064
+ * @summary Retrieve passkey
6065
+ * @param {string} username Username that owns the passkey.
6066
+ * @param {string} passkeyId Passkey ID.
6067
+ * @param {*} [options] Override http request option.
6068
+ * @throws {RequiredError}
6069
+ * @memberof DefaultApi
6070
+ */
6071
+ findPasskey(username, passkeyId, options) {
6072
+ return DefaultApiFp(this.configuration).findPasskey(username, passkeyId, options).then((request) => request(this.axios, this.basePath));
6073
+ }
5359
6074
  /**
5360
6075
  * A single report can be retrieved using this endpoint with the corresponding unique identifier.
5361
6076
  * @summary Retrieve report
@@ -5367,6 +6082,17 @@ export class DefaultApi extends BaseAPI {
5367
6082
  findReport(reportId, options) {
5368
6083
  return DefaultApiFp(this.configuration).findReport(reportId, options).then((request) => request(this.axios, this.basePath));
5369
6084
  }
6085
+ /**
6086
+ * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
6087
+ * @summary Retrieve signing document
6088
+ * @param {string} signingDocumentId
6089
+ * @param {*} [options] Override http request option.
6090
+ * @throws {RequiredError}
6091
+ * @memberof DefaultApi
6092
+ */
6093
+ findSigningDocument(signingDocumentId, options) {
6094
+ return DefaultApiFp(this.configuration).findSigningDocument(signingDocumentId, options).then((request) => request(this.axios, this.basePath));
6095
+ }
5370
6096
  /**
5371
6097
  * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
5372
6098
  * @summary Retrieve Task
@@ -5525,6 +6251,17 @@ export class DefaultApi extends BaseAPI {
5525
6251
  listMotionCaptures(applicantId, options) {
5526
6252
  return DefaultApiFp(this.configuration).listMotionCaptures(applicantId, options).then((request) => request(this.axios, this.basePath));
5527
6253
  }
6254
+ /**
6255
+ * Returns every passkey registered under the supplied username.
6256
+ * @summary List passkeys
6257
+ * @param {string} username Username that owns the passkeys.
6258
+ * @param {*} [options] Override http request option.
6259
+ * @throws {RequiredError}
6260
+ * @memberof DefaultApi
6261
+ */
6262
+ listPasskeys(username, options) {
6263
+ return DefaultApiFp(this.configuration).listPasskeys(username, options).then((request) => request(this.axios, this.basePath));
6264
+ }
5528
6265
  /**
5529
6266
  * Returns all repeat attempts for a given Document report
5530
6267
  * @summary Retrieve repeat attempts
@@ -5547,6 +6284,17 @@ export class DefaultApi extends BaseAPI {
5547
6284
  listReports(checkId, options) {
5548
6285
  return DefaultApiFp(this.configuration).listReports(checkId, options).then((request) => request(this.axios, this.basePath));
5549
6286
  }
6287
+ /**
6288
+ * All signing documents belonging to an applicant can be listed from this endpoint
6289
+ * @summary List signing documents
6290
+ * @param {string} applicantId
6291
+ * @param {*} [options] Override http request option.
6292
+ * @throws {RequiredError}
6293
+ * @memberof DefaultApi
6294
+ */
6295
+ listSigningDocuments(applicantId, options) {
6296
+ return DefaultApiFp(this.configuration).listSigningDocuments(applicantId, options).then((request) => request(this.axios, this.basePath));
6297
+ }
5550
6298
  /**
5551
6299
  * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
5552
6300
  * @summary List Tasks
@@ -5684,6 +6432,19 @@ export class DefaultApi extends BaseAPI {
5684
6432
  updateApplicant(applicantId, applicantUpdater, options) {
5685
6433
  return DefaultApiFp(this.configuration).updateApplicant(applicantId, applicantUpdater, options).then((request) => request(this.axios, this.basePath));
5686
6434
  }
6435
+ /**
6436
+ * Updates a passkey\'s state.
6437
+ * @summary Update passkey
6438
+ * @param {string} username Username that owns the passkey.
6439
+ * @param {string} passkeyId Passkey ID.
6440
+ * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
6441
+ * @param {*} [options] Override http request option.
6442
+ * @throws {RequiredError}
6443
+ * @memberof DefaultApi
6444
+ */
6445
+ updatePasskey(username, passkeyId, passkeyUpdater, options) {
6446
+ return DefaultApiFp(this.configuration).updatePasskey(username, passkeyId, passkeyUpdater, options).then((request) => request(this.axios, this.basePath));
6447
+ }
5687
6448
  /**
5688
6449
  * Update the status of the given matches
5689
6450
  * @summary Set match status (BETA)
@@ -5751,6 +6512,18 @@ export class DefaultApi extends BaseAPI {
5751
6512
  uploadLivePhoto(applicantId, file, advancedValidation, options) {
5752
6513
  return DefaultApiFp(this.configuration).uploadLivePhoto(applicantId, file, advancedValidation, options).then((request) => request(this.axios, this.basePath));
5753
6514
  }
6515
+ /**
6516
+ * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.
6517
+ * @summary Upload a signing document
6518
+ * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
6519
+ * @param {FileTransfer} file The file to be uploaded.
6520
+ * @param {*} [options] Override http request option.
6521
+ * @throws {RequiredError}
6522
+ * @memberof DefaultApi
6523
+ */
6524
+ uploadSigningDocument(applicantId, file, options) {
6525
+ return DefaultApiFp(this.configuration).uploadSigningDocument(applicantId, file, options).then((request) => request(this.axios, this.basePath));
6526
+ }
5754
6527
  }
5755
6528
  /**
5756
6529
  * @export