@onfido/api 5.6.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/api.d.ts CHANGED
@@ -2922,6 +2922,12 @@ export interface DocumentProperties {
2922
2922
  * @memberof DocumentProperties
2923
2923
  */
2924
2924
  'issuing_date'?: string;
2925
+ /**
2926
+ *
2927
+ * @type {string}
2928
+ * @memberof DocumentProperties
2929
+ */
2930
+ 'valid_from'?: string;
2925
2931
  /**
2926
2932
  *
2927
2933
  * @type {string}
@@ -4226,6 +4232,12 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4226
4232
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4227
4233
  */
4228
4234
  'issuing_date'?: string;
4235
+ /**
4236
+ *
4237
+ * @type {string}
4238
+ * @memberof DocumentWithDriverVerificationReportAllOfProperties
4239
+ */
4240
+ 'valid_from'?: string;
4229
4241
  /**
4230
4242
  *
4231
4243
  * @type {string}
@@ -7425,6 +7437,81 @@ export interface MotionCapturesList {
7425
7437
  */
7426
7438
  'motion_captures': Array<MotionCapture>;
7427
7439
  }
7440
+ /**
7441
+ *
7442
+ * @export
7443
+ * @interface Passkey
7444
+ */
7445
+ export interface Passkey {
7446
+ /**
7447
+ * Passkey identifier.
7448
+ * @type {string}
7449
+ * @memberof Passkey
7450
+ */
7451
+ 'id': string;
7452
+ /**
7453
+ * domain that the passkey is registered to, the rpId.
7454
+ * @type {string}
7455
+ * @memberof Passkey
7456
+ */
7457
+ 'application_domain': string;
7458
+ /**
7459
+ * Current passkey state.
7460
+ * @type {string}
7461
+ * @memberof Passkey
7462
+ */
7463
+ 'state': PasskeyStateEnum;
7464
+ /**
7465
+ * Timestamp when the passkey was created.
7466
+ * @type {string}
7467
+ * @memberof Passkey
7468
+ */
7469
+ 'created_at': string;
7470
+ /**
7471
+ * Timestamp when the passkey was last used.
7472
+ * @type {string}
7473
+ * @memberof Passkey
7474
+ */
7475
+ 'last_used_at'?: string;
7476
+ }
7477
+ export declare const PasskeyStateEnum: {
7478
+ readonly Active: "ACTIVE";
7479
+ readonly Inactive: "INACTIVE";
7480
+ readonly UnknownDefaultOpenApi: "11184809";
7481
+ };
7482
+ export type PasskeyStateEnum = typeof PasskeyStateEnum[keyof typeof PasskeyStateEnum];
7483
+ /**
7484
+ *
7485
+ * @export
7486
+ * @interface PasskeyUpdater
7487
+ */
7488
+ export interface PasskeyUpdater {
7489
+ /**
7490
+ * Desired passkey state value.
7491
+ * @type {string}
7492
+ * @memberof PasskeyUpdater
7493
+ */
7494
+ 'state': PasskeyUpdaterStateEnum;
7495
+ }
7496
+ export declare const PasskeyUpdaterStateEnum: {
7497
+ readonly Active: "ACTIVE";
7498
+ readonly Inactive: "INACTIVE";
7499
+ readonly UnknownDefaultOpenApi: "11184809";
7500
+ };
7501
+ export type PasskeyUpdaterStateEnum = typeof PasskeyUpdaterStateEnum[keyof typeof PasskeyUpdaterStateEnum];
7502
+ /**
7503
+ *
7504
+ * @export
7505
+ * @interface PasskeysList
7506
+ */
7507
+ export interface PasskeysList {
7508
+ /**
7509
+ *
7510
+ * @type {Array<Passkey>}
7511
+ * @memberof PasskeysList
7512
+ */
7513
+ 'passkeys': Array<Passkey>;
7514
+ }
7428
7515
  /**
7429
7516
  *
7430
7517
  * @export
@@ -8252,6 +8339,136 @@ export interface SdkTokenResponse {
8252
8339
  */
8253
8340
  'token': string;
8254
8341
  }
8342
+ /**
8343
+ *
8344
+ * @export
8345
+ * @interface SigningDocument
8346
+ */
8347
+ export interface SigningDocument {
8348
+ /**
8349
+ * The ID of the applicant whose signing document is being uploaded.
8350
+ * @type {string}
8351
+ * @memberof SigningDocument
8352
+ */
8353
+ 'applicant_id'?: string;
8354
+ /**
8355
+ * The unique identifier for the signing document
8356
+ * @type {string}
8357
+ * @memberof SigningDocument
8358
+ */
8359
+ 'id': string;
8360
+ /**
8361
+ * The date and time at which the signing document was uploaded
8362
+ * @type {string}
8363
+ * @memberof SigningDocument
8364
+ */
8365
+ 'created_at'?: string;
8366
+ /**
8367
+ * The uri of this resource
8368
+ * @type {string}
8369
+ * @memberof SigningDocument
8370
+ */
8371
+ 'href'?: string;
8372
+ /**
8373
+ * The uri that can be used to download the signing document
8374
+ * @type {string}
8375
+ * @memberof SigningDocument
8376
+ */
8377
+ 'download_href'?: string;
8378
+ /**
8379
+ * The file type of the uploaded file
8380
+ * @type {string}
8381
+ * @memberof SigningDocument
8382
+ */
8383
+ 'file_type'?: string;
8384
+ /**
8385
+ * The name of the uploaded file
8386
+ * @type {string}
8387
+ * @memberof SigningDocument
8388
+ */
8389
+ 'file_name'?: string;
8390
+ /**
8391
+ * The size of the file in bytes
8392
+ * @type {number}
8393
+ * @memberof SigningDocument
8394
+ */
8395
+ 'file_size'?: number;
8396
+ }
8397
+ /**
8398
+ *
8399
+ * @export
8400
+ * @interface SigningDocumentResponse
8401
+ */
8402
+ export interface SigningDocumentResponse {
8403
+ /**
8404
+ * The unique identifier for the signing document
8405
+ * @type {string}
8406
+ * @memberof SigningDocumentResponse
8407
+ */
8408
+ 'id': string;
8409
+ /**
8410
+ * The date and time at which the signing document was uploaded
8411
+ * @type {string}
8412
+ * @memberof SigningDocumentResponse
8413
+ */
8414
+ 'created_at'?: string;
8415
+ /**
8416
+ * The uri of this resource
8417
+ * @type {string}
8418
+ * @memberof SigningDocumentResponse
8419
+ */
8420
+ 'href'?: string;
8421
+ /**
8422
+ * The uri that can be used to download the signing document
8423
+ * @type {string}
8424
+ * @memberof SigningDocumentResponse
8425
+ */
8426
+ 'download_href'?: string;
8427
+ /**
8428
+ * The file type of the uploaded file
8429
+ * @type {string}
8430
+ * @memberof SigningDocumentResponse
8431
+ */
8432
+ 'file_type'?: string;
8433
+ /**
8434
+ * The name of the uploaded file
8435
+ * @type {string}
8436
+ * @memberof SigningDocumentResponse
8437
+ */
8438
+ 'file_name'?: string;
8439
+ /**
8440
+ * The size of the file in bytes
8441
+ * @type {number}
8442
+ * @memberof SigningDocumentResponse
8443
+ */
8444
+ 'file_size'?: number;
8445
+ }
8446
+ /**
8447
+ *
8448
+ * @export
8449
+ * @interface SigningDocumentShared
8450
+ */
8451
+ export interface SigningDocumentShared {
8452
+ /**
8453
+ * The ID of the applicant whose signing document is being uploaded.
8454
+ * @type {string}
8455
+ * @memberof SigningDocumentShared
8456
+ */
8457
+ 'applicant_id'?: string;
8458
+ }
8459
+ /**
8460
+ *
8461
+ * @export
8462
+ * @interface SigningDocumentsList
8463
+ */
8464
+ export interface SigningDocumentsList {
8465
+ /**
8466
+ *
8467
+ * @type {Array<SigningDocument>}
8468
+ * @memberof SigningDocumentsList
8469
+ */
8470
+ 'signing_documents': Array<SigningDocument>;
8471
+ }
8255
8472
  /**
8256
8473
  *
8257
8474
  * @export
@@ -11062,6 +11279,23 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11062
11279
  * @throws {RequiredError}
11063
11280
  */
11064
11281
  deleteApplicant: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11282
+ /**
11283
+ * Deletes a passkey.
11284
+ * @summary Delete passkey
11285
+ * @param {string} username Username that owns the passkey.
11286
+ * @param {string} passkeyId Passkey ID.
11287
+ * @param {*} [options] Override http request option.
11288
+ * @throws {RequiredError}
11289
+ */
11290
+ deletePasskey: (username: string, passkeyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11291
+ /**
11292
+ * Removes every passkey for the username.
11293
+ * @summary Delete passkeys
11294
+ * @param {string} username Username whose passkeys will be deleted.
11295
+ * @param {*} [options] Override http request option.
11296
+ * @throws {RequiredError}
11297
+ */
11298
+ deletePasskeys: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11065
11299
  /**
11066
11300
  * Deactivates the given monitor
11067
11301
  * @summary Delete monitor
@@ -11184,6 +11418,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11184
11418
  * @throws {RequiredError}
11185
11419
  */
11186
11420
  downloadQesDocument: (workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11421
+ /**
11422
+ * Retrieves the signed document or signing transaction receipt depending on the id provided.
11423
+ * @summary Retrieves the signed document or signing transaction receipt
11424
+ * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
11425
+ * @param {string} id The unique identifier of the file which you want to retrieve.
11426
+ * @param {*} [options] Override http request option.
11427
+ * @throws {RequiredError}
11428
+ */
11429
+ downloadSesDocument: (workflowRunId: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11187
11430
  /**
11188
11431
  * Retrieves the signed evidence file for the designated Workflow Run
11189
11432
  * @summary Retrieve Workflow Run Evidence Summary File
@@ -11192,6 +11435,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11192
11435
  * @throws {RequiredError}
11193
11436
  */
11194
11437
  downloadSignedEvidenceFile: (workflowRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11438
+ /**
11439
+ * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
11440
+ * @summary Download signing document
11441
+ * @param {string} signingDocumentId
11442
+ * @param {*} [options] Override http request option.
11443
+ * @throws {RequiredError}
11444
+ */
11445
+ downloadSigningDocument: (signingDocumentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11195
11446
  /**
11196
11447
  * Extract information from a document
11197
11448
  * @summary Autofill
@@ -11272,6 +11523,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11272
11523
  * @throws {RequiredError}
11273
11524
  */
11274
11525
  findMotionCapture: (motionCaptureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11526
+ /**
11527
+ * Returns a passkey\'s details.
11528
+ * @summary Retrieve passkey
11529
+ * @param {string} username Username that owns the passkey.
11530
+ * @param {string} passkeyId Passkey ID.
11531
+ * @param {*} [options] Override http request option.
11532
+ * @throws {RequiredError}
11533
+ */
11534
+ findPasskey: (username: string, passkeyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11275
11535
  /**
11276
11536
  * A single report can be retrieved using this endpoint with the corresponding unique identifier.
11277
11537
  * @summary Retrieve report
@@ -11280,6 +11540,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11280
11540
  * @throws {RequiredError}
11281
11541
  */
11282
11542
  findReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11543
+ /**
11544
+ * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
11545
+ * @summary Retrieve signing document
11546
+ * @param {string} signingDocumentId
11547
+ * @param {*} [options] Override http request option.
11548
+ * @throws {RequiredError}
11549
+ */
11550
+ findSigningDocument: (signingDocumentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11283
11551
  /**
11284
11552
  * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
11285
11553
  * @summary Retrieve Task
@@ -11396,6 +11664,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11396
11664
  * @throws {RequiredError}
11397
11665
  */
11398
11666
  listMotionCaptures: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11667
+ /**
11668
+ * Returns every passkey registered under the supplied username.
11669
+ * @summary List passkeys
11670
+ * @param {string} username Username that owns the passkeys.
11671
+ * @param {*} [options] Override http request option.
11672
+ * @throws {RequiredError}
11673
+ */
11674
+ listPasskeys: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11399
11675
  /**
11400
11676
  * Returns all repeat attempts for a given Document report
11401
11677
  * @summary Retrieve repeat attempts
@@ -11412,6 +11688,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11412
11688
  * @throws {RequiredError}
11413
11689
  */
11414
11690
  listReports: (checkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11691
+ /**
11692
+ * All signing documents belonging to an applicant can be listed from this endpoint
11693
+ * @summary List signing documents
11694
+ * @param {string} applicantId
11695
+ * @param {*} [options] Override http request option.
11696
+ * @throws {RequiredError}
11697
+ */
11698
+ listSigningDocuments: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11415
11699
  /**
11416
11700
  * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
11417
11701
  * @summary List Tasks
@@ -11513,6 +11797,16 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11513
11797
  * @throws {RequiredError}
11514
11798
  */
11515
11799
  updateApplicant: (applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11800
+ /**
11801
+ * Updates a passkey\'s state.
11802
+ * @summary Update passkey
11803
+ * @param {string} username Username that owns the passkey.
11804
+ * @param {string} passkeyId Passkey ID.
11805
+ * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
11806
+ * @param {*} [options] Override http request option.
11807
+ * @throws {RequiredError}
11808
+ */
11809
+ updatePasskey: (username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11516
11810
  /**
11517
11811
  * Update the status of the given matches
11518
11812
  * @summary Set match status (BETA)
@@ -11565,6 +11859,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
11565
11859
  * @throws {RequiredError}
11566
11860
  */
11567
11861
  uploadLivePhoto: (applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11862
+ /**
11863
+ * 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.
11864
+ * @summary Upload a signing document
11865
+ * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
11866
+ * @param {FileTransfer} file The file to be uploaded.
11867
+ * @param {*} [options] Override http request option.
11868
+ * @throws {RequiredError}
11869
+ */
11870
+ uploadSigningDocument: (applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11568
11871
  };
11569
11872
  /**
11570
11873
  * DefaultApi - functional programming interface
@@ -11645,6 +11948,23 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11645
11948
  * @throws {RequiredError}
11646
11949
  */
11647
11950
  deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
11951
+ /**
11952
+ * Deletes a passkey.
11953
+ * @summary Delete passkey
11954
+ * @param {string} username Username that owns the passkey.
11955
+ * @param {string} passkeyId Passkey ID.
11956
+ * @param {*} [options] Override http request option.
11957
+ * @throws {RequiredError}
11958
+ */
11959
+ deletePasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
11960
+ /**
11961
+ * Removes every passkey for the username.
11962
+ * @summary Delete passkeys
11963
+ * @param {string} username Username whose passkeys will be deleted.
11964
+ * @param {*} [options] Override http request option.
11965
+ * @throws {RequiredError}
11966
+ */
11967
+ deletePasskeys(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
11648
11968
  /**
11649
11969
  * Deactivates the given monitor
11650
11970
  * @summary Delete monitor
@@ -11767,6 +12087,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11767
12087
  * @throws {RequiredError}
11768
12088
  */
11769
12089
  downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
12090
+ /**
12091
+ * Retrieves the signed document or signing transaction receipt depending on the id provided.
12092
+ * @summary Retrieves the signed document or signing transaction receipt
12093
+ * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
12094
+ * @param {string} id The unique identifier of the file which you want to retrieve.
12095
+ * @param {*} [options] Override http request option.
12096
+ * @throws {RequiredError}
12097
+ */
12098
+ downloadSesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
11770
12099
  /**
11771
12100
  * Retrieves the signed evidence file for the designated Workflow Run
11772
12101
  * @summary Retrieve Workflow Run Evidence Summary File
@@ -11775,6 +12104,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11775
12104
  * @throws {RequiredError}
11776
12105
  */
11777
12106
  downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
12107
+ /**
12108
+ * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
12109
+ * @summary Download signing document
12110
+ * @param {string} signingDocumentId
12111
+ * @param {*} [options] Override http request option.
12112
+ * @throws {RequiredError}
12113
+ */
12114
+ downloadSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
11778
12115
  /**
11779
12116
  * Extract information from a document
11780
12117
  * @summary Autofill
@@ -11855,6 +12192,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11855
12192
  * @throws {RequiredError}
11856
12193
  */
11857
12194
  findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionCapture>>;
12195
+ /**
12196
+ * Returns a passkey\'s details.
12197
+ * @summary Retrieve passkey
12198
+ * @param {string} username Username that owns the passkey.
12199
+ * @param {string} passkeyId Passkey ID.
12200
+ * @param {*} [options] Override http request option.
12201
+ * @throws {RequiredError}
12202
+ */
12203
+ findPasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Passkey>>;
11858
12204
  /**
11859
12205
  * A single report can be retrieved using this endpoint with the corresponding unique identifier.
11860
12206
  * @summary Retrieve report
@@ -11863,6 +12209,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11863
12209
  * @throws {RequiredError}
11864
12210
  */
11865
12211
  findReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Report>>;
12212
+ /**
12213
+ * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
12214
+ * @summary Retrieve signing document
12215
+ * @param {string} signingDocumentId
12216
+ * @param {*} [options] Override http request option.
12217
+ * @throws {RequiredError}
12218
+ */
12219
+ findSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SigningDocument>>;
11866
12220
  /**
11867
12221
  * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
11868
12222
  * @summary Retrieve Task
@@ -11979,6 +12333,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11979
12333
  * @throws {RequiredError}
11980
12334
  */
11981
12335
  listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionCapturesList>>;
12336
+ /**
12337
+ * Returns every passkey registered under the supplied username.
12338
+ * @summary List passkeys
12339
+ * @param {string} username Username that owns the passkeys.
12340
+ * @param {*} [options] Override http request option.
12341
+ * @throws {RequiredError}
12342
+ */
12343
+ listPasskeys(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasskeysList>>;
11982
12344
  /**
11983
12345
  * Returns all repeat attempts for a given Document report
11984
12346
  * @summary Retrieve repeat attempts
@@ -11995,6 +12357,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
11995
12357
  * @throws {RequiredError}
11996
12358
  */
11997
12359
  listReports(checkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportsList>>;
12360
+ /**
12361
+ * All signing documents belonging to an applicant can be listed from this endpoint
12362
+ * @summary List signing documents
12363
+ * @param {string} applicantId
12364
+ * @param {*} [options] Override http request option.
12365
+ * @throws {RequiredError}
12366
+ */
12367
+ listSigningDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SigningDocumentsList>>;
11998
12368
  /**
11999
12369
  * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
12000
12370
  * @summary List Tasks
@@ -12096,6 +12466,16 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
12096
12466
  * @throws {RequiredError}
12097
12467
  */
12098
12468
  updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Applicant>>;
12469
+ /**
12470
+ * Updates a passkey\'s state.
12471
+ * @summary Update passkey
12472
+ * @param {string} username Username that owns the passkey.
12473
+ * @param {string} passkeyId Passkey ID.
12474
+ * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
12475
+ * @param {*} [options] Override http request option.
12476
+ * @throws {RequiredError}
12477
+ */
12478
+ updatePasskey(username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Passkey>>;
12099
12479
  /**
12100
12480
  * Update the status of the given matches
12101
12481
  * @summary Set match status (BETA)
@@ -12148,6 +12528,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
12148
12528
  * @throws {RequiredError}
12149
12529
  */
12150
12530
  uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LivePhoto>>;
12531
+ /**
12532
+ * 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.
12533
+ * @summary Upload a signing document
12534
+ * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
12535
+ * @param {FileTransfer} file The file to be uploaded.
12536
+ * @param {*} [options] Override http request option.
12537
+ * @throws {RequiredError}
12538
+ */
12539
+ uploadSigningDocument(applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SigningDocument>>;
12151
12540
  };
12152
12541
  /**
12153
12542
  * DefaultApi - factory interface
@@ -12228,6 +12617,23 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12228
12617
  * @throws {RequiredError}
12229
12618
  */
12230
12619
  deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
12620
+ /**
12621
+ * Deletes a passkey.
12622
+ * @summary Delete passkey
12623
+ * @param {string} username Username that owns the passkey.
12624
+ * @param {string} passkeyId Passkey ID.
12625
+ * @param {*} [options] Override http request option.
12626
+ * @throws {RequiredError}
12627
+ */
12628
+ deletePasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
12629
+ /**
12630
+ * Removes every passkey for the username.
12631
+ * @summary Delete passkeys
12632
+ * @param {string} username Username whose passkeys will be deleted.
12633
+ * @param {*} [options] Override http request option.
12634
+ * @throws {RequiredError}
12635
+ */
12636
+ deletePasskeys(username: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
12231
12637
  /**
12232
12638
  * Deactivates the given monitor
12233
12639
  * @summary Delete monitor
@@ -12350,6 +12756,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12350
12756
  * @throws {RequiredError}
12351
12757
  */
12352
12758
  downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
12759
+ /**
12760
+ * Retrieves the signed document or signing transaction receipt depending on the id provided.
12761
+ * @summary Retrieves the signed document or signing transaction receipt
12762
+ * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
12763
+ * @param {string} id The unique identifier of the file which you want to retrieve.
12764
+ * @param {*} [options] Override http request option.
12765
+ * @throws {RequiredError}
12766
+ */
12767
+ downloadSesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
12353
12768
  /**
12354
12769
  * Retrieves the signed evidence file for the designated Workflow Run
12355
12770
  * @summary Retrieve Workflow Run Evidence Summary File
@@ -12358,6 +12773,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12358
12773
  * @throws {RequiredError}
12359
12774
  */
12360
12775
  downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
12776
+ /**
12777
+ * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
12778
+ * @summary Download signing document
12779
+ * @param {string} signingDocumentId
12780
+ * @param {*} [options] Override http request option.
12781
+ * @throws {RequiredError}
12782
+ */
12783
+ downloadSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
12361
12784
  /**
12362
12785
  * Extract information from a document
12363
12786
  * @summary Autofill
@@ -12438,6 +12861,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12438
12861
  * @throws {RequiredError}
12439
12862
  */
12440
12863
  findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionCapture>;
12864
+ /**
12865
+ * Returns a passkey\'s details.
12866
+ * @summary Retrieve passkey
12867
+ * @param {string} username Username that owns the passkey.
12868
+ * @param {string} passkeyId Passkey ID.
12869
+ * @param {*} [options] Override http request option.
12870
+ * @throws {RequiredError}
12871
+ */
12872
+ findPasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): AxiosPromise<Passkey>;
12441
12873
  /**
12442
12874
  * A single report can be retrieved using this endpoint with the corresponding unique identifier.
12443
12875
  * @summary Retrieve report
@@ -12446,6 +12878,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12446
12878
  * @throws {RequiredError}
12447
12879
  */
12448
12880
  findReport(reportId: string, options?: RawAxiosRequestConfig): AxiosPromise<Report>;
12881
+ /**
12882
+ * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
12883
+ * @summary Retrieve signing document
12884
+ * @param {string} signingDocumentId
12885
+ * @param {*} [options] Override http request option.
12886
+ * @throws {RequiredError}
12887
+ */
12888
+ findSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): AxiosPromise<SigningDocument>;
12449
12889
  /**
12450
12890
  * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
12451
12891
  * @summary Retrieve Task
@@ -12562,6 +13002,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12562
13002
  * @throws {RequiredError}
12563
13003
  */
12564
13004
  listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionCapturesList>;
13005
+ /**
13006
+ * Returns every passkey registered under the supplied username.
13007
+ * @summary List passkeys
13008
+ * @param {string} username Username that owns the passkeys.
13009
+ * @param {*} [options] Override http request option.
13010
+ * @throws {RequiredError}
13011
+ */
13012
+ listPasskeys(username: string, options?: RawAxiosRequestConfig): AxiosPromise<PasskeysList>;
12565
13013
  /**
12566
13014
  * Returns all repeat attempts for a given Document report
12567
13015
  * @summary Retrieve repeat attempts
@@ -12578,6 +13026,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12578
13026
  * @throws {RequiredError}
12579
13027
  */
12580
13028
  listReports(checkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReportsList>;
13029
+ /**
13030
+ * All signing documents belonging to an applicant can be listed from this endpoint
13031
+ * @summary List signing documents
13032
+ * @param {string} applicantId
13033
+ * @param {*} [options] Override http request option.
13034
+ * @throws {RequiredError}
13035
+ */
13036
+ listSigningDocuments(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<SigningDocumentsList>;
12581
13037
  /**
12582
13038
  * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
12583
13039
  * @summary List Tasks
@@ -12679,6 +13135,16 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12679
13135
  * @throws {RequiredError}
12680
13136
  */
12681
13137
  updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): AxiosPromise<Applicant>;
13138
+ /**
13139
+ * Updates a passkey\'s state.
13140
+ * @summary Update passkey
13141
+ * @param {string} username Username that owns the passkey.
13142
+ * @param {string} passkeyId Passkey ID.
13143
+ * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
13144
+ * @param {*} [options] Override http request option.
13145
+ * @throws {RequiredError}
13146
+ */
13147
+ updatePasskey(username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig): AxiosPromise<Passkey>;
12682
13148
  /**
12683
13149
  * Update the status of the given matches
12684
13150
  * @summary Set match status (BETA)
@@ -12731,6 +13197,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
12731
13197
  * @throws {RequiredError}
12732
13198
  */
12733
13199
  uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<LivePhoto>;
13200
+ /**
13201
+ * 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.
13202
+ * @summary Upload a signing document
13203
+ * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
13204
+ * @param {FileTransfer} file The file to be uploaded.
13205
+ * @param {*} [options] Override http request option.
13206
+ * @throws {RequiredError}
13207
+ */
13208
+ uploadSigningDocument(applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig): AxiosPromise<SigningDocument>;
12734
13209
  };
12735
13210
  /**
12736
13211
  * DefaultApi - object-oriented interface
@@ -12822,6 +13297,25 @@ export declare class DefaultApi extends BaseAPI {
12822
13297
  * @memberof DefaultApi
12823
13298
  */
12824
13299
  deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
13300
+ /**
13301
+ * Deletes a passkey.
13302
+ * @summary Delete passkey
13303
+ * @param {string} username Username that owns the passkey.
13304
+ * @param {string} passkeyId Passkey ID.
13305
+ * @param {*} [options] Override http request option.
13306
+ * @throws {RequiredError}
13307
+ * @memberof DefaultApi
13308
+ */
13309
+ deletePasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
13310
+ /**
13311
+ * Removes every passkey for the username.
13312
+ * @summary Delete passkeys
13313
+ * @param {string} username Username whose passkeys will be deleted.
13314
+ * @param {*} [options] Override http request option.
13315
+ * @throws {RequiredError}
13316
+ * @memberof DefaultApi
13317
+ */
13318
+ deletePasskeys(username: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
12825
13319
  /**
12826
13320
  * Deactivates the given monitor
12827
13321
  * @summary Delete monitor
@@ -12959,6 +13453,16 @@ export declare class DefaultApi extends BaseAPI {
12959
13453
  * @memberof DefaultApi
12960
13454
  */
12961
13455
  downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
13456
+ /**
13457
+ * Retrieves the signed document or signing transaction receipt depending on the id provided.
13458
+ * @summary Retrieves the signed document or signing transaction receipt
13459
+ * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
13460
+ * @param {string} id The unique identifier of the file which you want to retrieve.
13461
+ * @param {*} [options] Override http request option.
13462
+ * @throws {RequiredError}
13463
+ * @memberof DefaultApi
13464
+ */
13465
+ downloadSesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
12962
13466
  /**
12963
13467
  * Retrieves the signed evidence file for the designated Workflow Run
12964
13468
  * @summary Retrieve Workflow Run Evidence Summary File
@@ -12968,6 +13472,15 @@ export declare class DefaultApi extends BaseAPI {
12968
13472
  * @memberof DefaultApi
12969
13473
  */
12970
13474
  downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
13475
+ /**
13476
+ * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
13477
+ * @summary Download signing document
13478
+ * @param {string} signingDocumentId
13479
+ * @param {*} [options] Override http request option.
13480
+ * @throws {RequiredError}
13481
+ * @memberof DefaultApi
13482
+ */
13483
+ downloadSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
12971
13484
  /**
12972
13485
  * Extract information from a document
12973
13486
  * @summary Autofill
@@ -13058,6 +13571,16 @@ export declare class DefaultApi extends BaseAPI {
13058
13571
  * @memberof DefaultApi
13059
13572
  */
13060
13573
  findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapture, any, {}>>;
13574
+ /**
13575
+ * Returns a passkey\'s details.
13576
+ * @summary Retrieve passkey
13577
+ * @param {string} username Username that owns the passkey.
13578
+ * @param {string} passkeyId Passkey ID.
13579
+ * @param {*} [options] Override http request option.
13580
+ * @throws {RequiredError}
13581
+ * @memberof DefaultApi
13582
+ */
13583
+ findPasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Passkey, any, {}>>;
13061
13584
  /**
13062
13585
  * A single report can be retrieved using this endpoint with the corresponding unique identifier.
13063
13586
  * @summary Retrieve report
@@ -13067,6 +13590,15 @@ export declare class DefaultApi extends BaseAPI {
13067
13590
  * @memberof DefaultApi
13068
13591
  */
13069
13592
  findReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Report, any, {}>>;
13593
+ /**
13594
+ * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
13595
+ * @summary Retrieve signing document
13596
+ * @param {string} signingDocumentId
13597
+ * @param {*} [options] Override http request option.
13598
+ * @throws {RequiredError}
13599
+ * @memberof DefaultApi
13600
+ */
13601
+ findSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SigningDocument, any, {}>>;
13070
13602
  /**
13071
13603
  * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
13072
13604
  * @summary Retrieve Task
@@ -13197,6 +13729,15 @@ export declare class DefaultApi extends BaseAPI {
13197
13729
  * @memberof DefaultApi
13198
13730
  */
13199
13731
  listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapturesList, any, {}>>;
13732
+ /**
13733
+ * Returns every passkey registered under the supplied username.
13734
+ * @summary List passkeys
13735
+ * @param {string} username Username that owns the passkeys.
13736
+ * @param {*} [options] Override http request option.
13737
+ * @throws {RequiredError}
13738
+ * @memberof DefaultApi
13739
+ */
13740
+ listPasskeys(username: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PasskeysList, any, {}>>;
13200
13741
  /**
13201
13742
  * Returns all repeat attempts for a given Document report
13202
13743
  * @summary Retrieve repeat attempts
@@ -13215,6 +13756,15 @@ export declare class DefaultApi extends BaseAPI {
13215
13756
  * @memberof DefaultApi
13216
13757
  */
13217
13758
  listReports(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportsList, any, {}>>;
13759
+ /**
13760
+ * All signing documents belonging to an applicant can be listed from this endpoint
13761
+ * @summary List signing documents
13762
+ * @param {string} applicantId
13763
+ * @param {*} [options] Override http request option.
13764
+ * @throws {RequiredError}
13765
+ * @memberof DefaultApi
13766
+ */
13767
+ listSigningDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SigningDocumentsList, any, {}>>;
13218
13768
  /**
13219
13769
  * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
13220
13770
  * @summary List Tasks
@@ -13328,6 +13878,17 @@ export declare class DefaultApi extends BaseAPI {
13328
13878
  * @memberof DefaultApi
13329
13879
  */
13330
13880
  updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any, {}>>;
13881
+ /**
13882
+ * Updates a passkey\'s state.
13883
+ * @summary Update passkey
13884
+ * @param {string} username Username that owns the passkey.
13885
+ * @param {string} passkeyId Passkey ID.
13886
+ * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
13887
+ * @param {*} [options] Override http request option.
13888
+ * @throws {RequiredError}
13889
+ * @memberof DefaultApi
13890
+ */
13891
+ updatePasskey(username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Passkey, any, {}>>;
13331
13892
  /**
13332
13893
  * Update the status of the given matches
13333
13894
  * @summary Set match status (BETA)
@@ -13385,6 +13946,16 @@ export declare class DefaultApi extends BaseAPI {
13385
13946
  * @memberof DefaultApi
13386
13947
  */
13387
13948
  uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any, {}>>;
13949
+ /**
13950
+ * 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.
13951
+ * @summary Upload a signing document
13952
+ * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
13953
+ * @param {FileTransfer} file The file to be uploaded.
13954
+ * @param {*} [options] Override http request option.
13955
+ * @throws {RequiredError}
13956
+ * @memberof DefaultApi
13957
+ */
13958
+ uploadSigningDocument(applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SigningDocument, any, {}>>;
13388
13959
  }
13389
13960
  /**
13390
13961
  * @export