@onfido/api 3.0.0 → 3.2.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 +38 -12
- package/dist/api.d.ts +733 -141
- package/dist/api.js +289 -69
- package/dist/common.js +1 -40
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +733 -141
- package/dist/esm/api.js +287 -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/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
|
|
@@ -2798,6 +2805,12 @@ export interface DocumentProperties {
|
|
|
2798
2805
|
* @memberof DocumentProperties
|
|
2799
2806
|
*/
|
|
2800
2807
|
'date_of_expiry'?: string;
|
|
2808
|
+
/**
|
|
2809
|
+
*
|
|
2810
|
+
* @type {string}
|
|
2811
|
+
* @memberof DocumentProperties
|
|
2812
|
+
*/
|
|
2813
|
+
'personal_number'?: string;
|
|
2801
2814
|
/**
|
|
2802
2815
|
*
|
|
2803
2816
|
* @type {Array<DocumentPropertiesDocumentNumbersInner>}
|
|
@@ -2912,12 +2925,102 @@ export interface DocumentProperties {
|
|
|
2912
2925
|
* @memberof DocumentProperties
|
|
2913
2926
|
*/
|
|
2914
2927
|
'issuing_authority'?: string;
|
|
2928
|
+
/**
|
|
2929
|
+
*
|
|
2930
|
+
* @type {string}
|
|
2931
|
+
* @memberof DocumentProperties
|
|
2932
|
+
*/
|
|
2933
|
+
'remarks'?: string;
|
|
2934
|
+
/**
|
|
2935
|
+
*
|
|
2936
|
+
* @type {string}
|
|
2937
|
+
* @memberof DocumentProperties
|
|
2938
|
+
*/
|
|
2939
|
+
'civil_state'?: string;
|
|
2940
|
+
/**
|
|
2941
|
+
*
|
|
2942
|
+
* @type {string}
|
|
2943
|
+
* @memberof DocumentProperties
|
|
2944
|
+
*/
|
|
2945
|
+
'expatriation'?: string;
|
|
2946
|
+
/**
|
|
2947
|
+
*
|
|
2948
|
+
* @type {string}
|
|
2949
|
+
* @memberof DocumentProperties
|
|
2950
|
+
*/
|
|
2951
|
+
'father_name'?: string;
|
|
2952
|
+
/**
|
|
2953
|
+
*
|
|
2954
|
+
* @type {string}
|
|
2955
|
+
* @memberof DocumentProperties
|
|
2956
|
+
*/
|
|
2957
|
+
'mother_name'?: string;
|
|
2958
|
+
/**
|
|
2959
|
+
*
|
|
2960
|
+
* @type {string}
|
|
2961
|
+
* @memberof DocumentProperties
|
|
2962
|
+
*/
|
|
2963
|
+
'religion'?: string;
|
|
2964
|
+
/**
|
|
2965
|
+
*
|
|
2966
|
+
* @type {string}
|
|
2967
|
+
* @memberof DocumentProperties
|
|
2968
|
+
*/
|
|
2969
|
+
'type_of_permit'?: string;
|
|
2970
|
+
/**
|
|
2971
|
+
*
|
|
2972
|
+
* @type {string}
|
|
2973
|
+
* @memberof DocumentProperties
|
|
2974
|
+
*/
|
|
2975
|
+
'version_number'?: string;
|
|
2976
|
+
/**
|
|
2977
|
+
*
|
|
2978
|
+
* @type {string}
|
|
2979
|
+
* @memberof DocumentProperties
|
|
2980
|
+
*/
|
|
2981
|
+
'document_subtype'?: string;
|
|
2982
|
+
/**
|
|
2983
|
+
*
|
|
2984
|
+
* @type {string}
|
|
2985
|
+
* @memberof DocumentProperties
|
|
2986
|
+
*/
|
|
2987
|
+
'profession'?: string;
|
|
2988
|
+
/**
|
|
2989
|
+
*
|
|
2990
|
+
* @type {string}
|
|
2991
|
+
* @memberof DocumentProperties
|
|
2992
|
+
*/
|
|
2993
|
+
'security_document_number'?: string;
|
|
2994
|
+
/**
|
|
2995
|
+
*
|
|
2996
|
+
* @type {string}
|
|
2997
|
+
* @memberof DocumentProperties
|
|
2998
|
+
*/
|
|
2999
|
+
'tax_number'?: string;
|
|
3000
|
+
/**
|
|
3001
|
+
*
|
|
3002
|
+
* @type {string}
|
|
3003
|
+
* @memberof DocumentProperties
|
|
3004
|
+
*/
|
|
3005
|
+
'nist_identity_evidence_strength'?: DocumentPropertiesNistIdentityEvidenceStrengthEnum;
|
|
3006
|
+
/**
|
|
3007
|
+
*
|
|
3008
|
+
* @type {string}
|
|
3009
|
+
* @memberof DocumentProperties
|
|
3010
|
+
*/
|
|
3011
|
+
'has_issuance_confirmation'?: DocumentPropertiesHasIssuanceConfirmationEnum;
|
|
2915
3012
|
/**
|
|
2916
3013
|
*
|
|
2917
3014
|
* @type {boolean}
|
|
2918
3015
|
* @memberof DocumentProperties
|
|
2919
3016
|
*/
|
|
2920
3017
|
'real_id_compliance'?: boolean;
|
|
3018
|
+
/**
|
|
3019
|
+
*
|
|
3020
|
+
* @type {string}
|
|
3021
|
+
* @memberof DocumentProperties
|
|
3022
|
+
*/
|
|
3023
|
+
'security_tier'?: DocumentPropertiesSecurityTierEnum;
|
|
2921
3024
|
/**
|
|
2922
3025
|
*
|
|
2923
3026
|
* @type {DocumentPropertiesAddressLines}
|
|
@@ -2955,6 +3058,33 @@ export interface DocumentProperties {
|
|
|
2955
3058
|
*/
|
|
2956
3059
|
'extracted_data'?: DocumentPropertiesExtractedData;
|
|
2957
3060
|
}
|
|
3061
|
+
export declare const DocumentPropertiesNistIdentityEvidenceStrengthEnum: {
|
|
3062
|
+
readonly Superior: "superior";
|
|
3063
|
+
readonly Strong: "strong";
|
|
3064
|
+
readonly Fair: "fair";
|
|
3065
|
+
readonly Weak: "weak";
|
|
3066
|
+
readonly Unacceptable: "unacceptable";
|
|
3067
|
+
readonly UnspecifiedIdentityEvidenceStrength: "unspecified_identity_evidence_strength";
|
|
3068
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
3069
|
+
};
|
|
3070
|
+
export type DocumentPropertiesNistIdentityEvidenceStrengthEnum = typeof DocumentPropertiesNistIdentityEvidenceStrengthEnum[keyof typeof DocumentPropertiesNistIdentityEvidenceStrengthEnum];
|
|
3071
|
+
export declare const DocumentPropertiesHasIssuanceConfirmationEnum: {
|
|
3072
|
+
readonly True: "true";
|
|
3073
|
+
readonly False: "false";
|
|
3074
|
+
readonly Unspecified: "unspecified";
|
|
3075
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
3076
|
+
};
|
|
3077
|
+
export type DocumentPropertiesHasIssuanceConfirmationEnum = typeof DocumentPropertiesHasIssuanceConfirmationEnum[keyof typeof DocumentPropertiesHasIssuanceConfirmationEnum];
|
|
3078
|
+
export declare const DocumentPropertiesSecurityTierEnum: {
|
|
3079
|
+
readonly Tier1: "tier_1";
|
|
3080
|
+
readonly Tier2: "tier_2";
|
|
3081
|
+
readonly Tier3: "tier_3";
|
|
3082
|
+
readonly Tier4: "tier_4";
|
|
3083
|
+
readonly Tier5: "tier_5";
|
|
3084
|
+
readonly UnspecifiedSecurityTier: "unspecified_security_tier";
|
|
3085
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
3086
|
+
};
|
|
3087
|
+
export type DocumentPropertiesSecurityTierEnum = typeof DocumentPropertiesSecurityTierEnum[keyof typeof DocumentPropertiesSecurityTierEnum];
|
|
2958
3088
|
/**
|
|
2959
3089
|
*
|
|
2960
3090
|
* @export
|
|
@@ -3916,6 +4046,12 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
3916
4046
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
3917
4047
|
*/
|
|
3918
4048
|
'date_of_expiry'?: string;
|
|
4049
|
+
/**
|
|
4050
|
+
*
|
|
4051
|
+
* @type {string}
|
|
4052
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4053
|
+
*/
|
|
4054
|
+
'personal_number'?: string;
|
|
3919
4055
|
/**
|
|
3920
4056
|
*
|
|
3921
4057
|
* @type {Array<DocumentPropertiesDocumentNumbersInner>}
|
|
@@ -4030,12 +4166,102 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
4030
4166
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4031
4167
|
*/
|
|
4032
4168
|
'issuing_authority'?: string;
|
|
4169
|
+
/**
|
|
4170
|
+
*
|
|
4171
|
+
* @type {string}
|
|
4172
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4173
|
+
*/
|
|
4174
|
+
'remarks'?: string;
|
|
4175
|
+
/**
|
|
4176
|
+
*
|
|
4177
|
+
* @type {string}
|
|
4178
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4179
|
+
*/
|
|
4180
|
+
'civil_state'?: string;
|
|
4181
|
+
/**
|
|
4182
|
+
*
|
|
4183
|
+
* @type {string}
|
|
4184
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4185
|
+
*/
|
|
4186
|
+
'expatriation'?: string;
|
|
4187
|
+
/**
|
|
4188
|
+
*
|
|
4189
|
+
* @type {string}
|
|
4190
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4191
|
+
*/
|
|
4192
|
+
'father_name'?: string;
|
|
4193
|
+
/**
|
|
4194
|
+
*
|
|
4195
|
+
* @type {string}
|
|
4196
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4197
|
+
*/
|
|
4198
|
+
'mother_name'?: string;
|
|
4199
|
+
/**
|
|
4200
|
+
*
|
|
4201
|
+
* @type {string}
|
|
4202
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4203
|
+
*/
|
|
4204
|
+
'religion'?: string;
|
|
4205
|
+
/**
|
|
4206
|
+
*
|
|
4207
|
+
* @type {string}
|
|
4208
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4209
|
+
*/
|
|
4210
|
+
'type_of_permit'?: string;
|
|
4211
|
+
/**
|
|
4212
|
+
*
|
|
4213
|
+
* @type {string}
|
|
4214
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4215
|
+
*/
|
|
4216
|
+
'version_number'?: string;
|
|
4217
|
+
/**
|
|
4218
|
+
*
|
|
4219
|
+
* @type {string}
|
|
4220
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4221
|
+
*/
|
|
4222
|
+
'document_subtype'?: string;
|
|
4223
|
+
/**
|
|
4224
|
+
*
|
|
4225
|
+
* @type {string}
|
|
4226
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4227
|
+
*/
|
|
4228
|
+
'profession'?: string;
|
|
4229
|
+
/**
|
|
4230
|
+
*
|
|
4231
|
+
* @type {string}
|
|
4232
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4233
|
+
*/
|
|
4234
|
+
'security_document_number'?: string;
|
|
4235
|
+
/**
|
|
4236
|
+
*
|
|
4237
|
+
* @type {string}
|
|
4238
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4239
|
+
*/
|
|
4240
|
+
'tax_number'?: string;
|
|
4241
|
+
/**
|
|
4242
|
+
*
|
|
4243
|
+
* @type {string}
|
|
4244
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4245
|
+
*/
|
|
4246
|
+
'nist_identity_evidence_strength'?: DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum;
|
|
4247
|
+
/**
|
|
4248
|
+
*
|
|
4249
|
+
* @type {string}
|
|
4250
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4251
|
+
*/
|
|
4252
|
+
'has_issuance_confirmation'?: DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum;
|
|
4033
4253
|
/**
|
|
4034
4254
|
*
|
|
4035
4255
|
* @type {boolean}
|
|
4036
4256
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4037
4257
|
*/
|
|
4038
4258
|
'real_id_compliance'?: boolean;
|
|
4259
|
+
/**
|
|
4260
|
+
*
|
|
4261
|
+
* @type {string}
|
|
4262
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4263
|
+
*/
|
|
4264
|
+
'security_tier'?: DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum;
|
|
4039
4265
|
/**
|
|
4040
4266
|
*
|
|
4041
4267
|
* @type {DocumentPropertiesAddressLines}
|
|
@@ -4109,6 +4335,33 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
4109
4335
|
*/
|
|
4110
4336
|
'passenger_vehicle'?: DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle;
|
|
4111
4337
|
}
|
|
4338
|
+
export declare const DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum: {
|
|
4339
|
+
readonly Superior: "superior";
|
|
4340
|
+
readonly Strong: "strong";
|
|
4341
|
+
readonly Fair: "fair";
|
|
4342
|
+
readonly Weak: "weak";
|
|
4343
|
+
readonly Unacceptable: "unacceptable";
|
|
4344
|
+
readonly UnspecifiedIdentityEvidenceStrength: "unspecified_identity_evidence_strength";
|
|
4345
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
4346
|
+
};
|
|
4347
|
+
export type DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum];
|
|
4348
|
+
export declare const DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum: {
|
|
4349
|
+
readonly True: "true";
|
|
4350
|
+
readonly False: "false";
|
|
4351
|
+
readonly Unspecified: "unspecified";
|
|
4352
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
4353
|
+
};
|
|
4354
|
+
export type DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum];
|
|
4355
|
+
export declare const DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum: {
|
|
4356
|
+
readonly Tier1: "tier_1";
|
|
4357
|
+
readonly Tier2: "tier_2";
|
|
4358
|
+
readonly Tier3: "tier_3";
|
|
4359
|
+
readonly Tier4: "tier_4";
|
|
4360
|
+
readonly Tier5: "tier_5";
|
|
4361
|
+
readonly UnspecifiedSecurityTier: "unspecified_security_tier";
|
|
4362
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
4363
|
+
};
|
|
4364
|
+
export type DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum];
|
|
4112
4365
|
/**
|
|
4113
4366
|
* Normalised data for passenger cars
|
|
4114
4367
|
* @export
|
|
@@ -4750,6 +5003,19 @@ export interface FacialSimilarityMotionBreakdownVisualAuthenticityBreakdownSpoof
|
|
|
4750
5003
|
*/
|
|
4751
5004
|
'properties'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties;
|
|
4752
5005
|
}
|
|
5006
|
+
/**
|
|
5007
|
+
*
|
|
5008
|
+
* @export
|
|
5009
|
+
* @interface FacialSimilarityMotionProperties
|
|
5010
|
+
*/
|
|
5011
|
+
export interface FacialSimilarityMotionProperties {
|
|
5012
|
+
/**
|
|
5013
|
+
* 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.
|
|
5014
|
+
* @type {number}
|
|
5015
|
+
* @memberof FacialSimilarityMotionProperties
|
|
5016
|
+
*/
|
|
5017
|
+
'score'?: number;
|
|
5018
|
+
}
|
|
4753
5019
|
/**
|
|
4754
5020
|
*
|
|
4755
5021
|
* @export
|
|
@@ -4816,6 +5082,12 @@ export interface FacialSimilarityMotionReport {
|
|
|
4816
5082
|
* @memberof FacialSimilarityMotionReport
|
|
4817
5083
|
*/
|
|
4818
5084
|
'breakdown'?: FacialSimilarityMotionBreakdown;
|
|
5085
|
+
/**
|
|
5086
|
+
*
|
|
5087
|
+
* @type {FacialSimilarityMotionProperties}
|
|
5088
|
+
* @memberof FacialSimilarityMotionReport
|
|
5089
|
+
*/
|
|
5090
|
+
'properties'?: FacialSimilarityMotionProperties;
|
|
4819
5091
|
}
|
|
4820
5092
|
/**
|
|
4821
5093
|
*
|
|
@@ -5134,6 +5406,19 @@ export interface FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdownS
|
|
|
5134
5406
|
*/
|
|
5135
5407
|
'properties'?: PhotoAutoReasons;
|
|
5136
5408
|
}
|
|
5409
|
+
/**
|
|
5410
|
+
*
|
|
5411
|
+
* @export
|
|
5412
|
+
* @interface FacialSimilarityPhotoFullyAutoProperties
|
|
5413
|
+
*/
|
|
5414
|
+
export interface FacialSimilarityPhotoFullyAutoProperties {
|
|
5415
|
+
/**
|
|
5416
|
+
* 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.
|
|
5417
|
+
* @type {number}
|
|
5418
|
+
* @memberof FacialSimilarityPhotoFullyAutoProperties
|
|
5419
|
+
*/
|
|
5420
|
+
'score'?: number;
|
|
5421
|
+
}
|
|
5137
5422
|
/**
|
|
5138
5423
|
*
|
|
5139
5424
|
* @export
|
|
@@ -5200,6 +5485,25 @@ export interface FacialSimilarityPhotoFullyAutoReport {
|
|
|
5200
5485
|
* @memberof FacialSimilarityPhotoFullyAutoReport
|
|
5201
5486
|
*/
|
|
5202
5487
|
'breakdown'?: FacialSimilarityPhotoFullyAutoBreakdown;
|
|
5488
|
+
/**
|
|
5489
|
+
*
|
|
5490
|
+
* @type {FacialSimilarityPhotoFullyAutoProperties}
|
|
5491
|
+
* @memberof FacialSimilarityPhotoFullyAutoReport
|
|
5492
|
+
*/
|
|
5493
|
+
'properties'?: FacialSimilarityPhotoFullyAutoProperties;
|
|
5494
|
+
}
|
|
5495
|
+
/**
|
|
5496
|
+
*
|
|
5497
|
+
* @export
|
|
5498
|
+
* @interface FacialSimilarityPhotoProperties
|
|
5499
|
+
*/
|
|
5500
|
+
export interface FacialSimilarityPhotoProperties {
|
|
5501
|
+
/**
|
|
5502
|
+
* 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.
|
|
5503
|
+
* @type {number}
|
|
5504
|
+
* @memberof FacialSimilarityPhotoProperties
|
|
5505
|
+
*/
|
|
5506
|
+
'score'?: number;
|
|
5203
5507
|
}
|
|
5204
5508
|
/**
|
|
5205
5509
|
*
|
|
@@ -5267,6 +5571,12 @@ export interface FacialSimilarityPhotoReport {
|
|
|
5267
5571
|
* @memberof FacialSimilarityPhotoReport
|
|
5268
5572
|
*/
|
|
5269
5573
|
'breakdown'?: FacialSimilarityPhotoBreakdown;
|
|
5574
|
+
/**
|
|
5575
|
+
*
|
|
5576
|
+
* @type {FacialSimilarityPhotoProperties}
|
|
5577
|
+
* @memberof FacialSimilarityPhotoReport
|
|
5578
|
+
*/
|
|
5579
|
+
'properties'?: FacialSimilarityPhotoProperties;
|
|
5270
5580
|
}
|
|
5271
5581
|
/**
|
|
5272
5582
|
*
|
|
@@ -5464,6 +5774,19 @@ export interface FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownSpoofi
|
|
|
5464
5774
|
*/
|
|
5465
5775
|
'properties'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties;
|
|
5466
5776
|
}
|
|
5777
|
+
/**
|
|
5778
|
+
*
|
|
5779
|
+
* @export
|
|
5780
|
+
* @interface FacialSimilarityVideoProperties
|
|
5781
|
+
*/
|
|
5782
|
+
export interface FacialSimilarityVideoProperties {
|
|
5783
|
+
/**
|
|
5784
|
+
* 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.
|
|
5785
|
+
* @type {number}
|
|
5786
|
+
* @memberof FacialSimilarityVideoProperties
|
|
5787
|
+
*/
|
|
5788
|
+
'score'?: number;
|
|
5789
|
+
}
|
|
5467
5790
|
/**
|
|
5468
5791
|
*
|
|
5469
5792
|
* @export
|
|
@@ -5530,19 +5853,12 @@ export interface FacialSimilarityVideoReport {
|
|
|
5530
5853
|
* @memberof FacialSimilarityVideoReport
|
|
5531
5854
|
*/
|
|
5532
5855
|
'breakdown'?: FacialSimilarityVideoBreakdown;
|
|
5533
|
-
}
|
|
5534
|
-
/**
|
|
5535
|
-
*
|
|
5536
|
-
* @export
|
|
5537
|
-
* @interface IDPhotosList
|
|
5538
|
-
*/
|
|
5539
|
-
export interface IDPhotosList {
|
|
5540
5856
|
/**
|
|
5541
5857
|
*
|
|
5542
|
-
* @type {
|
|
5543
|
-
* @memberof
|
|
5858
|
+
* @type {FacialSimilarityVideoProperties}
|
|
5859
|
+
* @memberof FacialSimilarityVideoReport
|
|
5544
5860
|
*/
|
|
5545
|
-
'
|
|
5861
|
+
'properties'?: FacialSimilarityVideoProperties;
|
|
5546
5862
|
}
|
|
5547
5863
|
/**
|
|
5548
5864
|
*
|
|
@@ -5680,6 +5996,19 @@ export interface IdPhotoResponse {
|
|
|
5680
5996
|
*/
|
|
5681
5997
|
'file_size'?: number;
|
|
5682
5998
|
}
|
|
5999
|
+
/**
|
|
6000
|
+
*
|
|
6001
|
+
* @export
|
|
6002
|
+
* @interface IdPhotosList
|
|
6003
|
+
*/
|
|
6004
|
+
export interface IdPhotosList {
|
|
6005
|
+
/**
|
|
6006
|
+
*
|
|
6007
|
+
* @type {Array<IdPhoto>}
|
|
6008
|
+
* @memberof IdPhotosList
|
|
6009
|
+
*/
|
|
6010
|
+
'id_photos': Array<IdPhoto>;
|
|
6011
|
+
}
|
|
5683
6012
|
/**
|
|
5684
6013
|
*
|
|
5685
6014
|
* @export
|
|
@@ -6591,13 +6920,13 @@ export interface LiveVideo {
|
|
|
6591
6920
|
/**
|
|
6592
6921
|
*
|
|
6593
6922
|
* @export
|
|
6594
|
-
* @interface
|
|
6923
|
+
* @interface LiveVideosList
|
|
6595
6924
|
*/
|
|
6596
|
-
export interface
|
|
6925
|
+
export interface LiveVideosList {
|
|
6597
6926
|
/**
|
|
6598
6927
|
*
|
|
6599
6928
|
* @type {Array<LiveVideo>}
|
|
6600
|
-
* @memberof
|
|
6929
|
+
* @memberof LiveVideosList
|
|
6601
6930
|
*/
|
|
6602
6931
|
'live_videos': Array<LiveVideo>;
|
|
6603
6932
|
}
|
|
@@ -7527,12 +7856,36 @@ export interface Task {
|
|
|
7527
7856
|
* @memberof Task
|
|
7528
7857
|
*/
|
|
7529
7858
|
'id'?: string;
|
|
7859
|
+
/**
|
|
7860
|
+
* The workflow run id the task belongs to.
|
|
7861
|
+
* @type {string}
|
|
7862
|
+
* @memberof Task
|
|
7863
|
+
*/
|
|
7864
|
+
'workflow_run_id'?: string;
|
|
7530
7865
|
/**
|
|
7531
7866
|
* The identifier for the Task Definition.
|
|
7532
7867
|
* @type {string}
|
|
7533
7868
|
* @memberof Task
|
|
7534
7869
|
*/
|
|
7535
7870
|
'task_def_id'?: string;
|
|
7871
|
+
/**
|
|
7872
|
+
* The task definition version.
|
|
7873
|
+
* @type {string}
|
|
7874
|
+
* @memberof Task
|
|
7875
|
+
*/
|
|
7876
|
+
'task_def_version'?: string | null;
|
|
7877
|
+
/**
|
|
7878
|
+
* Input object with the fields used by the Task to execute.
|
|
7879
|
+
* @type {object}
|
|
7880
|
+
* @memberof Task
|
|
7881
|
+
*/
|
|
7882
|
+
'input'?: object;
|
|
7883
|
+
/**
|
|
7884
|
+
* Output object with the fields produced by the Task execution.
|
|
7885
|
+
* @type {object}
|
|
7886
|
+
* @memberof Task
|
|
7887
|
+
*/
|
|
7888
|
+
'output'?: object | null;
|
|
7536
7889
|
/**
|
|
7537
7890
|
* The date and time when the Task was created.
|
|
7538
7891
|
* @type {string}
|
|
@@ -7549,21 +7902,52 @@ export interface Task {
|
|
|
7549
7902
|
/**
|
|
7550
7903
|
*
|
|
7551
7904
|
* @export
|
|
7552
|
-
* @interface
|
|
7905
|
+
* @interface TaskItem
|
|
7553
7906
|
*/
|
|
7554
|
-
export interface
|
|
7907
|
+
export interface TaskItem {
|
|
7555
7908
|
/**
|
|
7556
|
-
*
|
|
7557
|
-
* @type {
|
|
7558
|
-
* @memberof
|
|
7909
|
+
* The identifier for the Task.
|
|
7910
|
+
* @type {string}
|
|
7911
|
+
* @memberof TaskItem
|
|
7559
7912
|
*/
|
|
7560
|
-
'
|
|
7913
|
+
'id'?: string;
|
|
7561
7914
|
/**
|
|
7562
|
-
*
|
|
7563
|
-
* @type {
|
|
7564
|
-
* @memberof
|
|
7915
|
+
* The identifier for the Task Definition.
|
|
7916
|
+
* @type {string}
|
|
7917
|
+
* @memberof TaskItem
|
|
7565
7918
|
*/
|
|
7566
|
-
'
|
|
7919
|
+
'task_def_id'?: string;
|
|
7920
|
+
/**
|
|
7921
|
+
* The date and time when the Task was created.
|
|
7922
|
+
* @type {string}
|
|
7923
|
+
* @memberof TaskItem
|
|
7924
|
+
*/
|
|
7925
|
+
'created_at'?: string;
|
|
7926
|
+
/**
|
|
7927
|
+
* The date and time when the Task was last updated.
|
|
7928
|
+
* @type {string}
|
|
7929
|
+
* @memberof TaskItem
|
|
7930
|
+
*/
|
|
7931
|
+
'updated_at'?: string;
|
|
7932
|
+
}
|
|
7933
|
+
/**
|
|
7934
|
+
*
|
|
7935
|
+
* @export
|
|
7936
|
+
* @interface TimelineFileReference
|
|
7937
|
+
*/
|
|
7938
|
+
export interface TimelineFileReference {
|
|
7939
|
+
/**
|
|
7940
|
+
* The unique identifier for the Timefile File that will be created.
|
|
7941
|
+
* @type {string}
|
|
7942
|
+
* @memberof TimelineFileReference
|
|
7943
|
+
*/
|
|
7944
|
+
'workflow_timeline_file_id': string;
|
|
7945
|
+
/**
|
|
7946
|
+
* Link to access the Timefile File that will be created.
|
|
7947
|
+
* @type {string}
|
|
7948
|
+
* @memberof TimelineFileReference
|
|
7949
|
+
*/
|
|
7950
|
+
'href': string;
|
|
7567
7951
|
}
|
|
7568
7952
|
/**
|
|
7569
7953
|
*
|
|
@@ -8484,12 +8868,30 @@ export interface WatchlistEnhancedReport {
|
|
|
8484
8868
|
* @interface WatchlistMonitor
|
|
8485
8869
|
*/
|
|
8486
8870
|
export interface WatchlistMonitor {
|
|
8871
|
+
/**
|
|
8872
|
+
* The ID for the applicant associated with the monitor.
|
|
8873
|
+
* @type {string}
|
|
8874
|
+
* @memberof WatchlistMonitor
|
|
8875
|
+
*/
|
|
8876
|
+
'applicant_id': string;
|
|
8877
|
+
/**
|
|
8878
|
+
* The name of the report type the monitor creates.
|
|
8879
|
+
* @type {string}
|
|
8880
|
+
* @memberof WatchlistMonitor
|
|
8881
|
+
*/
|
|
8882
|
+
'report_name': WatchlistMonitorReportNameEnum;
|
|
8883
|
+
/**
|
|
8884
|
+
* A list of tags associated with this monitor. These tags will be applied to each check this monitor creates.
|
|
8885
|
+
* @type {Array<string>}
|
|
8886
|
+
* @memberof WatchlistMonitor
|
|
8887
|
+
*/
|
|
8888
|
+
'tags'?: Array<string>;
|
|
8487
8889
|
/**
|
|
8488
8890
|
* The unique identifier for the monitor.
|
|
8489
8891
|
* @type {string}
|
|
8490
8892
|
* @memberof WatchlistMonitor
|
|
8491
8893
|
*/
|
|
8492
|
-
'id'
|
|
8894
|
+
'id': string;
|
|
8493
8895
|
/**
|
|
8494
8896
|
* The date and time at which the monitor was created.
|
|
8495
8897
|
* @type {string}
|
|
@@ -8502,37 +8904,50 @@ export interface WatchlistMonitor {
|
|
|
8502
8904
|
* @memberof WatchlistMonitor
|
|
8503
8905
|
*/
|
|
8504
8906
|
'deleted_at'?: string;
|
|
8907
|
+
/**
|
|
8908
|
+
* Indicates whether the object was created in the sandbox or not.
|
|
8909
|
+
* @type {boolean}
|
|
8910
|
+
* @memberof WatchlistMonitor
|
|
8911
|
+
*/
|
|
8912
|
+
'is_sandbox'?: boolean;
|
|
8913
|
+
}
|
|
8914
|
+
export declare const WatchlistMonitorReportNameEnum: {
|
|
8915
|
+
readonly Standard: "watchlist_standard";
|
|
8916
|
+
readonly Aml: "watchlist_aml";
|
|
8917
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
8918
|
+
};
|
|
8919
|
+
export type WatchlistMonitorReportNameEnum = typeof WatchlistMonitorReportNameEnum[keyof typeof WatchlistMonitorReportNameEnum];
|
|
8920
|
+
/**
|
|
8921
|
+
*
|
|
8922
|
+
* @export
|
|
8923
|
+
* @interface WatchlistMonitorBuilder
|
|
8924
|
+
*/
|
|
8925
|
+
export interface WatchlistMonitorBuilder {
|
|
8505
8926
|
/**
|
|
8506
8927
|
* The ID for the applicant associated with the monitor.
|
|
8507
8928
|
* @type {string}
|
|
8508
|
-
* @memberof
|
|
8929
|
+
* @memberof WatchlistMonitorBuilder
|
|
8509
8930
|
*/
|
|
8510
8931
|
'applicant_id': string;
|
|
8511
8932
|
/**
|
|
8512
|
-
* The name of the report type the monitor creates.
|
|
8933
|
+
* The name of the report type the monitor creates.
|
|
8513
8934
|
* @type {string}
|
|
8514
|
-
* @memberof
|
|
8935
|
+
* @memberof WatchlistMonitorBuilder
|
|
8515
8936
|
*/
|
|
8516
|
-
'report_name':
|
|
8937
|
+
'report_name': WatchlistMonitorBuilderReportNameEnum;
|
|
8517
8938
|
/**
|
|
8518
8939
|
* A list of tags associated with this monitor. These tags will be applied to each check this monitor creates.
|
|
8519
8940
|
* @type {Array<string>}
|
|
8520
|
-
* @memberof
|
|
8941
|
+
* @memberof WatchlistMonitorBuilder
|
|
8521
8942
|
*/
|
|
8522
8943
|
'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
8944
|
}
|
|
8530
|
-
export declare const
|
|
8945
|
+
export declare const WatchlistMonitorBuilderReportNameEnum: {
|
|
8531
8946
|
readonly Standard: "watchlist_standard";
|
|
8532
8947
|
readonly Aml: "watchlist_aml";
|
|
8533
8948
|
readonly UnknownDefaultOpenApi: "11184809";
|
|
8534
8949
|
};
|
|
8535
|
-
export type
|
|
8950
|
+
export type WatchlistMonitorBuilderReportNameEnum = typeof WatchlistMonitorBuilderReportNameEnum[keyof typeof WatchlistMonitorBuilderReportNameEnum];
|
|
8536
8951
|
/**
|
|
8537
8952
|
*
|
|
8538
8953
|
* @export
|
|
@@ -8550,7 +8965,114 @@ export interface WatchlistMonitorMatch {
|
|
|
8550
8965
|
* @type {boolean}
|
|
8551
8966
|
* @memberof WatchlistMonitorMatch
|
|
8552
8967
|
*/
|
|
8553
|
-
'
|
|
8968
|
+
'enabled'?: boolean;
|
|
8969
|
+
}
|
|
8970
|
+
/**
|
|
8971
|
+
*
|
|
8972
|
+
* @export
|
|
8973
|
+
* @interface WatchlistMonitorMatchesList
|
|
8974
|
+
*/
|
|
8975
|
+
export interface WatchlistMonitorMatchesList {
|
|
8976
|
+
/**
|
|
8977
|
+
*
|
|
8978
|
+
* @type {Array<WatchlistMonitorMatch>}
|
|
8979
|
+
* @memberof WatchlistMonitorMatchesList
|
|
8980
|
+
*/
|
|
8981
|
+
'matches': Array<WatchlistMonitorMatch>;
|
|
8982
|
+
}
|
|
8983
|
+
/**
|
|
8984
|
+
*
|
|
8985
|
+
* @export
|
|
8986
|
+
* @interface WatchlistMonitorMatchesUpdater
|
|
8987
|
+
*/
|
|
8988
|
+
export interface WatchlistMonitorMatchesUpdater {
|
|
8989
|
+
/**
|
|
8990
|
+
*
|
|
8991
|
+
* @type {Array<string>}
|
|
8992
|
+
* @memberof WatchlistMonitorMatchesUpdater
|
|
8993
|
+
*/
|
|
8994
|
+
'enable'?: Array<string>;
|
|
8995
|
+
/**
|
|
8996
|
+
*
|
|
8997
|
+
* @type {Array<string>}
|
|
8998
|
+
* @memberof WatchlistMonitorMatchesUpdater
|
|
8999
|
+
*/
|
|
9000
|
+
'disable'?: Array<string>;
|
|
9001
|
+
}
|
|
9002
|
+
/**
|
|
9003
|
+
*
|
|
9004
|
+
* @export
|
|
9005
|
+
* @interface WatchlistMonitorResponse
|
|
9006
|
+
*/
|
|
9007
|
+
export interface WatchlistMonitorResponse {
|
|
9008
|
+
/**
|
|
9009
|
+
* The unique identifier for the monitor.
|
|
9010
|
+
* @type {string}
|
|
9011
|
+
* @memberof WatchlistMonitorResponse
|
|
9012
|
+
*/
|
|
9013
|
+
'id': string;
|
|
9014
|
+
/**
|
|
9015
|
+
* The date and time at which the monitor was created.
|
|
9016
|
+
* @type {string}
|
|
9017
|
+
* @memberof WatchlistMonitorResponse
|
|
9018
|
+
*/
|
|
9019
|
+
'created_at'?: string;
|
|
9020
|
+
/**
|
|
9021
|
+
* The date and time at which the monitor was deleted. If the monitor is still active, this field will be null.
|
|
9022
|
+
* @type {string}
|
|
9023
|
+
* @memberof WatchlistMonitorResponse
|
|
9024
|
+
*/
|
|
9025
|
+
'deleted_at'?: string;
|
|
9026
|
+
/**
|
|
9027
|
+
* Indicates whether the object was created in the sandbox or not.
|
|
9028
|
+
* @type {boolean}
|
|
9029
|
+
* @memberof WatchlistMonitorResponse
|
|
9030
|
+
*/
|
|
9031
|
+
'is_sandbox'?: boolean;
|
|
9032
|
+
}
|
|
9033
|
+
/**
|
|
9034
|
+
*
|
|
9035
|
+
* @export
|
|
9036
|
+
* @interface WatchlistMonitorShared
|
|
9037
|
+
*/
|
|
9038
|
+
export interface WatchlistMonitorShared {
|
|
9039
|
+
/**
|
|
9040
|
+
* The ID for the applicant associated with the monitor.
|
|
9041
|
+
* @type {string}
|
|
9042
|
+
* @memberof WatchlistMonitorShared
|
|
9043
|
+
*/
|
|
9044
|
+
'applicant_id': string;
|
|
9045
|
+
/**
|
|
9046
|
+
* The name of the report type the monitor creates.
|
|
9047
|
+
* @type {string}
|
|
9048
|
+
* @memberof WatchlistMonitorShared
|
|
9049
|
+
*/
|
|
9050
|
+
'report_name': WatchlistMonitorSharedReportNameEnum;
|
|
9051
|
+
/**
|
|
9052
|
+
* A list of tags associated with this monitor. These tags will be applied to each check this monitor creates.
|
|
9053
|
+
* @type {Array<string>}
|
|
9054
|
+
* @memberof WatchlistMonitorShared
|
|
9055
|
+
*/
|
|
9056
|
+
'tags'?: Array<string>;
|
|
9057
|
+
}
|
|
9058
|
+
export declare const WatchlistMonitorSharedReportNameEnum: {
|
|
9059
|
+
readonly Standard: "watchlist_standard";
|
|
9060
|
+
readonly Aml: "watchlist_aml";
|
|
9061
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
9062
|
+
};
|
|
9063
|
+
export type WatchlistMonitorSharedReportNameEnum = typeof WatchlistMonitorSharedReportNameEnum[keyof typeof WatchlistMonitorSharedReportNameEnum];
|
|
9064
|
+
/**
|
|
9065
|
+
*
|
|
9066
|
+
* @export
|
|
9067
|
+
* @interface WatchlistMonitorsList
|
|
9068
|
+
*/
|
|
9069
|
+
export interface WatchlistMonitorsList {
|
|
9070
|
+
/**
|
|
9071
|
+
*
|
|
9072
|
+
* @type {Array<WatchlistMonitor>}
|
|
9073
|
+
* @memberof WatchlistMonitorsList
|
|
9074
|
+
*/
|
|
9075
|
+
'monitors': Array<WatchlistMonitor>;
|
|
8554
9076
|
}
|
|
8555
9077
|
/**
|
|
8556
9078
|
*
|
|
@@ -9522,11 +10044,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9522
10044
|
* @summary Complete Task
|
|
9523
10045
|
* @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
|
|
9524
10046
|
* @param {string} taskId The identifier of the Task you want to complete.
|
|
9525
|
-
* @param {
|
|
10047
|
+
* @param {CompleteTaskBuilder} completeTaskBuilder
|
|
9526
10048
|
* @param {*} [options] Override http request option.
|
|
9527
10049
|
* @throws {RequiredError}
|
|
9528
10050
|
*/
|
|
9529
|
-
completeTask: (workflowRunId: string, taskId: string,
|
|
10051
|
+
completeTask: (workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9530
10052
|
/**
|
|
9531
10053
|
* Creates a single applicant. Returns an applicant object.
|
|
9532
10054
|
* @summary Create Applicant
|
|
@@ -9543,14 +10065,22 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9543
10065
|
* @throws {RequiredError}
|
|
9544
10066
|
*/
|
|
9545
10067
|
createCheck: (checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10068
|
+
/**
|
|
10069
|
+
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
10070
|
+
* @summary Create Timeline File for Workflow Run
|
|
10071
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
10072
|
+
* @param {*} [options] Override http request option.
|
|
10073
|
+
* @throws {RequiredError}
|
|
10074
|
+
*/
|
|
10075
|
+
createTimelineFile: (workflowRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9546
10076
|
/**
|
|
9547
10077
|
* Creates a new monitor for the applicant
|
|
9548
10078
|
* @summary Create monitor
|
|
9549
|
-
* @param {
|
|
10079
|
+
* @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
|
|
9550
10080
|
* @param {*} [options] Override http request option.
|
|
9551
10081
|
* @throws {RequiredError}
|
|
9552
10082
|
*/
|
|
9553
|
-
createWatchlistMonitor: (
|
|
10083
|
+
createWatchlistMonitor: (watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9554
10084
|
/**
|
|
9555
10085
|
* Registers a webhook. Returns a webhook object.
|
|
9556
10086
|
* @summary Register webhook
|
|
@@ -9760,6 +10290,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9760
10290
|
* @throws {RequiredError}
|
|
9761
10291
|
*/
|
|
9762
10292
|
findTask: (workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10293
|
+
/**
|
|
10294
|
+
* Retrieves the Timeline File for the designated Workflow Run.
|
|
10295
|
+
* @summary Retrieve Timeline File for Workflow Run
|
|
10296
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
10297
|
+
* @param {string} timelineFileId The unique identifier for the Timefile File.
|
|
10298
|
+
* @param {*} [options] Override http request option.
|
|
10299
|
+
* @throws {RequiredError}
|
|
10300
|
+
*/
|
|
10301
|
+
findTimelineFile: (workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9763
10302
|
/**
|
|
9764
10303
|
* Retrieves a single monitor
|
|
9765
10304
|
* @summary Retrieve monitor
|
|
@@ -9791,7 +10330,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9791
10330
|
* @param {*} [options] Override http request option.
|
|
9792
10331
|
* @throws {RequiredError}
|
|
9793
10332
|
*/
|
|
9794
|
-
|
|
10333
|
+
forceReportCreationFromWatchlistMonitor: (monitorId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9795
10334
|
/**
|
|
9796
10335
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
9797
10336
|
* @summary Generate a SDK token
|
|
@@ -9978,11 +10517,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9978
10517
|
* Update the status of the given matches
|
|
9979
10518
|
* @summary Set match status (BETA)
|
|
9980
10519
|
* @param {string} monitorId
|
|
9981
|
-
* @param {
|
|
10520
|
+
* @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
|
|
9982
10521
|
* @param {*} [options] Override http request option.
|
|
9983
10522
|
* @throws {RequiredError}
|
|
9984
10523
|
*/
|
|
9985
|
-
|
|
10524
|
+
updateWatchlistMonitorMatch: (monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9986
10525
|
/**
|
|
9987
10526
|
* Edits a webhook. Returns the updated webhook object.
|
|
9988
10527
|
* @summary Edit a webhook
|
|
@@ -9997,7 +10536,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9997
10536
|
* @summary Upload a document
|
|
9998
10537
|
* @param {string} type The type of document
|
|
9999
10538
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
10000
|
-
* @param {
|
|
10539
|
+
* @param {FileTransfer} file The file to be uploaded.
|
|
10001
10540
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
10002
10541
|
* @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
|
|
10003
10542
|
* @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
|
|
@@ -10006,26 +10545,26 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
10006
10545
|
* @param {*} [options] Override http request option.
|
|
10007
10546
|
* @throws {RequiredError}
|
|
10008
10547
|
*/
|
|
10009
|
-
uploadDocument: (type: string, applicantId: string, file:
|
|
10548
|
+
uploadDocument: (type: string, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10010
10549
|
/**
|
|
10011
10550
|
* 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
10551
|
* @summary Upload ID photo
|
|
10013
10552
|
* @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
|
|
10014
|
-
* @param {
|
|
10553
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
10015
10554
|
* @param {*} [options] Override http request option.
|
|
10016
10555
|
* @throws {RequiredError}
|
|
10017
10556
|
*/
|
|
10018
|
-
uploadIdPhoto: (applicantId?: string, file?:
|
|
10557
|
+
uploadIdPhoto: (applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10019
10558
|
/**
|
|
10020
10559
|
* 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
10560
|
* @summary Upload live photo
|
|
10022
10561
|
* @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
|
|
10023
|
-
* @param {
|
|
10562
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
10024
10563
|
* @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
|
|
10025
10564
|
* @param {*} [options] Override http request option.
|
|
10026
10565
|
* @throws {RequiredError}
|
|
10027
10566
|
*/
|
|
10028
|
-
uploadLivePhoto: (applicantId?: string, file?:
|
|
10567
|
+
uploadLivePhoto: (applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10029
10568
|
};
|
|
10030
10569
|
/**
|
|
10031
10570
|
* DefaultApi - functional programming interface
|
|
@@ -10045,11 +10584,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10045
10584
|
* @summary Complete Task
|
|
10046
10585
|
* @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
|
|
10047
10586
|
* @param {string} taskId The identifier of the Task you want to complete.
|
|
10048
|
-
* @param {
|
|
10587
|
+
* @param {CompleteTaskBuilder} completeTaskBuilder
|
|
10049
10588
|
* @param {*} [options] Override http request option.
|
|
10050
10589
|
* @throws {RequiredError}
|
|
10051
10590
|
*/
|
|
10052
|
-
completeTask(workflowRunId: string, taskId: string,
|
|
10591
|
+
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10053
10592
|
/**
|
|
10054
10593
|
* Creates a single applicant. Returns an applicant object.
|
|
10055
10594
|
* @summary Create Applicant
|
|
@@ -10066,14 +10605,22 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10066
10605
|
* @throws {RequiredError}
|
|
10067
10606
|
*/
|
|
10068
10607
|
createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Check>>;
|
|
10608
|
+
/**
|
|
10609
|
+
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
10610
|
+
* @summary Create Timeline File for Workflow Run
|
|
10611
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
10612
|
+
* @param {*} [options] Override http request option.
|
|
10613
|
+
* @throws {RequiredError}
|
|
10614
|
+
*/
|
|
10615
|
+
createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimelineFileReference>>;
|
|
10069
10616
|
/**
|
|
10070
10617
|
* Creates a new monitor for the applicant
|
|
10071
10618
|
* @summary Create monitor
|
|
10072
|
-
* @param {
|
|
10619
|
+
* @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
|
|
10073
10620
|
* @param {*} [options] Override http request option.
|
|
10074
10621
|
* @throws {RequiredError}
|
|
10075
10622
|
*/
|
|
10076
|
-
createWatchlistMonitor(
|
|
10623
|
+
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitor>>;
|
|
10077
10624
|
/**
|
|
10078
10625
|
* Registers a webhook. Returns a webhook object.
|
|
10079
10626
|
* @summary Register webhook
|
|
@@ -10121,7 +10668,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10121
10668
|
* @param {*} [options] Override http request option.
|
|
10122
10669
|
* @throws {RequiredError}
|
|
10123
10670
|
*/
|
|
10124
|
-
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10671
|
+
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10125
10672
|
/**
|
|
10126
10673
|
* Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
10127
10674
|
* @summary Download document
|
|
@@ -10129,7 +10676,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10129
10676
|
* @param {*} [options] Override http request option.
|
|
10130
10677
|
* @throws {RequiredError}
|
|
10131
10678
|
*/
|
|
10132
|
-
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10679
|
+
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10133
10680
|
/**
|
|
10134
10681
|
* Downloads a document video. If successful, the response will be the binary data representing the video.
|
|
10135
10682
|
* @summary Download document video
|
|
@@ -10137,7 +10684,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10137
10684
|
* @param {*} [options] Override http request option.
|
|
10138
10685
|
* @throws {RequiredError}
|
|
10139
10686
|
*/
|
|
10140
|
-
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10687
|
+
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10141
10688
|
/**
|
|
10142
10689
|
* ID photos are downloaded using this endpoint.
|
|
10143
10690
|
* @summary Download ID photo
|
|
@@ -10145,7 +10692,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10145
10692
|
* @param {*} [options] Override http request option.
|
|
10146
10693
|
* @throws {RequiredError}
|
|
10147
10694
|
*/
|
|
10148
|
-
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10695
|
+
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10149
10696
|
/**
|
|
10150
10697
|
* Live photos are downloaded using this endpoint.
|
|
10151
10698
|
* @summary Download live photo
|
|
@@ -10153,7 +10700,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10153
10700
|
* @param {*} [options] Override http request option.
|
|
10154
10701
|
* @throws {RequiredError}
|
|
10155
10702
|
*/
|
|
10156
|
-
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10703
|
+
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10157
10704
|
/**
|
|
10158
10705
|
* Live videos are downloaded using this endpoint.
|
|
10159
10706
|
* @summary Download live video
|
|
@@ -10161,7 +10708,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10161
10708
|
* @param {*} [options] Override http request option.
|
|
10162
10709
|
* @throws {RequiredError}
|
|
10163
10710
|
*/
|
|
10164
|
-
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10711
|
+
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10165
10712
|
/**
|
|
10166
10713
|
* Returns the binary data representing a single frame from a live video.
|
|
10167
10714
|
* @summary Download live video frame
|
|
@@ -10169,7 +10716,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10169
10716
|
* @param {*} [options] Override http request option.
|
|
10170
10717
|
* @throws {RequiredError}
|
|
10171
10718
|
*/
|
|
10172
|
-
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10719
|
+
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10173
10720
|
/**
|
|
10174
10721
|
* Motion captures are downloaded using this endpoint.
|
|
10175
10722
|
* @summary Download motion capture
|
|
@@ -10177,7 +10724,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10177
10724
|
* @param {*} [options] Override http request option.
|
|
10178
10725
|
* @throws {RequiredError}
|
|
10179
10726
|
*/
|
|
10180
|
-
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10727
|
+
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10181
10728
|
/**
|
|
10182
10729
|
* Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
|
10183
10730
|
* @summary Download motion capture frame
|
|
@@ -10185,7 +10732,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10185
10732
|
* @param {*} [options] Override http request option.
|
|
10186
10733
|
* @throws {RequiredError}
|
|
10187
10734
|
*/
|
|
10188
|
-
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10735
|
+
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10189
10736
|
/**
|
|
10190
10737
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
10191
10738
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -10193,7 +10740,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10193
10740
|
* @param {*} [options] Override http request option.
|
|
10194
10741
|
* @throws {RequiredError}
|
|
10195
10742
|
*/
|
|
10196
|
-
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10743
|
+
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10197
10744
|
/**
|
|
10198
10745
|
* Extract information from a document
|
|
10199
10746
|
* @summary Autofill
|
|
@@ -10283,6 +10830,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10283
10830
|
* @throws {RequiredError}
|
|
10284
10831
|
*/
|
|
10285
10832
|
findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Task>>;
|
|
10833
|
+
/**
|
|
10834
|
+
* Retrieves the Timeline File for the designated Workflow Run.
|
|
10835
|
+
* @summary Retrieve Timeline File for Workflow Run
|
|
10836
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
10837
|
+
* @param {string} timelineFileId The unique identifier for the Timefile File.
|
|
10838
|
+
* @param {*} [options] Override http request option.
|
|
10839
|
+
* @throws {RequiredError}
|
|
10840
|
+
*/
|
|
10841
|
+
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10286
10842
|
/**
|
|
10287
10843
|
* Retrieves a single monitor
|
|
10288
10844
|
* @summary Retrieve monitor
|
|
@@ -10314,7 +10870,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10314
10870
|
* @param {*} [options] Override http request option.
|
|
10315
10871
|
* @throws {RequiredError}
|
|
10316
10872
|
*/
|
|
10317
|
-
|
|
10873
|
+
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10318
10874
|
/**
|
|
10319
10875
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
10320
10876
|
* @summary Generate a SDK token
|
|
@@ -10356,7 +10912,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10356
10912
|
* @param {*} [options] Override http request option.
|
|
10357
10913
|
* @throws {RequiredError}
|
|
10358
10914
|
*/
|
|
10359
|
-
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10915
|
+
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdPhotosList>>;
|
|
10360
10916
|
/**
|
|
10361
10917
|
* Lists the live photos that belong to an applicant.
|
|
10362
10918
|
* @summary List live photos
|
|
@@ -10372,7 +10928,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10372
10928
|
* @param {*} [options] Override http request option.
|
|
10373
10929
|
* @throws {RequiredError}
|
|
10374
10930
|
*/
|
|
10375
|
-
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10931
|
+
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveVideosList>>;
|
|
10376
10932
|
/**
|
|
10377
10933
|
* Lists all the motion captures that belong to an applicant.
|
|
10378
10934
|
* @summary List motion captures
|
|
@@ -10404,7 +10960,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10404
10960
|
* @param {*} [options] Override http request option.
|
|
10405
10961
|
* @throws {RequiredError}
|
|
10406
10962
|
*/
|
|
10407
|
-
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
10963
|
+
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskItem>>>;
|
|
10408
10964
|
/**
|
|
10409
10965
|
* List match IDs on this monitor, as well as their enabled/disabled status
|
|
10410
10966
|
* @summary List matches (BETA)
|
|
@@ -10412,7 +10968,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10412
10968
|
* @param {*} [options] Override http request option.
|
|
10413
10969
|
* @throws {RequiredError}
|
|
10414
10970
|
*/
|
|
10415
|
-
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10971
|
+
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitorMatchesList>>;
|
|
10416
10972
|
/**
|
|
10417
10973
|
* List all available monitors for an applicant
|
|
10418
10974
|
* @summary List monitors
|
|
@@ -10421,7 +10977,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10421
10977
|
* @param {*} [options] Override http request option.
|
|
10422
10978
|
* @throws {RequiredError}
|
|
10423
10979
|
*/
|
|
10424
|
-
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10980
|
+
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitorsList>>;
|
|
10425
10981
|
/**
|
|
10426
10982
|
* Lists all webhooks you\'ve created.
|
|
10427
10983
|
* @summary List webhooks
|
|
@@ -10501,11 +11057,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10501
11057
|
* Update the status of the given matches
|
|
10502
11058
|
* @summary Set match status (BETA)
|
|
10503
11059
|
* @param {string} monitorId
|
|
10504
|
-
* @param {
|
|
11060
|
+
* @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
|
|
10505
11061
|
* @param {*} [options] Override http request option.
|
|
10506
11062
|
* @throws {RequiredError}
|
|
10507
11063
|
*/
|
|
10508
|
-
|
|
11064
|
+
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitorMatchesList>>;
|
|
10509
11065
|
/**
|
|
10510
11066
|
* Edits a webhook. Returns the updated webhook object.
|
|
10511
11067
|
* @summary Edit a webhook
|
|
@@ -10520,7 +11076,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10520
11076
|
* @summary Upload a document
|
|
10521
11077
|
* @param {string} type The type of document
|
|
10522
11078
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
10523
|
-
* @param {
|
|
11079
|
+
* @param {FileTransfer} file The file to be uploaded.
|
|
10524
11080
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
10525
11081
|
* @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
|
|
10526
11082
|
* @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
|
|
@@ -10529,26 +11085,26 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10529
11085
|
* @param {*} [options] Override http request option.
|
|
10530
11086
|
* @throws {RequiredError}
|
|
10531
11087
|
*/
|
|
10532
|
-
uploadDocument(type: string, applicantId: string, file:
|
|
11088
|
+
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
11089
|
/**
|
|
10534
11090
|
* 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
11091
|
* @summary Upload ID photo
|
|
10536
11092
|
* @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
|
|
10537
|
-
* @param {
|
|
11093
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
10538
11094
|
* @param {*} [options] Override http request option.
|
|
10539
11095
|
* @throws {RequiredError}
|
|
10540
11096
|
*/
|
|
10541
|
-
uploadIdPhoto(applicantId?: string, file?:
|
|
11097
|
+
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdPhoto>>;
|
|
10542
11098
|
/**
|
|
10543
11099
|
* 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
11100
|
* @summary Upload live photo
|
|
10545
11101
|
* @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
|
|
10546
|
-
* @param {
|
|
11102
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
10547
11103
|
* @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
|
|
10548
11104
|
* @param {*} [options] Override http request option.
|
|
10549
11105
|
* @throws {RequiredError}
|
|
10550
11106
|
*/
|
|
10551
|
-
uploadLivePhoto(applicantId?: string, file?:
|
|
11107
|
+
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LivePhoto>>;
|
|
10552
11108
|
};
|
|
10553
11109
|
/**
|
|
10554
11110
|
* DefaultApi - factory interface
|
|
@@ -10568,11 +11124,11 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10568
11124
|
* @summary Complete Task
|
|
10569
11125
|
* @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
|
|
10570
11126
|
* @param {string} taskId The identifier of the Task you want to complete.
|
|
10571
|
-
* @param {
|
|
11127
|
+
* @param {CompleteTaskBuilder} completeTaskBuilder
|
|
10572
11128
|
* @param {*} [options] Override http request option.
|
|
10573
11129
|
* @throws {RequiredError}
|
|
10574
11130
|
*/
|
|
10575
|
-
completeTask(workflowRunId: string, taskId: string,
|
|
11131
|
+
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: any): AxiosPromise<void>;
|
|
10576
11132
|
/**
|
|
10577
11133
|
* Creates a single applicant. Returns an applicant object.
|
|
10578
11134
|
* @summary Create Applicant
|
|
@@ -10589,14 +11145,22 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10589
11145
|
* @throws {RequiredError}
|
|
10590
11146
|
*/
|
|
10591
11147
|
createCheck(checkBuilder: CheckBuilder, options?: any): AxiosPromise<Check>;
|
|
11148
|
+
/**
|
|
11149
|
+
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
11150
|
+
* @summary Create Timeline File for Workflow Run
|
|
11151
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
11152
|
+
* @param {*} [options] Override http request option.
|
|
11153
|
+
* @throws {RequiredError}
|
|
11154
|
+
*/
|
|
11155
|
+
createTimelineFile(workflowRunId: string, options?: any): AxiosPromise<TimelineFileReference>;
|
|
10592
11156
|
/**
|
|
10593
11157
|
* Creates a new monitor for the applicant
|
|
10594
11158
|
* @summary Create monitor
|
|
10595
|
-
* @param {
|
|
11159
|
+
* @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
|
|
10596
11160
|
* @param {*} [options] Override http request option.
|
|
10597
11161
|
* @throws {RequiredError}
|
|
10598
11162
|
*/
|
|
10599
|
-
createWatchlistMonitor(
|
|
11163
|
+
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: any): AxiosPromise<WatchlistMonitor>;
|
|
10600
11164
|
/**
|
|
10601
11165
|
* Registers a webhook. Returns a webhook object.
|
|
10602
11166
|
* @summary Register webhook
|
|
@@ -10644,7 +11208,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10644
11208
|
* @param {*} [options] Override http request option.
|
|
10645
11209
|
* @throws {RequiredError}
|
|
10646
11210
|
*/
|
|
10647
|
-
downloadCheck(checkId: string, options?: any): AxiosPromise<
|
|
11211
|
+
downloadCheck(checkId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10648
11212
|
/**
|
|
10649
11213
|
* Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
10650
11214
|
* @summary Download document
|
|
@@ -10652,7 +11216,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10652
11216
|
* @param {*} [options] Override http request option.
|
|
10653
11217
|
* @throws {RequiredError}
|
|
10654
11218
|
*/
|
|
10655
|
-
downloadDocument(documentId: string, options?: any): AxiosPromise<
|
|
11219
|
+
downloadDocument(documentId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10656
11220
|
/**
|
|
10657
11221
|
* Downloads a document video. If successful, the response will be the binary data representing the video.
|
|
10658
11222
|
* @summary Download document video
|
|
@@ -10660,7 +11224,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10660
11224
|
* @param {*} [options] Override http request option.
|
|
10661
11225
|
* @throws {RequiredError}
|
|
10662
11226
|
*/
|
|
10663
|
-
downloadDocumentVideo(documentId: string, options?: any): AxiosPromise<
|
|
11227
|
+
downloadDocumentVideo(documentId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10664
11228
|
/**
|
|
10665
11229
|
* ID photos are downloaded using this endpoint.
|
|
10666
11230
|
* @summary Download ID photo
|
|
@@ -10668,7 +11232,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10668
11232
|
* @param {*} [options] Override http request option.
|
|
10669
11233
|
* @throws {RequiredError}
|
|
10670
11234
|
*/
|
|
10671
|
-
downloadIdPhoto(idPhotoId: string, options?: any): AxiosPromise<
|
|
11235
|
+
downloadIdPhoto(idPhotoId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10672
11236
|
/**
|
|
10673
11237
|
* Live photos are downloaded using this endpoint.
|
|
10674
11238
|
* @summary Download live photo
|
|
@@ -10676,7 +11240,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10676
11240
|
* @param {*} [options] Override http request option.
|
|
10677
11241
|
* @throws {RequiredError}
|
|
10678
11242
|
*/
|
|
10679
|
-
downloadLivePhoto(livePhotoId: string, options?: any): AxiosPromise<
|
|
11243
|
+
downloadLivePhoto(livePhotoId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10680
11244
|
/**
|
|
10681
11245
|
* Live videos are downloaded using this endpoint.
|
|
10682
11246
|
* @summary Download live video
|
|
@@ -10684,7 +11248,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10684
11248
|
* @param {*} [options] Override http request option.
|
|
10685
11249
|
* @throws {RequiredError}
|
|
10686
11250
|
*/
|
|
10687
|
-
downloadLiveVideo(liveVideoId: string, options?: any): AxiosPromise<
|
|
11251
|
+
downloadLiveVideo(liveVideoId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10688
11252
|
/**
|
|
10689
11253
|
* Returns the binary data representing a single frame from a live video.
|
|
10690
11254
|
* @summary Download live video frame
|
|
@@ -10692,7 +11256,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10692
11256
|
* @param {*} [options] Override http request option.
|
|
10693
11257
|
* @throws {RequiredError}
|
|
10694
11258
|
*/
|
|
10695
|
-
downloadLiveVideoFrame(liveVideoId: string, options?: any): AxiosPromise<
|
|
11259
|
+
downloadLiveVideoFrame(liveVideoId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10696
11260
|
/**
|
|
10697
11261
|
* Motion captures are downloaded using this endpoint.
|
|
10698
11262
|
* @summary Download motion capture
|
|
@@ -10700,7 +11264,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10700
11264
|
* @param {*} [options] Override http request option.
|
|
10701
11265
|
* @throws {RequiredError}
|
|
10702
11266
|
*/
|
|
10703
|
-
downloadMotionCapture(motionCaptureId: string, options?: any): AxiosPromise<
|
|
11267
|
+
downloadMotionCapture(motionCaptureId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10704
11268
|
/**
|
|
10705
11269
|
* Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
|
10706
11270
|
* @summary Download motion capture frame
|
|
@@ -10708,7 +11272,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10708
11272
|
* @param {*} [options] Override http request option.
|
|
10709
11273
|
* @throws {RequiredError}
|
|
10710
11274
|
*/
|
|
10711
|
-
downloadMotionCaptureFrame(motionCaptureId: string, options?: any): AxiosPromise<
|
|
11275
|
+
downloadMotionCaptureFrame(motionCaptureId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10712
11276
|
/**
|
|
10713
11277
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
10714
11278
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -10716,7 +11280,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10716
11280
|
* @param {*} [options] Override http request option.
|
|
10717
11281
|
* @throws {RequiredError}
|
|
10718
11282
|
*/
|
|
10719
|
-
downloadSignedEvidenceFile(workflowRunId: string, options?: any): AxiosPromise<
|
|
11283
|
+
downloadSignedEvidenceFile(workflowRunId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10720
11284
|
/**
|
|
10721
11285
|
* Extract information from a document
|
|
10722
11286
|
* @summary Autofill
|
|
@@ -10806,6 +11370,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10806
11370
|
* @throws {RequiredError}
|
|
10807
11371
|
*/
|
|
10808
11372
|
findTask(workflowRunId: string, taskId: string, options?: any): AxiosPromise<Task>;
|
|
11373
|
+
/**
|
|
11374
|
+
* Retrieves the Timeline File for the designated Workflow Run.
|
|
11375
|
+
* @summary Retrieve Timeline File for Workflow Run
|
|
11376
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
11377
|
+
* @param {string} timelineFileId The unique identifier for the Timefile File.
|
|
11378
|
+
* @param {*} [options] Override http request option.
|
|
11379
|
+
* @throws {RequiredError}
|
|
11380
|
+
*/
|
|
11381
|
+
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
10809
11382
|
/**
|
|
10810
11383
|
* Retrieves a single monitor
|
|
10811
11384
|
* @summary Retrieve monitor
|
|
@@ -10837,7 +11410,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10837
11410
|
* @param {*} [options] Override http request option.
|
|
10838
11411
|
* @throws {RequiredError}
|
|
10839
11412
|
*/
|
|
10840
|
-
|
|
11413
|
+
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: any): AxiosPromise<void>;
|
|
10841
11414
|
/**
|
|
10842
11415
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
10843
11416
|
* @summary Generate a SDK token
|
|
@@ -10879,7 +11452,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10879
11452
|
* @param {*} [options] Override http request option.
|
|
10880
11453
|
* @throws {RequiredError}
|
|
10881
11454
|
*/
|
|
10882
|
-
listIdPhotos(applicantId: string, options?: any): AxiosPromise<
|
|
11455
|
+
listIdPhotos(applicantId: string, options?: any): AxiosPromise<IdPhotosList>;
|
|
10883
11456
|
/**
|
|
10884
11457
|
* Lists the live photos that belong to an applicant.
|
|
10885
11458
|
* @summary List live photos
|
|
@@ -10895,7 +11468,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10895
11468
|
* @param {*} [options] Override http request option.
|
|
10896
11469
|
* @throws {RequiredError}
|
|
10897
11470
|
*/
|
|
10898
|
-
listLiveVideos(applicantId: string, options?: any): AxiosPromise<
|
|
11471
|
+
listLiveVideos(applicantId: string, options?: any): AxiosPromise<LiveVideosList>;
|
|
10899
11472
|
/**
|
|
10900
11473
|
* Lists all the motion captures that belong to an applicant.
|
|
10901
11474
|
* @summary List motion captures
|
|
@@ -10927,7 +11500,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10927
11500
|
* @param {*} [options] Override http request option.
|
|
10928
11501
|
* @throws {RequiredError}
|
|
10929
11502
|
*/
|
|
10930
|
-
listTasks(workflowRunId: string, options?: any): AxiosPromise<Array<
|
|
11503
|
+
listTasks(workflowRunId: string, options?: any): AxiosPromise<Array<TaskItem>>;
|
|
10931
11504
|
/**
|
|
10932
11505
|
* List match IDs on this monitor, as well as their enabled/disabled status
|
|
10933
11506
|
* @summary List matches (BETA)
|
|
@@ -10935,7 +11508,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10935
11508
|
* @param {*} [options] Override http request option.
|
|
10936
11509
|
* @throws {RequiredError}
|
|
10937
11510
|
*/
|
|
10938
|
-
listWatchlistMonitorMatches(monitorId: string, options?: any): AxiosPromise<
|
|
11511
|
+
listWatchlistMonitorMatches(monitorId: string, options?: any): AxiosPromise<WatchlistMonitorMatchesList>;
|
|
10939
11512
|
/**
|
|
10940
11513
|
* List all available monitors for an applicant
|
|
10941
11514
|
* @summary List monitors
|
|
@@ -10944,7 +11517,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
10944
11517
|
* @param {*} [options] Override http request option.
|
|
10945
11518
|
* @throws {RequiredError}
|
|
10946
11519
|
*/
|
|
10947
|
-
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: any): AxiosPromise<
|
|
11520
|
+
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: any): AxiosPromise<WatchlistMonitorsList>;
|
|
10948
11521
|
/**
|
|
10949
11522
|
* Lists all webhooks you\'ve created.
|
|
10950
11523
|
* @summary List webhooks
|
|
@@ -11024,11 +11597,11 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11024
11597
|
* Update the status of the given matches
|
|
11025
11598
|
* @summary Set match status (BETA)
|
|
11026
11599
|
* @param {string} monitorId
|
|
11027
|
-
* @param {
|
|
11600
|
+
* @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
|
|
11028
11601
|
* @param {*} [options] Override http request option.
|
|
11029
11602
|
* @throws {RequiredError}
|
|
11030
11603
|
*/
|
|
11031
|
-
|
|
11604
|
+
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: any): AxiosPromise<WatchlistMonitorMatchesList>;
|
|
11032
11605
|
/**
|
|
11033
11606
|
* Edits a webhook. Returns the updated webhook object.
|
|
11034
11607
|
* @summary Edit a webhook
|
|
@@ -11043,7 +11616,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11043
11616
|
* @summary Upload a document
|
|
11044
11617
|
* @param {string} type The type of document
|
|
11045
11618
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
11046
|
-
* @param {
|
|
11619
|
+
* @param {FileTransfer} file The file to be uploaded.
|
|
11047
11620
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
11048
11621
|
* @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
|
|
11049
11622
|
* @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
|
|
@@ -11052,26 +11625,26 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11052
11625
|
* @param {*} [options] Override http request option.
|
|
11053
11626
|
* @throws {RequiredError}
|
|
11054
11627
|
*/
|
|
11055
|
-
uploadDocument(type: string, applicantId: string, file:
|
|
11628
|
+
uploadDocument(type: string, applicantId: string, file: FileTransfer, fileType?: UploadDocumentFileTypeEnum, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: any): AxiosPromise<Document>;
|
|
11056
11629
|
/**
|
|
11057
11630
|
* 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
11631
|
* @summary Upload ID photo
|
|
11059
11632
|
* @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
|
|
11060
|
-
* @param {
|
|
11633
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
11061
11634
|
* @param {*} [options] Override http request option.
|
|
11062
11635
|
* @throws {RequiredError}
|
|
11063
11636
|
*/
|
|
11064
|
-
uploadIdPhoto(applicantId?: string, file?:
|
|
11637
|
+
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: any): AxiosPromise<IdPhoto>;
|
|
11065
11638
|
/**
|
|
11066
11639
|
* 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
11640
|
* @summary Upload live photo
|
|
11068
11641
|
* @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
|
|
11069
|
-
* @param {
|
|
11642
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
11070
11643
|
* @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
|
|
11071
11644
|
* @param {*} [options] Override http request option.
|
|
11072
11645
|
* @throws {RequiredError}
|
|
11073
11646
|
*/
|
|
11074
|
-
uploadLivePhoto(applicantId?: string, file?:
|
|
11647
|
+
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: any): AxiosPromise<LivePhoto>;
|
|
11075
11648
|
};
|
|
11076
11649
|
/**
|
|
11077
11650
|
* DefaultApi - object-oriented interface
|
|
@@ -11094,12 +11667,12 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11094
11667
|
* @summary Complete Task
|
|
11095
11668
|
* @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
|
|
11096
11669
|
* @param {string} taskId The identifier of the Task you want to complete.
|
|
11097
|
-
* @param {
|
|
11670
|
+
* @param {CompleteTaskBuilder} completeTaskBuilder
|
|
11098
11671
|
* @param {*} [options] Override http request option.
|
|
11099
11672
|
* @throws {RequiredError}
|
|
11100
11673
|
* @memberof DefaultApi
|
|
11101
11674
|
*/
|
|
11102
|
-
completeTask(workflowRunId: string, taskId: string,
|
|
11675
|
+
completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11103
11676
|
/**
|
|
11104
11677
|
* Creates a single applicant. Returns an applicant object.
|
|
11105
11678
|
* @summary Create Applicant
|
|
@@ -11118,15 +11691,24 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11118
11691
|
* @memberof DefaultApi
|
|
11119
11692
|
*/
|
|
11120
11693
|
createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any>>;
|
|
11694
|
+
/**
|
|
11695
|
+
* Triggers the generation of the Timeline File for the designated Workflow Run.
|
|
11696
|
+
* @summary Create Timeline File for Workflow Run
|
|
11697
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
11698
|
+
* @param {*} [options] Override http request option.
|
|
11699
|
+
* @throws {RequiredError}
|
|
11700
|
+
* @memberof DefaultApi
|
|
11701
|
+
*/
|
|
11702
|
+
createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TimelineFileReference, any>>;
|
|
11121
11703
|
/**
|
|
11122
11704
|
* Creates a new monitor for the applicant
|
|
11123
11705
|
* @summary Create monitor
|
|
11124
|
-
* @param {
|
|
11706
|
+
* @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
|
|
11125
11707
|
* @param {*} [options] Override http request option.
|
|
11126
11708
|
* @throws {RequiredError}
|
|
11127
11709
|
* @memberof DefaultApi
|
|
11128
11710
|
*/
|
|
11129
|
-
createWatchlistMonitor(
|
|
11711
|
+
createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any>>;
|
|
11130
11712
|
/**
|
|
11131
11713
|
* Registers a webhook. Returns a webhook object.
|
|
11132
11714
|
* @summary Register webhook
|
|
@@ -11180,7 +11762,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11180
11762
|
* @throws {RequiredError}
|
|
11181
11763
|
* @memberof DefaultApi
|
|
11182
11764
|
*/
|
|
11183
|
-
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11765
|
+
downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11184
11766
|
/**
|
|
11185
11767
|
* Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
|
|
11186
11768
|
* @summary Download document
|
|
@@ -11189,7 +11771,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11189
11771
|
* @throws {RequiredError}
|
|
11190
11772
|
* @memberof DefaultApi
|
|
11191
11773
|
*/
|
|
11192
|
-
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11774
|
+
downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11193
11775
|
/**
|
|
11194
11776
|
* Downloads a document video. If successful, the response will be the binary data representing the video.
|
|
11195
11777
|
* @summary Download document video
|
|
@@ -11198,7 +11780,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11198
11780
|
* @throws {RequiredError}
|
|
11199
11781
|
* @memberof DefaultApi
|
|
11200
11782
|
*/
|
|
11201
|
-
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11783
|
+
downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11202
11784
|
/**
|
|
11203
11785
|
* ID photos are downloaded using this endpoint.
|
|
11204
11786
|
* @summary Download ID photo
|
|
@@ -11207,7 +11789,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11207
11789
|
* @throws {RequiredError}
|
|
11208
11790
|
* @memberof DefaultApi
|
|
11209
11791
|
*/
|
|
11210
|
-
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11792
|
+
downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11211
11793
|
/**
|
|
11212
11794
|
* Live photos are downloaded using this endpoint.
|
|
11213
11795
|
* @summary Download live photo
|
|
@@ -11216,7 +11798,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11216
11798
|
* @throws {RequiredError}
|
|
11217
11799
|
* @memberof DefaultApi
|
|
11218
11800
|
*/
|
|
11219
|
-
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11801
|
+
downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11220
11802
|
/**
|
|
11221
11803
|
* Live videos are downloaded using this endpoint.
|
|
11222
11804
|
* @summary Download live video
|
|
@@ -11225,7 +11807,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11225
11807
|
* @throws {RequiredError}
|
|
11226
11808
|
* @memberof DefaultApi
|
|
11227
11809
|
*/
|
|
11228
|
-
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11810
|
+
downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11229
11811
|
/**
|
|
11230
11812
|
* Returns the binary data representing a single frame from a live video.
|
|
11231
11813
|
* @summary Download live video frame
|
|
@@ -11234,7 +11816,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11234
11816
|
* @throws {RequiredError}
|
|
11235
11817
|
* @memberof DefaultApi
|
|
11236
11818
|
*/
|
|
11237
|
-
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11819
|
+
downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11238
11820
|
/**
|
|
11239
11821
|
* Motion captures are downloaded using this endpoint.
|
|
11240
11822
|
* @summary Download motion capture
|
|
@@ -11243,7 +11825,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11243
11825
|
* @throws {RequiredError}
|
|
11244
11826
|
* @memberof DefaultApi
|
|
11245
11827
|
*/
|
|
11246
|
-
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11828
|
+
downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11247
11829
|
/**
|
|
11248
11830
|
* Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
|
|
11249
11831
|
* @summary Download motion capture frame
|
|
@@ -11252,7 +11834,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11252
11834
|
* @throws {RequiredError}
|
|
11253
11835
|
* @memberof DefaultApi
|
|
11254
11836
|
*/
|
|
11255
|
-
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11837
|
+
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11256
11838
|
/**
|
|
11257
11839
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
11258
11840
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -11261,7 +11843,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11261
11843
|
* @throws {RequiredError}
|
|
11262
11844
|
* @memberof DefaultApi
|
|
11263
11845
|
*/
|
|
11264
|
-
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
11846
|
+
downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11265
11847
|
/**
|
|
11266
11848
|
* Extract information from a document
|
|
11267
11849
|
* @summary Autofill
|
|
@@ -11362,6 +11944,16 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11362
11944
|
* @memberof DefaultApi
|
|
11363
11945
|
*/
|
|
11364
11946
|
findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Task, any>>;
|
|
11947
|
+
/**
|
|
11948
|
+
* Retrieves the Timeline File for the designated Workflow Run.
|
|
11949
|
+
* @summary Retrieve Timeline File for Workflow Run
|
|
11950
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run.
|
|
11951
|
+
* @param {string} timelineFileId The unique identifier for the Timefile File.
|
|
11952
|
+
* @param {*} [options] Override http request option.
|
|
11953
|
+
* @throws {RequiredError}
|
|
11954
|
+
* @memberof DefaultApi
|
|
11955
|
+
*/
|
|
11956
|
+
findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11365
11957
|
/**
|
|
11366
11958
|
* Retrieves a single monitor
|
|
11367
11959
|
* @summary Retrieve monitor
|
|
@@ -11397,7 +11989,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11397
11989
|
* @throws {RequiredError}
|
|
11398
11990
|
* @memberof DefaultApi
|
|
11399
11991
|
*/
|
|
11400
|
-
|
|
11992
|
+
forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
11401
11993
|
/**
|
|
11402
11994
|
* Generates an SDK token. Returns a token object containing the SDK token.
|
|
11403
11995
|
* @summary Generate a SDK token
|
|
@@ -11444,7 +12036,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11444
12036
|
* @throws {RequiredError}
|
|
11445
12037
|
* @memberof DefaultApi
|
|
11446
12038
|
*/
|
|
11447
|
-
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12039
|
+
listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhotosList, any>>;
|
|
11448
12040
|
/**
|
|
11449
12041
|
* Lists the live photos that belong to an applicant.
|
|
11450
12042
|
* @summary List live photos
|
|
@@ -11462,7 +12054,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11462
12054
|
* @throws {RequiredError}
|
|
11463
12055
|
* @memberof DefaultApi
|
|
11464
12056
|
*/
|
|
11465
|
-
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12057
|
+
listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideosList, any>>;
|
|
11466
12058
|
/**
|
|
11467
12059
|
* Lists all the motion captures that belong to an applicant.
|
|
11468
12060
|
* @summary List motion captures
|
|
@@ -11498,7 +12090,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11498
12090
|
* @throws {RequiredError}
|
|
11499
12091
|
* @memberof DefaultApi
|
|
11500
12092
|
*/
|
|
11501
|
-
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12093
|
+
listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskItem[], any>>;
|
|
11502
12094
|
/**
|
|
11503
12095
|
* List match IDs on this monitor, as well as their enabled/disabled status
|
|
11504
12096
|
* @summary List matches (BETA)
|
|
@@ -11507,7 +12099,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11507
12099
|
* @throws {RequiredError}
|
|
11508
12100
|
* @memberof DefaultApi
|
|
11509
12101
|
*/
|
|
11510
|
-
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12102
|
+
listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any>>;
|
|
11511
12103
|
/**
|
|
11512
12104
|
* List all available monitors for an applicant
|
|
11513
12105
|
* @summary List monitors
|
|
@@ -11517,7 +12109,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11517
12109
|
* @throws {RequiredError}
|
|
11518
12110
|
* @memberof DefaultApi
|
|
11519
12111
|
*/
|
|
11520
|
-
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
12112
|
+
listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorsList, any>>;
|
|
11521
12113
|
/**
|
|
11522
12114
|
* Lists all webhooks you\'ve created.
|
|
11523
12115
|
* @summary List webhooks
|
|
@@ -11606,12 +12198,12 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11606
12198
|
* Update the status of the given matches
|
|
11607
12199
|
* @summary Set match status (BETA)
|
|
11608
12200
|
* @param {string} monitorId
|
|
11609
|
-
* @param {
|
|
12201
|
+
* @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
|
|
11610
12202
|
* @param {*} [options] Override http request option.
|
|
11611
12203
|
* @throws {RequiredError}
|
|
11612
12204
|
* @memberof DefaultApi
|
|
11613
12205
|
*/
|
|
11614
|
-
|
|
12206
|
+
updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any>>;
|
|
11615
12207
|
/**
|
|
11616
12208
|
* Edits a webhook. Returns the updated webhook object.
|
|
11617
12209
|
* @summary Edit a webhook
|
|
@@ -11627,7 +12219,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11627
12219
|
* @summary Upload a document
|
|
11628
12220
|
* @param {string} type The type of document
|
|
11629
12221
|
* @param {string} applicantId The ID of the applicant whose document is being uploaded.
|
|
11630
|
-
* @param {
|
|
12222
|
+
* @param {FileTransfer} file The file to be uploaded.
|
|
11631
12223
|
* @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
|
|
11632
12224
|
* @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
|
|
11633
12225
|
* @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
|
|
@@ -11637,28 +12229,28 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11637
12229
|
* @throws {RequiredError}
|
|
11638
12230
|
* @memberof DefaultApi
|
|
11639
12231
|
*/
|
|
11640
|
-
uploadDocument(type: string, applicantId: string, file:
|
|
12232
|
+
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
12233
|
/**
|
|
11642
12234
|
* 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
12235
|
* @summary Upload ID photo
|
|
11644
12236
|
* @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
|
|
11645
|
-
* @param {
|
|
12237
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
11646
12238
|
* @param {*} [options] Override http request option.
|
|
11647
12239
|
* @throws {RequiredError}
|
|
11648
12240
|
* @memberof DefaultApi
|
|
11649
12241
|
*/
|
|
11650
|
-
uploadIdPhoto(applicantId?: string, file?:
|
|
12242
|
+
uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any>>;
|
|
11651
12243
|
/**
|
|
11652
12244
|
* 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
12245
|
* @summary Upload live photo
|
|
11654
12246
|
* @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
|
|
11655
|
-
* @param {
|
|
12247
|
+
* @param {FileTransfer} [file] The file to be uploaded.
|
|
11656
12248
|
* @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
|
|
11657
12249
|
* @param {*} [options] Override http request option.
|
|
11658
12250
|
* @throws {RequiredError}
|
|
11659
12251
|
* @memberof DefaultApi
|
|
11660
12252
|
*/
|
|
11661
|
-
uploadLivePhoto(applicantId?: string, file?:
|
|
12253
|
+
uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any>>;
|
|
11662
12254
|
}
|
|
11663
12255
|
/**
|
|
11664
12256
|
* @export
|