@onfido/api 3.0.0 → 3.1.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/README.md +35 -12
- package/dist/api.d.ts +487 -141
- package/dist/api.js +240 -69
- package/dist/common.js +1 -40
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +487 -141
- package/dist/esm/api.js +239 -68
- package/dist/esm/common.js +1 -40
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/file-transfer.d.ts +10 -0
- package/dist/esm/file-transfer.js +13 -0
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/file-transfer.d.ts +10 -0
- package/dist/file-transfer.js +17 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/package.json +3 -3
package/dist/esm/api.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ import type { Configuration } from './configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
+
import { FileTransfer } from './file-transfer';
|
|
16
17
|
/**
|
|
17
18
|
*
|
|
18
19
|
* @export
|
|
@@ -1009,16 +1010,22 @@ export interface ChecksList {
|
|
|
1009
1010
|
/**
|
|
1010
1011
|
*
|
|
1011
1012
|
* @export
|
|
1012
|
-
* @interface
|
|
1013
|
+
* @interface CompleteTaskBuilder
|
|
1013
1014
|
*/
|
|
1014
|
-
export interface
|
|
1015
|
+
export interface CompleteTaskBuilder {
|
|
1015
1016
|
/**
|
|
1016
|
-
*
|
|
1017
|
-
* @type {
|
|
1018
|
-
* @memberof
|
|
1017
|
+
*
|
|
1018
|
+
* @type {CompleteTaskDataBuilder}
|
|
1019
|
+
* @memberof CompleteTaskBuilder
|
|
1019
1020
|
*/
|
|
1020
|
-
'data'
|
|
1021
|
+
'data': CompleteTaskDataBuilder;
|
|
1021
1022
|
}
|
|
1023
|
+
/**
|
|
1024
|
+
* @type CompleteTaskDataBuilder
|
|
1025
|
+
* The Task completion payload.
|
|
1026
|
+
* @export
|
|
1027
|
+
*/
|
|
1028
|
+
export type CompleteTaskDataBuilder = Array<object> | object;
|
|
1022
1029
|
/**
|
|
1023
1030
|
* The applicant\'s consents
|
|
1024
1031
|
* @export
|
|
@@ -4750,6 +4757,19 @@ export interface FacialSimilarityMotionBreakdownVisualAuthenticityBreakdownSpoof
|
|
|
4750
4757
|
*/
|
|
4751
4758
|
'properties'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties;
|
|
4752
4759
|
}
|
|
4760
|
+
/**
|
|
4761
|
+
*
|
|
4762
|
+
* @export
|
|
4763
|
+
* @interface FacialSimilarityMotionProperties
|
|
4764
|
+
*/
|
|
4765
|
+
export interface FacialSimilarityMotionProperties {
|
|
4766
|
+
/**
|
|
4767
|
+
* A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. videos of digital screens, masks or print-outs). Conversely, the closer it is to 1, the less likely it is to be a spoof.
|
|
4768
|
+
* @type {number}
|
|
4769
|
+
* @memberof FacialSimilarityMotionProperties
|
|
4770
|
+
*/
|
|
4771
|
+
'score'?: number;
|
|
4772
|
+
}
|
|
4753
4773
|
/**
|
|
4754
4774
|
*
|
|
4755
4775
|
* @export
|
|
@@ -4816,6 +4836,12 @@ export interface FacialSimilarityMotionReport {
|
|
|
4816
4836
|
* @memberof FacialSimilarityMotionReport
|
|
4817
4837
|
*/
|
|
4818
4838
|
'breakdown'?: FacialSimilarityMotionBreakdown;
|
|
4839
|
+
/**
|
|
4840
|
+
*
|
|
4841
|
+
* @type {FacialSimilarityMotionProperties}
|
|
4842
|
+
* @memberof FacialSimilarityMotionReport
|
|
4843
|
+
*/
|
|
4844
|
+
'properties'?: FacialSimilarityMotionProperties;
|
|
4819
4845
|
}
|
|
4820
4846
|
/**
|
|
4821
4847
|
*
|
|
@@ -5134,6 +5160,19 @@ export interface FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdownS
|
|
|
5134
5160
|
*/
|
|
5135
5161
|
'properties'?: PhotoAutoReasons;
|
|
5136
5162
|
}
|
|
5163
|
+
/**
|
|
5164
|
+
*
|
|
5165
|
+
* @export
|
|
5166
|
+
* @interface FacialSimilarityPhotoFullyAutoProperties
|
|
5167
|
+
*/
|
|
5168
|
+
export interface FacialSimilarityPhotoFullyAutoProperties {
|
|
5169
|
+
/**
|
|
5170
|
+
* A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. photos of printed photos, or photos of digital screens). Conversely, the closer it is to 1, the less likely it is to be a spoof.
|
|
5171
|
+
* @type {number}
|
|
5172
|
+
* @memberof FacialSimilarityPhotoFullyAutoProperties
|
|
5173
|
+
*/
|
|
5174
|
+
'score'?: number;
|
|
5175
|
+
}
|
|
5137
5176
|
/**
|
|
5138
5177
|
*
|
|
5139
5178
|
* @export
|
|
@@ -5200,6 +5239,25 @@ export interface FacialSimilarityPhotoFullyAutoReport {
|
|
|
5200
5239
|
* @memberof FacialSimilarityPhotoFullyAutoReport
|
|
5201
5240
|
*/
|
|
5202
5241
|
'breakdown'?: FacialSimilarityPhotoFullyAutoBreakdown;
|
|
5242
|
+
/**
|
|
5243
|
+
*
|
|
5244
|
+
* @type {FacialSimilarityPhotoFullyAutoProperties}
|
|
5245
|
+
* @memberof FacialSimilarityPhotoFullyAutoReport
|
|
5246
|
+
*/
|
|
5247
|
+
'properties'?: FacialSimilarityPhotoFullyAutoProperties;
|
|
5248
|
+
}
|
|
5249
|
+
/**
|
|
5250
|
+
*
|
|
5251
|
+
* @export
|
|
5252
|
+
* @interface FacialSimilarityPhotoProperties
|
|
5253
|
+
*/
|
|
5254
|
+
export interface FacialSimilarityPhotoProperties {
|
|
5255
|
+
/**
|
|
5256
|
+
* A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. photos of printed photos, or photos of digital screens). Conversely, the closer it is to 1, the less likely it is to be a spoof.
|
|
5257
|
+
* @type {number}
|
|
5258
|
+
* @memberof FacialSimilarityPhotoProperties
|
|
5259
|
+
*/
|
|
5260
|
+
'score'?: number;
|
|
5203
5261
|
}
|
|
5204
5262
|
/**
|
|
5205
5263
|
*
|
|
@@ -5267,6 +5325,12 @@ export interface FacialSimilarityPhotoReport {
|
|
|
5267
5325
|
* @memberof FacialSimilarityPhotoReport
|
|
5268
5326
|
*/
|
|
5269
5327
|
'breakdown'?: FacialSimilarityPhotoBreakdown;
|
|
5328
|
+
/**
|
|
5329
|
+
*
|
|
5330
|
+
* @type {FacialSimilarityPhotoProperties}
|
|
5331
|
+
* @memberof FacialSimilarityPhotoReport
|
|
5332
|
+
*/
|
|
5333
|
+
'properties'?: FacialSimilarityPhotoProperties;
|
|
5270
5334
|
}
|
|
5271
5335
|
/**
|
|
5272
5336
|
*
|
|
@@ -5464,6 +5528,19 @@ export interface FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownSpoofi
|
|
|
5464
5528
|
*/
|
|
5465
5529
|
'properties'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties;
|
|
5466
5530
|
}
|
|
5531
|
+
/**
|
|
5532
|
+
*
|
|
5533
|
+
* @export
|
|
5534
|
+
* @interface FacialSimilarityVideoProperties
|
|
5535
|
+
*/
|
|
5536
|
+
export interface FacialSimilarityVideoProperties {
|
|
5537
|
+
/**
|
|
5538
|
+
* A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. videos of digital screens, masks or print-outs). Conversely, the closer it is to 1, the less likely it is to be a spoof.
|
|
5539
|
+
* @type {number}
|
|
5540
|
+
* @memberof FacialSimilarityVideoProperties
|
|
5541
|
+
*/
|
|
5542
|
+
'score'?: number;
|
|
5543
|
+
}
|
|
5467
5544
|
/**
|
|
5468
5545
|
*
|
|
5469
5546
|
* @export
|
|
@@ -5530,19 +5607,12 @@ export interface FacialSimilarityVideoReport {
|
|
|
5530
5607
|
* @memberof FacialSimilarityVideoReport
|
|
5531
5608
|
*/
|
|
5532
5609
|
'breakdown'?: FacialSimilarityVideoBreakdown;
|
|
5533
|
-
}
|
|
5534
|
-
/**
|
|
5535
|
-
*
|
|
5536
|
-
* @export
|
|
5537
|
-
* @interface IDPhotosList
|
|
5538
|
-
*/
|
|
5539
|
-
export interface IDPhotosList {
|
|
5540
5610
|
/**
|
|
5541
5611
|
*
|
|
5542
|
-
* @type {
|
|
5543
|
-
* @memberof
|
|
5612
|
+
* @type {FacialSimilarityVideoProperties}
|
|
5613
|
+
* @memberof FacialSimilarityVideoReport
|
|
5544
5614
|
*/
|
|
5545
|
-
'
|
|
5615
|
+
'properties'?: FacialSimilarityVideoProperties;
|
|
5546
5616
|
}
|
|
5547
5617
|
/**
|
|
5548
5618
|
*
|
|
@@ -5680,6 +5750,19 @@ export interface IdPhotoResponse {
|
|
|
5680
5750
|
*/
|
|
5681
5751
|
'file_size'?: number;
|
|
5682
5752
|
}
|
|
5753
|
+
/**
|
|
5754
|
+
*
|
|
5755
|
+
* @export
|
|
5756
|
+
* @interface IdPhotosList
|
|
5757
|
+
*/
|
|
5758
|
+
export interface IdPhotosList {
|
|
5759
|
+
/**
|
|
5760
|
+
*
|
|
5761
|
+
* @type {Array<IdPhoto>}
|
|
5762
|
+
* @memberof IdPhotosList
|
|
5763
|
+
*/
|
|
5764
|
+
'id_photos': Array<IdPhoto>;
|
|
5765
|
+
}
|
|
5683
5766
|
/**
|
|
5684
5767
|
*
|
|
5685
5768
|
* @export
|
|
@@ -6591,13 +6674,13 @@ export interface LiveVideo {
|
|
|
6591
6674
|
/**
|
|
6592
6675
|
*
|
|
6593
6676
|
* @export
|
|
6594
|
-
* @interface
|
|
6677
|
+
* @interface LiveVideosList
|
|
6595
6678
|
*/
|
|
6596
|
-
export interface
|
|
6679
|
+
export interface LiveVideosList {
|
|
6597
6680
|
/**
|
|
6598
6681
|
*
|
|
6599
6682
|
* @type {Array<LiveVideo>}
|
|
6600
|
-
* @memberof
|
|
6683
|
+
* @memberof LiveVideosList
|
|
6601
6684
|
*/
|
|
6602
6685
|
'live_videos': Array<LiveVideo>;
|
|
6603
6686
|
}
|
|
@@ -7527,12 +7610,36 @@ export interface Task {
|
|
|
7527
7610
|
* @memberof Task
|
|
7528
7611
|
*/
|
|
7529
7612
|
'id'?: string;
|
|
7613
|
+
/**
|
|
7614
|
+
* The workflow run id the task belongs to.
|
|
7615
|
+
* @type {string}
|
|
7616
|
+
* @memberof Task
|
|
7617
|
+
*/
|
|
7618
|
+
'workflow_run_id'?: string;
|
|
7530
7619
|
/**
|
|
7531
7620
|
* The identifier for the Task Definition.
|
|
7532
7621
|
* @type {string}
|
|
7533
7622
|
* @memberof Task
|
|
7534
7623
|
*/
|
|
7535
7624
|
'task_def_id'?: string;
|
|
7625
|
+
/**
|
|
7626
|
+
* The task definition version.
|
|
7627
|
+
* @type {string}
|
|
7628
|
+
* @memberof Task
|
|
7629
|
+
*/
|
|
7630
|
+
'task_def_version'?: string | null;
|
|
7631
|
+
/**
|
|
7632
|
+
* Input object with the fields used by the Task to execute.
|
|
7633
|
+
* @type {object}
|
|
7634
|
+
* @memberof Task
|
|
7635
|
+
*/
|
|
7636
|
+
'input'?: object;
|
|
7637
|
+
/**
|
|
7638
|
+
* Output object with the fields produced by the Task execution.
|
|
7639
|
+
* @type {object}
|
|
7640
|
+
* @memberof Task
|
|
7641
|
+
*/
|
|
7642
|
+
'output'?: object | null;
|
|
7536
7643
|
/**
|
|
7537
7644
|
* The date and time when the Task was created.
|
|
7538
7645
|
* @type {string}
|
|
@@ -7549,21 +7656,52 @@ export interface Task {
|
|
|
7549
7656
|
/**
|
|
7550
7657
|
*
|
|
7551
7658
|
* @export
|
|
7552
|
-
* @interface
|
|
7659
|
+
* @interface TaskItem
|
|
7553
7660
|
*/
|
|
7554
|
-
export interface
|
|
7661
|
+
export interface TaskItem {
|
|
7555
7662
|
/**
|
|
7556
|
-
*
|
|
7557
|
-
* @type {
|
|
7558
|
-
* @memberof
|
|
7663
|
+
* The identifier for the Task.
|
|
7664
|
+
* @type {string}
|
|
7665
|
+
* @memberof TaskItem
|
|
7559
7666
|
*/
|
|
7560
|
-
'
|
|
7667
|
+
'id'?: string;
|
|
7561
7668
|
/**
|
|
7562
|
-
*
|
|
7563
|
-
* @type {
|
|
7564
|
-
* @memberof
|
|
7669
|
+
* The identifier for the Task Definition.
|
|
7670
|
+
* @type {string}
|
|
7671
|
+
* @memberof TaskItem
|
|
7565
7672
|
*/
|
|
7566
|
-
'
|
|
7673
|
+
'task_def_id'?: string;
|
|
7674
|
+
/**
|
|
7675
|
+
* The date and time when the Task was created.
|
|
7676
|
+
* @type {string}
|
|
7677
|
+
* @memberof TaskItem
|
|
7678
|
+
*/
|
|
7679
|
+
'created_at'?: string;
|
|
7680
|
+
/**
|
|
7681
|
+
* The date and time when the Task was last updated.
|
|
7682
|
+
* @type {string}
|
|
7683
|
+
* @memberof TaskItem
|
|
7684
|
+
*/
|
|
7685
|
+
'updated_at'?: string;
|
|
7686
|
+
}
|
|
7687
|
+
/**
|
|
7688
|
+
*
|
|
7689
|
+
* @export
|
|
7690
|
+
* @interface TimelineFileReference
|
|
7691
|
+
*/
|
|
7692
|
+
export interface TimelineFileReference {
|
|
7693
|
+
/**
|
|
7694
|
+
* The unique identifier for the Timefile File that will be created.
|
|
7695
|
+
* @type {string}
|
|
7696
|
+
* @memberof TimelineFileReference
|
|
7697
|
+
*/
|
|
7698
|
+
'workflow_timeline_file_id': string;
|
|
7699
|
+
/**
|
|
7700
|
+
* Link to access the Timefile File that will be created.
|
|
7701
|
+
* @type {string}
|
|
7702
|
+
* @memberof TimelineFileReference
|
|
7703
|
+
*/
|
|
7704
|
+
'href': string;
|
|
7567
7705
|
}
|
|
7568
7706
|
/**
|
|
7569
7707
|
*
|
|
@@ -8484,12 +8622,30 @@ export interface WatchlistEnhancedReport {
|
|
|
8484
8622
|
* @interface WatchlistMonitor
|
|
8485
8623
|
*/
|
|
8486
8624
|
export interface WatchlistMonitor {
|
|
8625
|
+
/**
|
|
8626
|
+
* The ID for the applicant associated with the monitor.
|
|
8627
|
+
* @type {string}
|
|
8628
|
+
* @memberof WatchlistMonitor
|
|
8629
|
+
*/
|
|
8630
|
+
'applicant_id': string;
|
|
8631
|
+
/**
|
|
8632
|
+
* The name of the report type the monitor creates.
|
|
8633
|
+
* @type {string}
|
|
8634
|
+
* @memberof WatchlistMonitor
|
|
8635
|
+
*/
|
|
8636
|
+
'report_name': WatchlistMonitorReportNameEnum;
|
|
8637
|
+
/**
|
|
8638
|
+
* A list of tags associated with this monitor. These tags will be applied to each check this monitor creates.
|
|
8639
|
+
* @type {Array<string>}
|
|
8640
|
+
* @memberof WatchlistMonitor
|
|
8641
|
+
*/
|
|
8642
|
+
'tags'?: Array<string>;
|
|
8487
8643
|
/**
|
|
8488
8644
|
* The unique identifier for the monitor.
|
|
8489
8645
|
* @type {string}
|
|
8490
8646
|
* @memberof WatchlistMonitor
|
|
8491
8647
|
*/
|
|
8492
|
-
'id'
|
|
8648
|
+
'id': string;
|
|
8493
8649
|
/**
|
|
8494
8650
|
* The date and time at which the monitor was created.
|
|
8495
8651
|
* @type {string}
|
|
@@ -8502,37 +8658,50 @@ export interface WatchlistMonitor {
|
|
|
8502
8658
|
* @memberof WatchlistMonitor
|
|
8503
8659
|
*/
|
|
8504
8660
|
'deleted_at'?: string;
|
|
8661
|
+
/**
|
|
8662
|
+
* Indicates whether the object was created in the sandbox or not.
|
|
8663
|
+
* @type {boolean}
|
|
8664
|
+
* @memberof WatchlistMonitor
|
|
8665
|
+
*/
|
|
8666
|
+
'is_sandbox'?: boolean;
|
|
8667
|
+
}
|
|
8668
|
+
export declare const WatchlistMonitorReportNameEnum: {
|
|
8669
|
+
readonly Standard: "watchlist_standard";
|
|
8670
|
+
readonly Aml: "watchlist_aml";
|
|
8671
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
8672
|
+
};
|
|
8673
|
+
export type WatchlistMonitorReportNameEnum = typeof WatchlistMonitorReportNameEnum[keyof typeof WatchlistMonitorReportNameEnum];
|
|
8674
|
+
/**
|
|
8675
|
+
*
|
|
8676
|
+
* @export
|
|
8677
|
+
* @interface WatchlistMonitorBuilder
|
|
8678
|
+
*/
|
|
8679
|
+
export interface WatchlistMonitorBuilder {
|
|
8505
8680
|
/**
|
|
8506
8681
|
* The ID for the applicant associated with the monitor.
|
|
8507
8682
|
* @type {string}
|
|
8508
|
-
* @memberof
|
|
8683
|
+
* @memberof WatchlistMonitorBuilder
|
|
8509
8684
|
*/
|
|
8510
8685
|
'applicant_id': string;
|
|
8511
8686
|
/**
|
|
8512
|
-
* The name of the report type the monitor creates.
|
|
8687
|
+
* The name of the report type the monitor creates.
|
|
8513
8688
|
* @type {string}
|
|
8514
|
-
* @memberof
|
|
8689
|
+
* @memberof WatchlistMonitorBuilder
|
|
8515
8690
|
*/
|
|
8516
|
-
'report_name':
|
|
8691
|
+
'report_name': WatchlistMonitorBuilderReportNameEnum;
|
|
8517
8692
|
/**
|
|
8518
8693
|
* A list of tags associated with this monitor. These tags will be applied to each check this monitor creates.
|
|
8519
8694
|
* @type {Array<string>}
|
|
8520
|
-
* @memberof
|
|
8695
|
+
* @memberof WatchlistMonitorBuilder
|
|
8521
8696
|
*/
|
|
8522
8697
|
'tags'?: Array<string>;
|
|
8523
|
-
/**
|
|
8524
|
-
* Indicates whether the object was created in the sandbox or not.
|
|
8525
|
-
* @type {boolean}
|
|
8526
|
-
* @memberof WatchlistMonitor
|
|
8527
|
-
*/
|
|
8528
|
-
'sandbox'?: boolean;
|
|
8529
8698
|
}
|
|
8530
|
-
export declare const
|
|
8699
|
+
export declare const WatchlistMonitorBuilderReportNameEnum: {
|
|
8531
8700
|
readonly Standard: "watchlist_standard";
|
|
8532
8701
|
readonly Aml: "watchlist_aml";
|
|
8533
8702
|
readonly UnknownDefaultOpenApi: "11184809";
|
|
8534
8703
|
};
|
|
8535
|
-
export type
|
|
8704
|
+
export type WatchlistMonitorBuilderReportNameEnum = typeof WatchlistMonitorBuilderReportNameEnum[keyof typeof WatchlistMonitorBuilderReportNameEnum];
|
|
8536
8705
|
/**
|
|
8537
8706
|
*
|
|
8538
8707
|
* @export
|
|
@@ -8550,7 +8719,114 @@ export interface WatchlistMonitorMatch {
|
|
|
8550
8719
|
* @type {boolean}
|
|
8551
8720
|
* @memberof WatchlistMonitorMatch
|
|
8552
8721
|
*/
|
|
8553
|
-
'
|
|
8722
|
+
'enabled'?: boolean;
|
|
8723
|
+
}
|
|
8724
|
+
/**
|
|
8725
|
+
*
|
|
8726
|
+
* @export
|
|
8727
|
+
* @interface WatchlistMonitorMatchesList
|
|
8728
|
+
*/
|
|
8729
|
+
export interface WatchlistMonitorMatchesList {
|
|
8730
|
+
/**
|
|
8731
|
+
*
|
|
8732
|
+
* @type {Array<WatchlistMonitorMatch>}
|
|
8733
|
+
* @memberof WatchlistMonitorMatchesList
|
|
8734
|
+
*/
|
|
8735
|
+
'matches': Array<WatchlistMonitorMatch>;
|
|
8736
|
+
}
|
|
8737
|
+
/**
|
|
8738
|
+
*
|
|
8739
|
+
* @export
|
|
8740
|
+
* @interface WatchlistMonitorMatchesUpdater
|
|
8741
|
+
*/
|
|
8742
|
+
export interface WatchlistMonitorMatchesUpdater {
|
|
8743
|
+
/**
|
|
8744
|
+
*
|
|
8745
|
+
* @type {Array<string>}
|
|
8746
|
+
* @memberof WatchlistMonitorMatchesUpdater
|
|
8747
|
+
*/
|
|
8748
|
+
'enable'?: Array<string>;
|
|
8749
|
+
/**
|
|
8750
|
+
*
|
|
8751
|
+
* @type {Array<string>}
|
|
8752
|
+
* @memberof WatchlistMonitorMatchesUpdater
|
|
8753
|
+
*/
|
|
8754
|
+
'disable'?: Array<string>;
|
|
8755
|
+
}
|
|
8756
|
+
/**
|
|
8757
|
+
*
|
|
8758
|
+
* @export
|
|
8759
|
+
* @interface WatchlistMonitorResponse
|
|
8760
|
+
*/
|
|
8761
|
+
export interface WatchlistMonitorResponse {
|
|
8762
|
+
/**
|
|
8763
|
+
* The unique identifier for the monitor.
|
|
8764
|
+
* @type {string}
|
|
8765
|
+
* @memberof WatchlistMonitorResponse
|
|
8766
|
+
*/
|
|
8767
|
+
'id': string;
|
|
8768
|
+
/**
|
|
8769
|
+
* The date and time at which the monitor was created.
|
|
8770
|
+
* @type {string}
|
|
8771
|
+
* @memberof WatchlistMonitorResponse
|
|
8772
|
+
*/
|
|
8773
|
+
'created_at'?: string;
|
|
8774
|
+
/**
|
|
8775
|
+
* The date and time at which the monitor was deleted. If the monitor is still active, this field will be null.
|
|
8776
|
+
* @type {string}
|
|
8777
|
+
* @memberof WatchlistMonitorResponse
|
|
8778
|
+
*/
|
|
8779
|
+
'deleted_at'?: string;
|
|
8780
|
+
/**
|
|
8781
|
+
* Indicates whether the object was created in the sandbox or not.
|
|
8782
|
+
* @type {boolean}
|
|
8783
|
+
* @memberof WatchlistMonitorResponse
|
|
8784
|
+
*/
|
|
8785
|
+
'is_sandbox'?: boolean;
|
|
8786
|
+
}
|
|
8787
|
+
/**
|
|
8788
|
+
*
|
|
8789
|
+
* @export
|
|
8790
|
+
* @interface WatchlistMonitorShared
|
|
8791
|
+
*/
|
|
8792
|
+
export interface WatchlistMonitorShared {
|
|
8793
|
+
/**
|
|
8794
|
+
* The ID for the applicant associated with the monitor.
|
|
8795
|
+
* @type {string}
|
|
8796
|
+
* @memberof WatchlistMonitorShared
|
|
8797
|
+
*/
|
|
8798
|
+
'applicant_id': string;
|
|
8799
|
+
/**
|
|
8800
|
+
* The name of the report type the monitor creates.
|
|
8801
|
+
* @type {string}
|
|
8802
|
+
* @memberof WatchlistMonitorShared
|
|
8803
|
+
*/
|
|
8804
|
+
'report_name': WatchlistMonitorSharedReportNameEnum;
|
|
8805
|
+
/**
|
|
8806
|
+
* A list of tags associated with this monitor. These tags will be applied to each check this monitor creates.
|
|
8807
|
+
* @type {Array<string>}
|
|
8808
|
+
* @memberof WatchlistMonitorShared
|
|
8809
|
+
*/
|
|
8810
|
+
'tags'?: Array<string>;
|
|
8811
|
+
}
|
|
8812
|
+
export declare const WatchlistMonitorSharedReportNameEnum: {
|
|
8813
|
+
readonly Standard: "watchlist_standard";
|
|
8814
|
+
readonly Aml: "watchlist_aml";
|
|
8815
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
8816
|
+
};
|
|
8817
|
+
export type WatchlistMonitorSharedReportNameEnum = typeof WatchlistMonitorSharedReportNameEnum[keyof typeof WatchlistMonitorSharedReportNameEnum];
|
|
8818
|
+
/**
|
|
8819
|
+
*
|
|
8820
|
+
* @export
|
|
8821
|
+
* @interface WatchlistMonitorsList
|
|
8822
|
+
*/
|
|
8823
|
+
export interface WatchlistMonitorsList {
|
|
8824
|
+
/**
|
|
8825
|
+
*
|
|
8826
|
+
* @type {Array<WatchlistMonitor>}
|
|
8827
|
+
* @memberof WatchlistMonitorsList
|
|
8828
|
+
*/
|
|
8829
|
+
'monitors': Array<WatchlistMonitor>;
|
|
8554
8830
|
}
|
|
8555
8831
|
/**
|
|
8556
8832
|
*
|
|
@@ -9522,11 +9798,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9522
9798
|
* @summary Complete Task
|
|
9523
9799
|
* @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
|
|
9524
9800
|
* @param {string} taskId The identifier of the Task you want to complete.
|
|
9525
|
-
* @param {
|
|
9801
|
+
* @param {CompleteTaskBuilder} completeTaskBuilder
|
|
9526
9802
|
* @param {*} [options] Override http request option.
|
|
9527
9803
|
* @throws {RequiredError}
|
|
9528
9804
|
*/
|
|
9529
|
-
completeTask: (workflowRunId: string, taskId: string,
|
|
9805
|
+
completeTask: (workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9530
9806
|
/**
|
|
9531
9807
|
* Creates a single applicant. Returns an applicant object.
|
|
9532
9808
|
* @summary Create Applicant
|
|
@@ -9543,14 +9819,22 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9543
9819
|
* @throws {RequiredError}
|
|
9544
9820
|
*/
|
|
9545
9821
|
createCheck: (checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9822
|
+
/**
|
|
9823
|
+
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
9824
|
+
* @summary Create Timeline File for Workflow Run
|
|
9825
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
9826
|
+
* @param {*} [options] Override http request option.
|
|
9827
|
+
* @throws {RequiredError}
|
|
9828
|
+
*/
|
|
9829
|
+
createTimelineFile: (workflowRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9546
9830
|
/**
|
|
9547
9831
|
* Creates a new monitor for the applicant
|
|
9548
9832
|
* @summary Create monitor
|
|
9549
|
-
* @param {
|
|
9833
|
+
* @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
|
|
9550
9834
|
* @param {*} [options] Override http request option.
|
|
9551
9835
|
* @throws {RequiredError}
|
|
9552
9836
|
*/
|
|
9553
|
-
createWatchlistMonitor: (
|
|
9837
|
+
createWatchlistMonitor: (watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9554
9838
|
/**
|
|
9555
9839
|
* Registers a webhook. Returns a webhook object.
|
|
9556
9840
|
* @summary Register webhook
|
|
@@ -9760,6 +10044,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9760
10044
|
* @throws {RequiredError}
|
|
9761
10045
|
*/
|
|
9762
10046
|
findTask: (workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10047
|
+
/**
|
|
10048
|
+
* Retrieves the Timeline File for the designated Workflow Run.
|
|
10049
|
+
* @summary Retrieve Timeline File for Workflow Run
|
|
10050
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
10051
|
+
* @param {string} timelineFileId The unique identifier for the Timefile File.
|
|
10052
|
+
* @param {*} [options] Override http request option.
|
|
10053
|
+
* @throws {RequiredError}
|
|
10054
|
+
*/
|
|
10055
|
+
findTimelineFile: (workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9763
10056
|
/**
|
|
9764
10057
|
* Retrieves a single monitor
|
|
9765
10058
|
* @summary Retrieve monitor
|
|
@@ -9791,7 +10084,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9791
10084
|
* @param {*} [options] Override http request option.
|
|
9792
10085
|
* @throws {RequiredError}
|
|
9793
10086
|
*/
|
|
9794
|
-
|
|
10087
|
+
forceReportCreationFromWatchlistMonitor: (monitorId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9795
10088
|
/**
|
|
9796
10089
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
9797
10090
|
* @summary Generate a SDK token
|
|
@@ -9978,11 +10271,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9978
10271
|
* Update the status of the given matches
|
|
9979
10272
|
* @summary Set match status (BETA)
|
|
9980
10273
|
* @param {string} monitorId
|
|
9981
|
-
* @param {
|
|
10274
|
+
* @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
|
|
9982
10275
|
* @param {*} [options] Override http request option.
|
|
9983
10276
|
* @throws {RequiredError}
|
|
9984
10277
|
*/
|
|
9985
|
-
|
|
10278
|
+
updateWatchlistMonitorMatch: (monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9986
10279
|
/**
|
|
9987
10280
|
* Edits a webhook. Returns the updated webhook object.
|
|
9988
10281
|
* @summary Edit a webhook
|
|
@@ -9997,7 +10290,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9997
10290
|
* @summary Upload a document
|
|
9998
10291
|
* @param {string} type The type of document
|
|
9999
10292
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
10000
|
-
* @param {
|
|
10293
|
+
* @param {FileTransfer} file The file to be uploaded.
|
|
10001
10294
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
10002
10295
|
* @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
|
|
10003
10296
|
* @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
|
|
@@ -10006,26 +10299,26 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
10006
10299
|
* @param {*} [options] Override http request option.
|
|
10007
10300
|
* @throws {RequiredError}
|
|
10008
10301
|
*/
|
|
10009
|
-
uploadDocument: (type: string, applicantId: string, file:
|
|
10302
|
+
uploadDocument: (type: string, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10010
10303
|
/**
|
|
10011
10304
|
* You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
|
|
10012
10305
|
* @summary Upload ID photo
|
|
10013
10306
|
* @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
|
|
10014
|
-
* @param {
|
|
10307
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
10015
10308
|
* @param {*} [options] Override http request option.
|
|
10016
10309
|
* @throws {RequiredError}
|
|
10017
10310
|
*/
|
|
10018
|
-
uploadIdPhoto: (applicantId?: string, file?:
|
|
10311
|
+
uploadIdPhoto: (applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10019
10312
|
/**
|
|
10020
10313
|
* You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
|
|
10021
10314
|
* @summary Upload live photo
|
|
10022
10315
|
* @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
|
|
10023
|
-
* @param {
|
|
10316
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
10024
10317
|
* @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
|
|
10025
10318
|
* @param {*} [options] Override http request option.
|
|
10026
10319
|
* @throws {RequiredError}
|
|
10027
10320
|
*/
|
|
10028
|
-
uploadLivePhoto: (applicantId?: string, file?:
|
|
10321
|
+
uploadLivePhoto: (applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10029
10322
|
};
|
|
10030
10323
|
/**
|
|
10031
10324
|
* DefaultApi - functional programming interface
|
|
@@ -10045,11 +10338,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10045
10338
|
* @summary Complete Task
|
|
10046
10339
|
* @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
|
|
10047
10340
|
* @param {string} taskId The identifier of the Task you want to complete.
|
|
10048
|
-
* @param {
|
|
10341
|
+
* @param {CompleteTaskBuilder} completeTaskBuilder
|
|
10049
10342
|
* @param {*} [options] Override http request option.
|
|
10050
10343
|
* @throws {RequiredError}
|
|
10051
10344
|
*/
|
|
10052
|
-
completeTask(workflowRunId: string, taskId: string,
|
|
10345
|
+
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10053
10346
|
/**
|
|
10054
10347
|
* Creates a single applicant. Returns an applicant object.
|
|
10055
10348
|
* @summary Create Applicant
|
|
@@ -10066,14 +10359,22 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10066
10359
|
* @throws {RequiredError}
|
|
10067
10360
|
*/
|
|
10068
10361
|
createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Check>>;
|
|
10362
|
+
/**
|
|
10363
|
+
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
10364
|
+
* @summary Create Timeline File for Workflow Run
|
|
10365
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
10366
|
+
* @param {*} [options] Override http request option.
|
|
10367
|
+
* @throws {RequiredError}
|
|
10368
|
+
*/
|
|
10369
|
+
createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimelineFileReference>>;
|
|
10069
10370
|
/**
|
|
10070
10371
|
* Creates a new monitor for the applicant
|
|
10071
10372
|
* @summary Create monitor
|
|
10072
|
-
* @param {
|
|
10373
|
+
* @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
|
|
10073
10374
|
* @param {*} [options] Override http request option.
|
|
10074
10375
|
* @throws {RequiredError}
|
|
10075
10376
|
*/
|
|
10076
|
-
createWatchlistMonitor(
|
|
10377
|
+
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitor>>;
|
|
10077
10378
|
/**
|
|
10078
10379
|
* Registers a webhook. Returns a webhook object.
|
|
10079
10380
|
* @summary Register webhook
|
|
@@ -10121,7 +10422,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10121
10422
|
* @param {*} [options] Override http request option.
|
|
10122
10423
|
* @throws {RequiredError}
|
|
10123
10424
|
*/
|
|
10124
|
-
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10425
|
+
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10125
10426
|
/**
|
|
10126
10427
|
* Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
10127
10428
|
* @summary Download document
|
|
@@ -10129,7 +10430,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10129
10430
|
* @param {*} [options] Override http request option.
|
|
10130
10431
|
* @throws {RequiredError}
|
|
10131
10432
|
*/
|
|
10132
|
-
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10433
|
+
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10133
10434
|
/**
|
|
10134
10435
|
* Downloads a document video. If successful, the response will be the binary data representing the video.
|
|
10135
10436
|
* @summary Download document video
|
|
@@ -10137,7 +10438,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10137
10438
|
* @param {*} [options] Override http request option.
|
|
10138
10439
|
* @throws {RequiredError}
|
|
10139
10440
|
*/
|
|
10140
|
-
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10441
|
+
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10141
10442
|
/**
|
|
10142
10443
|
* ID photos are downloaded using this endpoint.
|
|
10143
10444
|
* @summary Download ID photo
|
|
@@ -10145,7 +10446,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10145
10446
|
* @param {*} [options] Override http request option.
|
|
10146
10447
|
* @throws {RequiredError}
|
|
10147
10448
|
*/
|
|
10148
|
-
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10449
|
+
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10149
10450
|
/**
|
|
10150
10451
|
* Live photos are downloaded using this endpoint.
|
|
10151
10452
|
* @summary Download live photo
|
|
@@ -10153,7 +10454,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10153
10454
|
* @param {*} [options] Override http request option.
|
|
10154
10455
|
* @throws {RequiredError}
|
|
10155
10456
|
*/
|
|
10156
|
-
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10457
|
+
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10157
10458
|
/**
|
|
10158
10459
|
* Live videos are downloaded using this endpoint.
|
|
10159
10460
|
* @summary Download live video
|
|
@@ -10161,7 +10462,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10161
10462
|
* @param {*} [options] Override http request option.
|
|
10162
10463
|
* @throws {RequiredError}
|
|
10163
10464
|
*/
|
|
10164
|
-
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10465
|
+
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10165
10466
|
/**
|
|
10166
10467
|
* Returns the binary data representing a single frame from a live video.
|
|
10167
10468
|
* @summary Download live video frame
|
|
@@ -10169,7 +10470,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10169
10470
|
* @param {*} [options] Override http request option.
|
|
10170
10471
|
* @throws {RequiredError}
|
|
10171
10472
|
*/
|
|
10172
|
-
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10473
|
+
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10173
10474
|
/**
|
|
10174
10475
|
* Motion captures are downloaded using this endpoint.
|
|
10175
10476
|
* @summary Download motion capture
|
|
@@ -10177,7 +10478,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10177
10478
|
* @param {*} [options] Override http request option.
|
|
10178
10479
|
* @throws {RequiredError}
|
|
10179
10480
|
*/
|
|
10180
|
-
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10481
|
+
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10181
10482
|
/**
|
|
10182
10483
|
* Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
|
10183
10484
|
* @summary Download motion capture frame
|
|
@@ -10185,7 +10486,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10185
10486
|
* @param {*} [options] Override http request option.
|
|
10186
10487
|
* @throws {RequiredError}
|
|
10187
10488
|
*/
|
|
10188
|
-
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10489
|
+
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10189
10490
|
/**
|
|
10190
10491
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
10191
10492
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -10193,7 +10494,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10193
10494
|
* @param {*} [options] Override http request option.
|
|
10194
10495
|
* @throws {RequiredError}
|
|
10195
10496
|
*/
|
|
10196
|
-
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10497
|
+
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10197
10498
|
/**
|
|
10198
10499
|
* Extract information from a document
|
|
10199
10500
|
* @summary Autofill
|
|
@@ -10283,6 +10584,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10283
10584
|
* @throws {RequiredError}
|
|
10284
10585
|
*/
|
|
10285
10586
|
findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Task>>;
|
|
10587
|
+
/**
|
|
10588
|
+
* Retrieves the Timeline File for the designated Workflow Run.
|
|
10589
|
+
* @summary Retrieve Timeline File for Workflow Run
|
|
10590
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
10591
|
+
* @param {string} timelineFileId The unique identifier for the Timefile File.
|
|
10592
|
+
* @param {*} [options] Override http request option.
|
|
10593
|
+
* @throws {RequiredError}
|
|
10594
|
+
*/
|
|
10595
|
+
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10286
10596
|
/**
|
|
10287
10597
|
* Retrieves a single monitor
|
|
10288
10598
|
* @summary Retrieve monitor
|
|
@@ -10314,7 +10624,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10314
10624
|
* @param {*} [options] Override http request option.
|
|
10315
10625
|
* @throws {RequiredError}
|
|
10316
10626
|
*/
|
|
10317
|
-
|
|
10627
|
+
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10318
10628
|
/**
|
|
10319
10629
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
10320
10630
|
* @summary Generate a SDK token
|
|
@@ -10356,7 +10666,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10356
10666
|
* @param {*} [options] Override http request option.
|
|
10357
10667
|
* @throws {RequiredError}
|
|
10358
10668
|
*/
|
|
10359
|
-
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10669
|
+
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdPhotosList>>;
|
|
10360
10670
|
/**
|
|
10361
10671
|
* Lists the live photos that belong to an applicant.
|
|
10362
10672
|
* @summary List live photos
|
|
@@ -10372,7 +10682,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10372
10682
|
* @param {*} [options] Override http request option.
|
|
10373
10683
|
* @throws {RequiredError}
|
|
10374
10684
|
*/
|
|
10375
|
-
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10685
|
+
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveVideosList>>;
|
|
10376
10686
|
/**
|
|
10377
10687
|
* Lists all the motion captures that belong to an applicant.
|
|
10378
10688
|
* @summary List motion captures
|
|
@@ -10404,7 +10714,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10404
10714
|
* @param {*} [options] Override http request option.
|
|
10405
10715
|
* @throws {RequiredError}
|
|
10406
10716
|
*/
|
|
10407
|
-
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
10717
|
+
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskItem>>>;
|
|
10408
10718
|
/**
|
|
10409
10719
|
* List match IDs on this monitor, as well as their enabled/disabled status
|
|
10410
10720
|
* @summary List matches (BETA)
|
|
@@ -10412,7 +10722,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10412
10722
|
* @param {*} [options] Override http request option.
|
|
10413
10723
|
* @throws {RequiredError}
|
|
10414
10724
|
*/
|
|
10415
|
-
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10725
|
+
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitorMatchesList>>;
|
|
10416
10726
|
/**
|
|
10417
10727
|
* List all available monitors for an applicant
|
|
10418
10728
|
* @summary List monitors
|
|
@@ -10421,7 +10731,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10421
10731
|
* @param {*} [options] Override http request option.
|
|
10422
10732
|
* @throws {RequiredError}
|
|
10423
10733
|
*/
|
|
10424
|
-
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10734
|
+
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitorsList>>;
|
|
10425
10735
|
/**
|
|
10426
10736
|
* Lists all webhooks you\'ve created.
|
|
10427
10737
|
* @summary List webhooks
|
|
@@ -10501,11 +10811,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10501
10811
|
* Update the status of the given matches
|
|
10502
10812
|
* @summary Set match status (BETA)
|
|
10503
10813
|
* @param {string} monitorId
|
|
10504
|
-
* @param {
|
|
10814
|
+
* @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
|
|
10505
10815
|
* @param {*} [options] Override http request option.
|
|
10506
10816
|
* @throws {RequiredError}
|
|
10507
10817
|
*/
|
|
10508
|
-
|
|
10818
|
+
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitorMatchesList>>;
|
|
10509
10819
|
/**
|
|
10510
10820
|
* Edits a webhook. Returns the updated webhook object.
|
|
10511
10821
|
* @summary Edit a webhook
|
|
@@ -10520,7 +10830,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10520
10830
|
* @summary Upload a document
|
|
10521
10831
|
* @param {string} type The type of document
|
|
10522
10832
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
10523
|
-
* @param {
|
|
10833
|
+
* @param {FileTransfer} file The file to be uploaded.
|
|
10524
10834
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
10525
10835
|
* @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
|
|
10526
10836
|
* @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
|
|
@@ -10529,26 +10839,26 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10529
10839
|
* @param {*} [options] Override http request option.
|
|
10530
10840
|
* @throws {RequiredError}
|
|
10531
10841
|
*/
|
|
10532
|
-
uploadDocument(type: string, applicantId: string, file:
|
|
10842
|
+
uploadDocument(type: string, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Document>>;
|
|
10533
10843
|
/**
|
|
10534
10844
|
* You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
|
|
10535
10845
|
* @summary Upload ID photo
|
|
10536
10846
|
* @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
|
|
10537
|
-
* @param {
|
|
10847
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
10538
10848
|
* @param {*} [options] Override http request option.
|
|
10539
10849
|
* @throws {RequiredError}
|
|
10540
10850
|
*/
|
|
10541
|
-
uploadIdPhoto(applicantId?: string, file?:
|
|
10851
|
+
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdPhoto>>;
|
|
10542
10852
|
/**
|
|
10543
10853
|
* You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
|
|
10544
10854
|
* @summary Upload live photo
|
|
10545
10855
|
* @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
|
|
10546
|
-
* @param {
|
|
10856
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
10547
10857
|
* @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
|
|
10548
10858
|
* @param {*} [options] Override http request option.
|
|
10549
10859
|
* @throws {RequiredError}
|
|
10550
10860
|
*/
|
|
10551
|
-
uploadLivePhoto(applicantId?: string, file?:
|
|
10861
|
+
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LivePhoto>>;
|
|
10552
10862
|
};
|
|
10553
10863
|
/**
|
|
10554
10864
|
* DefaultApi - factory interface
|
|
@@ -10568,11 +10878,11 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10568
10878
|
* @summary Complete Task
|
|
10569
10879
|
* @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
|
|
10570
10880
|
* @param {string} taskId The identifier of the Task you want to complete.
|
|
10571
|
-
* @param {
|
|
10881
|
+
* @param {CompleteTaskBuilder} completeTaskBuilder
|
|
10572
10882
|
* @param {*} [options] Override http request option.
|
|
10573
10883
|
* @throws {RequiredError}
|
|
10574
10884
|
*/
|
|
10575
|
-
completeTask(workflowRunId: string, taskId: string,
|
|
10885
|
+
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: any): AxiosPromise<void>;
|
|
10576
10886
|
/**
|
|
10577
10887
|
* Creates a single applicant. Returns an applicant object.
|
|
10578
10888
|
* @summary Create Applicant
|
|
@@ -10589,14 +10899,22 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10589
10899
|
* @throws {RequiredError}
|
|
10590
10900
|
*/
|
|
10591
10901
|
createCheck(checkBuilder: CheckBuilder, options?: any): AxiosPromise<Check>;
|
|
10902
|
+
/**
|
|
10903
|
+
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
10904
|
+
* @summary Create Timeline File for Workflow Run
|
|
10905
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
10906
|
+
* @param {*} [options] Override http request option.
|
|
10907
|
+
* @throws {RequiredError}
|
|
10908
|
+
*/
|
|
10909
|
+
createTimelineFile(workflowRunId: string, options?: any): AxiosPromise<TimelineFileReference>;
|
|
10592
10910
|
/**
|
|
10593
10911
|
* Creates a new monitor for the applicant
|
|
10594
10912
|
* @summary Create monitor
|
|
10595
|
-
* @param {
|
|
10913
|
+
* @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
|
|
10596
10914
|
* @param {*} [options] Override http request option.
|
|
10597
10915
|
* @throws {RequiredError}
|
|
10598
10916
|
*/
|
|
10599
|
-
createWatchlistMonitor(
|
|
10917
|
+
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: any): AxiosPromise<WatchlistMonitor>;
|
|
10600
10918
|
/**
|
|
10601
10919
|
* Registers a webhook. Returns a webhook object.
|
|
10602
10920
|
* @summary Register webhook
|
|
@@ -10644,7 +10962,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10644
10962
|
* @param {*} [options] Override http request option.
|
|
10645
10963
|
* @throws {RequiredError}
|
|
10646
10964
|
*/
|
|
10647
|
-
downloadCheck(checkId: string, options?: any): AxiosPromise<
|
|
10965
|
+
downloadCheck(checkId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10648
10966
|
/**
|
|
10649
10967
|
* Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
10650
10968
|
* @summary Download document
|
|
@@ -10652,7 +10970,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10652
10970
|
* @param {*} [options] Override http request option.
|
|
10653
10971
|
* @throws {RequiredError}
|
|
10654
10972
|
*/
|
|
10655
|
-
downloadDocument(documentId: string, options?: any): AxiosPromise<
|
|
10973
|
+
downloadDocument(documentId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10656
10974
|
/**
|
|
10657
10975
|
* Downloads a document video. If successful, the response will be the binary data representing the video.
|
|
10658
10976
|
* @summary Download document video
|
|
@@ -10660,7 +10978,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10660
10978
|
* @param {*} [options] Override http request option.
|
|
10661
10979
|
* @throws {RequiredError}
|
|
10662
10980
|
*/
|
|
10663
|
-
downloadDocumentVideo(documentId: string, options?: any): AxiosPromise<
|
|
10981
|
+
downloadDocumentVideo(documentId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10664
10982
|
/**
|
|
10665
10983
|
* ID photos are downloaded using this endpoint.
|
|
10666
10984
|
* @summary Download ID photo
|
|
@@ -10668,7 +10986,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10668
10986
|
* @param {*} [options] Override http request option.
|
|
10669
10987
|
* @throws {RequiredError}
|
|
10670
10988
|
*/
|
|
10671
|
-
downloadIdPhoto(idPhotoId: string, options?: any): AxiosPromise<
|
|
10989
|
+
downloadIdPhoto(idPhotoId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10672
10990
|
/**
|
|
10673
10991
|
* Live photos are downloaded using this endpoint.
|
|
10674
10992
|
* @summary Download live photo
|
|
@@ -10676,7 +10994,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10676
10994
|
* @param {*} [options] Override http request option.
|
|
10677
10995
|
* @throws {RequiredError}
|
|
10678
10996
|
*/
|
|
10679
|
-
downloadLivePhoto(livePhotoId: string, options?: any): AxiosPromise<
|
|
10997
|
+
downloadLivePhoto(livePhotoId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10680
10998
|
/**
|
|
10681
10999
|
* Live videos are downloaded using this endpoint.
|
|
10682
11000
|
* @summary Download live video
|
|
@@ -10684,7 +11002,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10684
11002
|
* @param {*} [options] Override http request option.
|
|
10685
11003
|
* @throws {RequiredError}
|
|
10686
11004
|
*/
|
|
10687
|
-
downloadLiveVideo(liveVideoId: string, options?: any): AxiosPromise<
|
|
11005
|
+
downloadLiveVideo(liveVideoId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10688
11006
|
/**
|
|
10689
11007
|
* Returns the binary data representing a single frame from a live video.
|
|
10690
11008
|
* @summary Download live video frame
|
|
@@ -10692,7 +11010,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10692
11010
|
* @param {*} [options] Override http request option.
|
|
10693
11011
|
* @throws {RequiredError}
|
|
10694
11012
|
*/
|
|
10695
|
-
downloadLiveVideoFrame(liveVideoId: string, options?: any): AxiosPromise<
|
|
11013
|
+
downloadLiveVideoFrame(liveVideoId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10696
11014
|
/**
|
|
10697
11015
|
* Motion captures are downloaded using this endpoint.
|
|
10698
11016
|
* @summary Download motion capture
|
|
@@ -10700,7 +11018,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10700
11018
|
* @param {*} [options] Override http request option.
|
|
10701
11019
|
* @throws {RequiredError}
|
|
10702
11020
|
*/
|
|
10703
|
-
downloadMotionCapture(motionCaptureId: string, options?: any): AxiosPromise<
|
|
11021
|
+
downloadMotionCapture(motionCaptureId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10704
11022
|
/**
|
|
10705
11023
|
* Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
|
10706
11024
|
* @summary Download motion capture frame
|
|
@@ -10708,7 +11026,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10708
11026
|
* @param {*} [options] Override http request option.
|
|
10709
11027
|
* @throws {RequiredError}
|
|
10710
11028
|
*/
|
|
10711
|
-
downloadMotionCaptureFrame(motionCaptureId: string, options?: any): AxiosPromise<
|
|
11029
|
+
downloadMotionCaptureFrame(motionCaptureId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10712
11030
|
/**
|
|
10713
11031
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
10714
11032
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -10716,7 +11034,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10716
11034
|
* @param {*} [options] Override http request option.
|
|
10717
11035
|
* @throws {RequiredError}
|
|
10718
11036
|
*/
|
|
10719
|
-
downloadSignedEvidenceFile(workflowRunId: string, options?: any): AxiosPromise<
|
|
11037
|
+
downloadSignedEvidenceFile(workflowRunId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10720
11038
|
/**
|
|
10721
11039
|
* Extract information from a document
|
|
10722
11040
|
* @summary Autofill
|
|
@@ -10806,6 +11124,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10806
11124
|
* @throws {RequiredError}
|
|
10807
11125
|
*/
|
|
10808
11126
|
findTask(workflowRunId: string, taskId: string, options?: any): AxiosPromise<Task>;
|
|
11127
|
+
/**
|
|
11128
|
+
* Retrieves the Timeline File for the designated Workflow Run.
|
|
11129
|
+
* @summary Retrieve Timeline File for Workflow Run
|
|
11130
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
11131
|
+
* @param {string} timelineFileId The unique identifier for the Timefile File.
|
|
11132
|
+
* @param {*} [options] Override http request option.
|
|
11133
|
+
* @throws {RequiredError}
|
|
11134
|
+
*/
|
|
11135
|
+
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10809
11136
|
/**
|
|
10810
11137
|
* Retrieves a single monitor
|
|
10811
11138
|
* @summary Retrieve monitor
|
|
@@ -10837,7 +11164,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10837
11164
|
* @param {*} [options] Override http request option.
|
|
10838
11165
|
* @throws {RequiredError}
|
|
10839
11166
|
*/
|
|
10840
|
-
|
|
11167
|
+
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: any): AxiosPromise<void>;
|
|
10841
11168
|
/**
|
|
10842
11169
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
10843
11170
|
* @summary Generate a SDK token
|
|
@@ -10879,7 +11206,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10879
11206
|
* @param {*} [options] Override http request option.
|
|
10880
11207
|
* @throws {RequiredError}
|
|
10881
11208
|
*/
|
|
10882
|
-
listIdPhotos(applicantId: string, options?: any): AxiosPromise<
|
|
11209
|
+
listIdPhotos(applicantId: string, options?: any): AxiosPromise<IdPhotosList>;
|
|
10883
11210
|
/**
|
|
10884
11211
|
* Lists the live photos that belong to an applicant.
|
|
10885
11212
|
* @summary List live photos
|
|
@@ -10895,7 +11222,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10895
11222
|
* @param {*} [options] Override http request option.
|
|
10896
11223
|
* @throws {RequiredError}
|
|
10897
11224
|
*/
|
|
10898
|
-
listLiveVideos(applicantId: string, options?: any): AxiosPromise<
|
|
11225
|
+
listLiveVideos(applicantId: string, options?: any): AxiosPromise<LiveVideosList>;
|
|
10899
11226
|
/**
|
|
10900
11227
|
* Lists all the motion captures that belong to an applicant.
|
|
10901
11228
|
* @summary List motion captures
|
|
@@ -10927,7 +11254,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10927
11254
|
* @param {*} [options] Override http request option.
|
|
10928
11255
|
* @throws {RequiredError}
|
|
10929
11256
|
*/
|
|
10930
|
-
listTasks(workflowRunId: string, options?: any): AxiosPromise<Array<
|
|
11257
|
+
listTasks(workflowRunId: string, options?: any): AxiosPromise<Array<TaskItem>>;
|
|
10931
11258
|
/**
|
|
10932
11259
|
* List match IDs on this monitor, as well as their enabled/disabled status
|
|
10933
11260
|
* @summary List matches (BETA)
|
|
@@ -10935,7 +11262,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10935
11262
|
* @param {*} [options] Override http request option.
|
|
10936
11263
|
* @throws {RequiredError}
|
|
10937
11264
|
*/
|
|
10938
|
-
listWatchlistMonitorMatches(monitorId: string, options?: any): AxiosPromise<
|
|
11265
|
+
listWatchlistMonitorMatches(monitorId: string, options?: any): AxiosPromise<WatchlistMonitorMatchesList>;
|
|
10939
11266
|
/**
|
|
10940
11267
|
* List all available monitors for an applicant
|
|
10941
11268
|
* @summary List monitors
|
|
@@ -10944,7 +11271,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10944
11271
|
* @param {*} [options] Override http request option.
|
|
10945
11272
|
* @throws {RequiredError}
|
|
10946
11273
|
*/
|
|
10947
|
-
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: any): AxiosPromise<
|
|
11274
|
+
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: any): AxiosPromise<WatchlistMonitorsList>;
|
|
10948
11275
|
/**
|
|
10949
11276
|
* Lists all webhooks you\'ve created.
|
|
10950
11277
|
* @summary List webhooks
|
|
@@ -11024,11 +11351,11 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11024
11351
|
* Update the status of the given matches
|
|
11025
11352
|
* @summary Set match status (BETA)
|
|
11026
11353
|
* @param {string} monitorId
|
|
11027
|
-
* @param {
|
|
11354
|
+
* @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
|
|
11028
11355
|
* @param {*} [options] Override http request option.
|
|
11029
11356
|
* @throws {RequiredError}
|
|
11030
11357
|
*/
|
|
11031
|
-
|
|
11358
|
+
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: any): AxiosPromise<WatchlistMonitorMatchesList>;
|
|
11032
11359
|
/**
|
|
11033
11360
|
* Edits a webhook. Returns the updated webhook object.
|
|
11034
11361
|
* @summary Edit a webhook
|
|
@@ -11043,7 +11370,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11043
11370
|
* @summary Upload a document
|
|
11044
11371
|
* @param {string} type The type of document
|
|
11045
11372
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
11046
|
-
* @param {
|
|
11373
|
+
* @param {FileTransfer} file The file to be uploaded.
|
|
11047
11374
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
11048
11375
|
* @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
|
|
11049
11376
|
* @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
|
|
@@ -11052,26 +11379,26 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11052
11379
|
* @param {*} [options] Override http request option.
|
|
11053
11380
|
* @throws {RequiredError}
|
|
11054
11381
|
*/
|
|
11055
|
-
uploadDocument(type: string, applicantId: string, file:
|
|
11382
|
+
uploadDocument(type: string, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: any): AxiosPromise<Document>;
|
|
11056
11383
|
/**
|
|
11057
11384
|
* You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
|
|
11058
11385
|
* @summary Upload ID photo
|
|
11059
11386
|
* @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
|
|
11060
|
-
* @param {
|
|
11387
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
11061
11388
|
* @param {*} [options] Override http request option.
|
|
11062
11389
|
* @throws {RequiredError}
|
|
11063
11390
|
*/
|
|
11064
|
-
uploadIdPhoto(applicantId?: string, file?:
|
|
11391
|
+
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: any): AxiosPromise<IdPhoto>;
|
|
11065
11392
|
/**
|
|
11066
11393
|
* You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
|
|
11067
11394
|
* @summary Upload live photo
|
|
11068
11395
|
* @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
|
|
11069
|
-
* @param {
|
|
11396
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
11070
11397
|
* @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
|
|
11071
11398
|
* @param {*} [options] Override http request option.
|
|
11072
11399
|
* @throws {RequiredError}
|
|
11073
11400
|
*/
|
|
11074
|
-
uploadLivePhoto(applicantId?: string, file?:
|
|
11401
|
+
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: any): AxiosPromise<LivePhoto>;
|
|
11075
11402
|
};
|
|
11076
11403
|
/**
|
|
11077
11404
|
* DefaultApi - object-oriented interface
|
|
@@ -11094,12 +11421,12 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11094
11421
|
* @summary Complete Task
|
|
11095
11422
|
* @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
|
|
11096
11423
|
* @param {string} taskId The identifier of the Task you want to complete.
|
|
11097
|
-
* @param {
|
|
11424
|
+
* @param {CompleteTaskBuilder} completeTaskBuilder
|
|
11098
11425
|
* @param {*} [options] Override http request option.
|
|
11099
11426
|
* @throws {RequiredError}
|
|
11100
11427
|
* @memberof DefaultApi
|
|
11101
11428
|
*/
|
|
11102
|
-
completeTask(workflowRunId: string, taskId: string,
|
|
11429
|
+
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11103
11430
|
/**
|
|
11104
11431
|
* Creates a single applicant. Returns an applicant object.
|
|
11105
11432
|
* @summary Create Applicant
|
|
@@ -11118,15 +11445,24 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11118
11445
|
* @memberof DefaultApi
|
|
11119
11446
|
*/
|
|
11120
11447
|
createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any>>;
|
|
11448
|
+
/**
|
|
11449
|
+
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
11450
|
+
* @summary Create Timeline File for Workflow Run
|
|
11451
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
11452
|
+
* @param {*} [options] Override http request option.
|
|
11453
|
+
* @throws {RequiredError}
|
|
11454
|
+
* @memberof DefaultApi
|
|
11455
|
+
*/
|
|
11456
|
+
createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TimelineFileReference, any>>;
|
|
11121
11457
|
/**
|
|
11122
11458
|
* Creates a new monitor for the applicant
|
|
11123
11459
|
* @summary Create monitor
|
|
11124
|
-
* @param {
|
|
11460
|
+
* @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
|
|
11125
11461
|
* @param {*} [options] Override http request option.
|
|
11126
11462
|
* @throws {RequiredError}
|
|
11127
11463
|
* @memberof DefaultApi
|
|
11128
11464
|
*/
|
|
11129
|
-
createWatchlistMonitor(
|
|
11465
|
+
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any>>;
|
|
11130
11466
|
/**
|
|
11131
11467
|
* Registers a webhook. Returns a webhook object.
|
|
11132
11468
|
* @summary Register webhook
|
|
@@ -11180,7 +11516,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11180
11516
|
* @throws {RequiredError}
|
|
11181
11517
|
* @memberof DefaultApi
|
|
11182
11518
|
*/
|
|
11183
|
-
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11519
|
+
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11184
11520
|
/**
|
|
11185
11521
|
* Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
11186
11522
|
* @summary Download document
|
|
@@ -11189,7 +11525,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11189
11525
|
* @throws {RequiredError}
|
|
11190
11526
|
* @memberof DefaultApi
|
|
11191
11527
|
*/
|
|
11192
|
-
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11528
|
+
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11193
11529
|
/**
|
|
11194
11530
|
* Downloads a document video. If successful, the response will be the binary data representing the video.
|
|
11195
11531
|
* @summary Download document video
|
|
@@ -11198,7 +11534,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11198
11534
|
* @throws {RequiredError}
|
|
11199
11535
|
* @memberof DefaultApi
|
|
11200
11536
|
*/
|
|
11201
|
-
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11537
|
+
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11202
11538
|
/**
|
|
11203
11539
|
* ID photos are downloaded using this endpoint.
|
|
11204
11540
|
* @summary Download ID photo
|
|
@@ -11207,7 +11543,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11207
11543
|
* @throws {RequiredError}
|
|
11208
11544
|
* @memberof DefaultApi
|
|
11209
11545
|
*/
|
|
11210
|
-
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11546
|
+
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11211
11547
|
/**
|
|
11212
11548
|
* Live photos are downloaded using this endpoint.
|
|
11213
11549
|
* @summary Download live photo
|
|
@@ -11216,7 +11552,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11216
11552
|
* @throws {RequiredError}
|
|
11217
11553
|
* @memberof DefaultApi
|
|
11218
11554
|
*/
|
|
11219
|
-
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11555
|
+
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11220
11556
|
/**
|
|
11221
11557
|
* Live videos are downloaded using this endpoint.
|
|
11222
11558
|
* @summary Download live video
|
|
@@ -11225,7 +11561,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11225
11561
|
* @throws {RequiredError}
|
|
11226
11562
|
* @memberof DefaultApi
|
|
11227
11563
|
*/
|
|
11228
|
-
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11564
|
+
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11229
11565
|
/**
|
|
11230
11566
|
* Returns the binary data representing a single frame from a live video.
|
|
11231
11567
|
* @summary Download live video frame
|
|
@@ -11234,7 +11570,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11234
11570
|
* @throws {RequiredError}
|
|
11235
11571
|
* @memberof DefaultApi
|
|
11236
11572
|
*/
|
|
11237
|
-
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11573
|
+
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11238
11574
|
/**
|
|
11239
11575
|
* Motion captures are downloaded using this endpoint.
|
|
11240
11576
|
* @summary Download motion capture
|
|
@@ -11243,7 +11579,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11243
11579
|
* @throws {RequiredError}
|
|
11244
11580
|
* @memberof DefaultApi
|
|
11245
11581
|
*/
|
|
11246
|
-
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11582
|
+
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11247
11583
|
/**
|
|
11248
11584
|
* Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
|
11249
11585
|
* @summary Download motion capture frame
|
|
@@ -11252,7 +11588,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11252
11588
|
* @throws {RequiredError}
|
|
11253
11589
|
* @memberof DefaultApi
|
|
11254
11590
|
*/
|
|
11255
|
-
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11591
|
+
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11256
11592
|
/**
|
|
11257
11593
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
11258
11594
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -11261,7 +11597,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11261
11597
|
* @throws {RequiredError}
|
|
11262
11598
|
* @memberof DefaultApi
|
|
11263
11599
|
*/
|
|
11264
|
-
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11600
|
+
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11265
11601
|
/**
|
|
11266
11602
|
* Extract information from a document
|
|
11267
11603
|
* @summary Autofill
|
|
@@ -11362,6 +11698,16 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11362
11698
|
* @memberof DefaultApi
|
|
11363
11699
|
*/
|
|
11364
11700
|
findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Task, any>>;
|
|
11701
|
+
/**
|
|
11702
|
+
* Retrieves the Timeline File for the designated Workflow Run.
|
|
11703
|
+
* @summary Retrieve Timeline File for Workflow Run
|
|
11704
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
11705
|
+
* @param {string} timelineFileId The unique identifier for the Timefile File.
|
|
11706
|
+
* @param {*} [options] Override http request option.
|
|
11707
|
+
* @throws {RequiredError}
|
|
11708
|
+
* @memberof DefaultApi
|
|
11709
|
+
*/
|
|
11710
|
+
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11365
11711
|
/**
|
|
11366
11712
|
* Retrieves a single monitor
|
|
11367
11713
|
* @summary Retrieve monitor
|
|
@@ -11397,7 +11743,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11397
11743
|
* @throws {RequiredError}
|
|
11398
11744
|
* @memberof DefaultApi
|
|
11399
11745
|
*/
|
|
11400
|
-
|
|
11746
|
+
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11401
11747
|
/**
|
|
11402
11748
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
11403
11749
|
* @summary Generate a SDK token
|
|
@@ -11444,7 +11790,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11444
11790
|
* @throws {RequiredError}
|
|
11445
11791
|
* @memberof DefaultApi
|
|
11446
11792
|
*/
|
|
11447
|
-
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11793
|
+
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhotosList, any>>;
|
|
11448
11794
|
/**
|
|
11449
11795
|
* Lists the live photos that belong to an applicant.
|
|
11450
11796
|
* @summary List live photos
|
|
@@ -11462,7 +11808,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11462
11808
|
* @throws {RequiredError}
|
|
11463
11809
|
* @memberof DefaultApi
|
|
11464
11810
|
*/
|
|
11465
|
-
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11811
|
+
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideosList, any>>;
|
|
11466
11812
|
/**
|
|
11467
11813
|
* Lists all the motion captures that belong to an applicant.
|
|
11468
11814
|
* @summary List motion captures
|
|
@@ -11498,7 +11844,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11498
11844
|
* @throws {RequiredError}
|
|
11499
11845
|
* @memberof DefaultApi
|
|
11500
11846
|
*/
|
|
11501
|
-
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11847
|
+
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskItem[], any>>;
|
|
11502
11848
|
/**
|
|
11503
11849
|
* List match IDs on this monitor, as well as their enabled/disabled status
|
|
11504
11850
|
* @summary List matches (BETA)
|
|
@@ -11507,7 +11853,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11507
11853
|
* @throws {RequiredError}
|
|
11508
11854
|
* @memberof DefaultApi
|
|
11509
11855
|
*/
|
|
11510
|
-
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11856
|
+
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any>>;
|
|
11511
11857
|
/**
|
|
11512
11858
|
* List all available monitors for an applicant
|
|
11513
11859
|
* @summary List monitors
|
|
@@ -11517,7 +11863,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11517
11863
|
* @throws {RequiredError}
|
|
11518
11864
|
* @memberof DefaultApi
|
|
11519
11865
|
*/
|
|
11520
|
-
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11866
|
+
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorsList, any>>;
|
|
11521
11867
|
/**
|
|
11522
11868
|
* Lists all webhooks you\'ve created.
|
|
11523
11869
|
* @summary List webhooks
|
|
@@ -11606,12 +11952,12 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11606
11952
|
* Update the status of the given matches
|
|
11607
11953
|
* @summary Set match status (BETA)
|
|
11608
11954
|
* @param {string} monitorId
|
|
11609
|
-
* @param {
|
|
11955
|
+
* @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
|
|
11610
11956
|
* @param {*} [options] Override http request option.
|
|
11611
11957
|
* @throws {RequiredError}
|
|
11612
11958
|
* @memberof DefaultApi
|
|
11613
11959
|
*/
|
|
11614
|
-
|
|
11960
|
+
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any>>;
|
|
11615
11961
|
/**
|
|
11616
11962
|
* Edits a webhook. Returns the updated webhook object.
|
|
11617
11963
|
* @summary Edit a webhook
|
|
@@ -11627,7 +11973,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11627
11973
|
* @summary Upload a document
|
|
11628
11974
|
* @param {string} type The type of document
|
|
11629
11975
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
11630
|
-
* @param {
|
|
11976
|
+
* @param {FileTransfer} file The file to be uploaded.
|
|
11631
11977
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
11632
11978
|
* @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
|
|
11633
11979
|
* @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
|
|
@@ -11637,28 +11983,28 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11637
11983
|
* @throws {RequiredError}
|
|
11638
11984
|
* @memberof DefaultApi
|
|
11639
11985
|
*/
|
|
11640
|
-
uploadDocument(type: string, applicantId: string, file:
|
|
11986
|
+
uploadDocument(type: string, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any>>;
|
|
11641
11987
|
/**
|
|
11642
11988
|
* You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
|
|
11643
11989
|
* @summary Upload ID photo
|
|
11644
11990
|
* @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
|
|
11645
|
-
* @param {
|
|
11991
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
11646
11992
|
* @param {*} [options] Override http request option.
|
|
11647
11993
|
* @throws {RequiredError}
|
|
11648
11994
|
* @memberof DefaultApi
|
|
11649
11995
|
*/
|
|
11650
|
-
uploadIdPhoto(applicantId?: string, file?:
|
|
11996
|
+
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any>>;
|
|
11651
11997
|
/**
|
|
11652
11998
|
* You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
|
|
11653
11999
|
* @summary Upload live photo
|
|
11654
12000
|
* @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
|
|
11655
|
-
* @param {
|
|
12001
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
11656
12002
|
* @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
|
|
11657
12003
|
* @param {*} [options] Override http request option.
|
|
11658
12004
|
* @throws {RequiredError}
|
|
11659
12005
|
* @memberof DefaultApi
|
|
11660
12006
|
*/
|
|
11661
|
-
uploadLivePhoto(applicantId?: string, file?:
|
|
12007
|
+
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any>>;
|
|
11662
12008
|
}
|
|
11663
12009
|
/**
|
|
11664
12010
|
* @export
|