@onfido/api 3.1.0 → 3.3.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 +3 -0
- package/dist/api.d.ts +310 -6
- package/dist/api.js +132 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +310 -6
- package/dist/esm/api.js +130 -0
- package/dist/esm/configuration.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,9 @@ This library is only for use on the backend, as it uses Onfido API tokens which
|
|
|
8
8
|
|
|
9
9
|
This version uses Onfido API v3.6. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
|
|
10
10
|
|
|
11
|
+
[](https://badge.fury.io/js/@onfido%2Fapi)
|
|
12
|
+

|
|
13
|
+
|
|
11
14
|
## Installation & Usage
|
|
12
15
|
|
|
13
16
|
### Installation
|
package/dist/api.d.ts
CHANGED
|
@@ -1766,6 +1766,7 @@ export interface Document {
|
|
|
1766
1766
|
}
|
|
1767
1767
|
export declare const DocumentFileTypeEnum: {
|
|
1768
1768
|
readonly Jpg: "jpg";
|
|
1769
|
+
readonly Jpeg: "jpeg";
|
|
1769
1770
|
readonly Png: "png";
|
|
1770
1771
|
readonly Pdf: "pdf";
|
|
1771
1772
|
readonly UnknownDefaultOpenApi: "11184809";
|
|
@@ -2805,6 +2806,12 @@ export interface DocumentProperties {
|
|
|
2805
2806
|
* @memberof DocumentProperties
|
|
2806
2807
|
*/
|
|
2807
2808
|
'date_of_expiry'?: string;
|
|
2809
|
+
/**
|
|
2810
|
+
*
|
|
2811
|
+
* @type {string}
|
|
2812
|
+
* @memberof DocumentProperties
|
|
2813
|
+
*/
|
|
2814
|
+
'personal_number'?: string;
|
|
2808
2815
|
/**
|
|
2809
2816
|
*
|
|
2810
2817
|
* @type {Array<DocumentPropertiesDocumentNumbersInner>}
|
|
@@ -2828,19 +2835,25 @@ export interface DocumentProperties {
|
|
|
2828
2835
|
* @type {string}
|
|
2829
2836
|
* @memberof DocumentProperties
|
|
2830
2837
|
*/
|
|
2831
|
-
'
|
|
2838
|
+
'middle_name'?: string;
|
|
2832
2839
|
/**
|
|
2833
2840
|
*
|
|
2834
2841
|
* @type {string}
|
|
2835
2842
|
* @memberof DocumentProperties
|
|
2836
2843
|
*/
|
|
2837
|
-
'
|
|
2844
|
+
'last_name'?: string;
|
|
2838
2845
|
/**
|
|
2839
2846
|
*
|
|
2840
2847
|
* @type {string}
|
|
2841
2848
|
* @memberof DocumentProperties
|
|
2842
2849
|
*/
|
|
2843
|
-
'
|
|
2850
|
+
'gender'?: string;
|
|
2851
|
+
/**
|
|
2852
|
+
*
|
|
2853
|
+
* @type {string}
|
|
2854
|
+
* @memberof DocumentProperties
|
|
2855
|
+
*/
|
|
2856
|
+
'issuing_country'?: string;
|
|
2844
2857
|
/**
|
|
2845
2858
|
*
|
|
2846
2859
|
* @type {string}
|
|
@@ -2919,12 +2932,102 @@ export interface DocumentProperties {
|
|
|
2919
2932
|
* @memberof DocumentProperties
|
|
2920
2933
|
*/
|
|
2921
2934
|
'issuing_authority'?: string;
|
|
2935
|
+
/**
|
|
2936
|
+
*
|
|
2937
|
+
* @type {string}
|
|
2938
|
+
* @memberof DocumentProperties
|
|
2939
|
+
*/
|
|
2940
|
+
'remarks'?: string;
|
|
2941
|
+
/**
|
|
2942
|
+
*
|
|
2943
|
+
* @type {string}
|
|
2944
|
+
* @memberof DocumentProperties
|
|
2945
|
+
*/
|
|
2946
|
+
'civil_state'?: string;
|
|
2947
|
+
/**
|
|
2948
|
+
*
|
|
2949
|
+
* @type {string}
|
|
2950
|
+
* @memberof DocumentProperties
|
|
2951
|
+
*/
|
|
2952
|
+
'expatriation'?: string;
|
|
2953
|
+
/**
|
|
2954
|
+
*
|
|
2955
|
+
* @type {string}
|
|
2956
|
+
* @memberof DocumentProperties
|
|
2957
|
+
*/
|
|
2958
|
+
'father_name'?: string;
|
|
2959
|
+
/**
|
|
2960
|
+
*
|
|
2961
|
+
* @type {string}
|
|
2962
|
+
* @memberof DocumentProperties
|
|
2963
|
+
*/
|
|
2964
|
+
'mother_name'?: string;
|
|
2965
|
+
/**
|
|
2966
|
+
*
|
|
2967
|
+
* @type {string}
|
|
2968
|
+
* @memberof DocumentProperties
|
|
2969
|
+
*/
|
|
2970
|
+
'religion'?: string;
|
|
2971
|
+
/**
|
|
2972
|
+
*
|
|
2973
|
+
* @type {string}
|
|
2974
|
+
* @memberof DocumentProperties
|
|
2975
|
+
*/
|
|
2976
|
+
'type_of_permit'?: string;
|
|
2977
|
+
/**
|
|
2978
|
+
*
|
|
2979
|
+
* @type {string}
|
|
2980
|
+
* @memberof DocumentProperties
|
|
2981
|
+
*/
|
|
2982
|
+
'version_number'?: string;
|
|
2983
|
+
/**
|
|
2984
|
+
*
|
|
2985
|
+
* @type {string}
|
|
2986
|
+
* @memberof DocumentProperties
|
|
2987
|
+
*/
|
|
2988
|
+
'document_subtype'?: string;
|
|
2989
|
+
/**
|
|
2990
|
+
*
|
|
2991
|
+
* @type {string}
|
|
2992
|
+
* @memberof DocumentProperties
|
|
2993
|
+
*/
|
|
2994
|
+
'profession'?: string;
|
|
2995
|
+
/**
|
|
2996
|
+
*
|
|
2997
|
+
* @type {string}
|
|
2998
|
+
* @memberof DocumentProperties
|
|
2999
|
+
*/
|
|
3000
|
+
'security_document_number'?: string;
|
|
3001
|
+
/**
|
|
3002
|
+
*
|
|
3003
|
+
* @type {string}
|
|
3004
|
+
* @memberof DocumentProperties
|
|
3005
|
+
*/
|
|
3006
|
+
'tax_number'?: string;
|
|
3007
|
+
/**
|
|
3008
|
+
*
|
|
3009
|
+
* @type {string}
|
|
3010
|
+
* @memberof DocumentProperties
|
|
3011
|
+
*/
|
|
3012
|
+
'nist_identity_evidence_strength'?: DocumentPropertiesNistIdentityEvidenceStrengthEnum;
|
|
3013
|
+
/**
|
|
3014
|
+
*
|
|
3015
|
+
* @type {string}
|
|
3016
|
+
* @memberof DocumentProperties
|
|
3017
|
+
*/
|
|
3018
|
+
'has_issuance_confirmation'?: DocumentPropertiesHasIssuanceConfirmationEnum;
|
|
2922
3019
|
/**
|
|
2923
3020
|
*
|
|
2924
3021
|
* @type {boolean}
|
|
2925
3022
|
* @memberof DocumentProperties
|
|
2926
3023
|
*/
|
|
2927
3024
|
'real_id_compliance'?: boolean;
|
|
3025
|
+
/**
|
|
3026
|
+
*
|
|
3027
|
+
* @type {string}
|
|
3028
|
+
* @memberof DocumentProperties
|
|
3029
|
+
*/
|
|
3030
|
+
'security_tier'?: DocumentPropertiesSecurityTierEnum;
|
|
2928
3031
|
/**
|
|
2929
3032
|
*
|
|
2930
3033
|
* @type {DocumentPropertiesAddressLines}
|
|
@@ -2962,6 +3065,33 @@ export interface DocumentProperties {
|
|
|
2962
3065
|
*/
|
|
2963
3066
|
'extracted_data'?: DocumentPropertiesExtractedData;
|
|
2964
3067
|
}
|
|
3068
|
+
export declare const DocumentPropertiesNistIdentityEvidenceStrengthEnum: {
|
|
3069
|
+
readonly Superior: "superior";
|
|
3070
|
+
readonly Strong: "strong";
|
|
3071
|
+
readonly Fair: "fair";
|
|
3072
|
+
readonly Weak: "weak";
|
|
3073
|
+
readonly Unacceptable: "unacceptable";
|
|
3074
|
+
readonly UnspecifiedIdentityEvidenceStrength: "unspecified_identity_evidence_strength";
|
|
3075
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
3076
|
+
};
|
|
3077
|
+
export type DocumentPropertiesNistIdentityEvidenceStrengthEnum = typeof DocumentPropertiesNistIdentityEvidenceStrengthEnum[keyof typeof DocumentPropertiesNistIdentityEvidenceStrengthEnum];
|
|
3078
|
+
export declare const DocumentPropertiesHasIssuanceConfirmationEnum: {
|
|
3079
|
+
readonly True: "true";
|
|
3080
|
+
readonly False: "false";
|
|
3081
|
+
readonly Unspecified: "unspecified";
|
|
3082
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
3083
|
+
};
|
|
3084
|
+
export type DocumentPropertiesHasIssuanceConfirmationEnum = typeof DocumentPropertiesHasIssuanceConfirmationEnum[keyof typeof DocumentPropertiesHasIssuanceConfirmationEnum];
|
|
3085
|
+
export declare const DocumentPropertiesSecurityTierEnum: {
|
|
3086
|
+
readonly Tier1: "tier_1";
|
|
3087
|
+
readonly Tier2: "tier_2";
|
|
3088
|
+
readonly Tier3: "tier_3";
|
|
3089
|
+
readonly Tier4: "tier_4";
|
|
3090
|
+
readonly Tier5: "tier_5";
|
|
3091
|
+
readonly UnspecifiedSecurityTier: "unspecified_security_tier";
|
|
3092
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
3093
|
+
};
|
|
3094
|
+
export type DocumentPropertiesSecurityTierEnum = typeof DocumentPropertiesSecurityTierEnum[keyof typeof DocumentPropertiesSecurityTierEnum];
|
|
2965
3095
|
/**
|
|
2966
3096
|
*
|
|
2967
3097
|
* @export
|
|
@@ -3568,6 +3698,7 @@ export interface DocumentShared {
|
|
|
3568
3698
|
}
|
|
3569
3699
|
export declare const DocumentSharedFileTypeEnum: {
|
|
3570
3700
|
readonly Jpg: "jpg";
|
|
3701
|
+
readonly Jpeg: "jpeg";
|
|
3571
3702
|
readonly Png: "png";
|
|
3572
3703
|
readonly Pdf: "pdf";
|
|
3573
3704
|
readonly UnknownDefaultOpenApi: "11184809";
|
|
@@ -3923,6 +4054,12 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
3923
4054
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
3924
4055
|
*/
|
|
3925
4056
|
'date_of_expiry'?: string;
|
|
4057
|
+
/**
|
|
4058
|
+
*
|
|
4059
|
+
* @type {string}
|
|
4060
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4061
|
+
*/
|
|
4062
|
+
'personal_number'?: string;
|
|
3926
4063
|
/**
|
|
3927
4064
|
*
|
|
3928
4065
|
* @type {Array<DocumentPropertiesDocumentNumbersInner>}
|
|
@@ -3946,19 +4083,25 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
3946
4083
|
* @type {string}
|
|
3947
4084
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
3948
4085
|
*/
|
|
3949
|
-
'
|
|
4086
|
+
'middle_name'?: string;
|
|
3950
4087
|
/**
|
|
3951
4088
|
*
|
|
3952
4089
|
* @type {string}
|
|
3953
4090
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
3954
4091
|
*/
|
|
3955
|
-
'
|
|
4092
|
+
'last_name'?: string;
|
|
3956
4093
|
/**
|
|
3957
4094
|
*
|
|
3958
4095
|
* @type {string}
|
|
3959
4096
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
3960
4097
|
*/
|
|
3961
|
-
'
|
|
4098
|
+
'gender'?: string;
|
|
4099
|
+
/**
|
|
4100
|
+
*
|
|
4101
|
+
* @type {string}
|
|
4102
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4103
|
+
*/
|
|
4104
|
+
'issuing_country'?: string;
|
|
3962
4105
|
/**
|
|
3963
4106
|
*
|
|
3964
4107
|
* @type {string}
|
|
@@ -4037,12 +4180,102 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
4037
4180
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4038
4181
|
*/
|
|
4039
4182
|
'issuing_authority'?: string;
|
|
4183
|
+
/**
|
|
4184
|
+
*
|
|
4185
|
+
* @type {string}
|
|
4186
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4187
|
+
*/
|
|
4188
|
+
'remarks'?: string;
|
|
4189
|
+
/**
|
|
4190
|
+
*
|
|
4191
|
+
* @type {string}
|
|
4192
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4193
|
+
*/
|
|
4194
|
+
'civil_state'?: string;
|
|
4195
|
+
/**
|
|
4196
|
+
*
|
|
4197
|
+
* @type {string}
|
|
4198
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4199
|
+
*/
|
|
4200
|
+
'expatriation'?: string;
|
|
4201
|
+
/**
|
|
4202
|
+
*
|
|
4203
|
+
* @type {string}
|
|
4204
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4205
|
+
*/
|
|
4206
|
+
'father_name'?: string;
|
|
4207
|
+
/**
|
|
4208
|
+
*
|
|
4209
|
+
* @type {string}
|
|
4210
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4211
|
+
*/
|
|
4212
|
+
'mother_name'?: string;
|
|
4213
|
+
/**
|
|
4214
|
+
*
|
|
4215
|
+
* @type {string}
|
|
4216
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4217
|
+
*/
|
|
4218
|
+
'religion'?: string;
|
|
4219
|
+
/**
|
|
4220
|
+
*
|
|
4221
|
+
* @type {string}
|
|
4222
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4223
|
+
*/
|
|
4224
|
+
'type_of_permit'?: string;
|
|
4225
|
+
/**
|
|
4226
|
+
*
|
|
4227
|
+
* @type {string}
|
|
4228
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4229
|
+
*/
|
|
4230
|
+
'version_number'?: string;
|
|
4231
|
+
/**
|
|
4232
|
+
*
|
|
4233
|
+
* @type {string}
|
|
4234
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4235
|
+
*/
|
|
4236
|
+
'document_subtype'?: string;
|
|
4237
|
+
/**
|
|
4238
|
+
*
|
|
4239
|
+
* @type {string}
|
|
4240
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4241
|
+
*/
|
|
4242
|
+
'profession'?: string;
|
|
4243
|
+
/**
|
|
4244
|
+
*
|
|
4245
|
+
* @type {string}
|
|
4246
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4247
|
+
*/
|
|
4248
|
+
'security_document_number'?: string;
|
|
4249
|
+
/**
|
|
4250
|
+
*
|
|
4251
|
+
* @type {string}
|
|
4252
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4253
|
+
*/
|
|
4254
|
+
'tax_number'?: string;
|
|
4255
|
+
/**
|
|
4256
|
+
*
|
|
4257
|
+
* @type {string}
|
|
4258
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4259
|
+
*/
|
|
4260
|
+
'nist_identity_evidence_strength'?: DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum;
|
|
4261
|
+
/**
|
|
4262
|
+
*
|
|
4263
|
+
* @type {string}
|
|
4264
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4265
|
+
*/
|
|
4266
|
+
'has_issuance_confirmation'?: DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum;
|
|
4040
4267
|
/**
|
|
4041
4268
|
*
|
|
4042
4269
|
* @type {boolean}
|
|
4043
4270
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4044
4271
|
*/
|
|
4045
4272
|
'real_id_compliance'?: boolean;
|
|
4273
|
+
/**
|
|
4274
|
+
*
|
|
4275
|
+
* @type {string}
|
|
4276
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4277
|
+
*/
|
|
4278
|
+
'security_tier'?: DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum;
|
|
4046
4279
|
/**
|
|
4047
4280
|
*
|
|
4048
4281
|
* @type {DocumentPropertiesAddressLines}
|
|
@@ -4116,6 +4349,33 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
4116
4349
|
*/
|
|
4117
4350
|
'passenger_vehicle'?: DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle;
|
|
4118
4351
|
}
|
|
4352
|
+
export declare const DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum: {
|
|
4353
|
+
readonly Superior: "superior";
|
|
4354
|
+
readonly Strong: "strong";
|
|
4355
|
+
readonly Fair: "fair";
|
|
4356
|
+
readonly Weak: "weak";
|
|
4357
|
+
readonly Unacceptable: "unacceptable";
|
|
4358
|
+
readonly UnspecifiedIdentityEvidenceStrength: "unspecified_identity_evidence_strength";
|
|
4359
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
4360
|
+
};
|
|
4361
|
+
export type DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum];
|
|
4362
|
+
export declare const DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum: {
|
|
4363
|
+
readonly True: "true";
|
|
4364
|
+
readonly False: "false";
|
|
4365
|
+
readonly Unspecified: "unspecified";
|
|
4366
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
4367
|
+
};
|
|
4368
|
+
export type DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum];
|
|
4369
|
+
export declare const DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum: {
|
|
4370
|
+
readonly Tier1: "tier_1";
|
|
4371
|
+
readonly Tier2: "tier_2";
|
|
4372
|
+
readonly Tier3: "tier_3";
|
|
4373
|
+
readonly Tier4: "tier_4";
|
|
4374
|
+
readonly Tier5: "tier_5";
|
|
4375
|
+
readonly UnspecifiedSecurityTier: "unspecified_security_tier";
|
|
4376
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
4377
|
+
};
|
|
4378
|
+
export type DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum];
|
|
4119
4379
|
/**
|
|
4120
4380
|
* Normalised data for passenger cars
|
|
4121
4381
|
* @export
|
|
@@ -9252,6 +9512,12 @@ export interface WebhookEventPayloadObject {
|
|
|
9252
9512
|
* @memberof WebhookEventPayloadObject
|
|
9253
9513
|
*/
|
|
9254
9514
|
'status'?: string;
|
|
9515
|
+
/**
|
|
9516
|
+
* The date and time when the operation was started, if available.
|
|
9517
|
+
* @type {string}
|
|
9518
|
+
* @memberof WebhookEventPayloadObject
|
|
9519
|
+
*/
|
|
9520
|
+
'started_at_iso8601'?: string;
|
|
9255
9521
|
/**
|
|
9256
9522
|
* The date and time when the operation was completed, if available.
|
|
9257
9523
|
* @type {string}
|
|
@@ -9947,6 +10213,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9947
10213
|
* @throws {RequiredError}
|
|
9948
10214
|
*/
|
|
9949
10215
|
downloadMotionCaptureFrame: (motionCaptureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10216
|
+
/**
|
|
10217
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
10218
|
+
* @summary Retrieves the signed document or application form
|
|
10219
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
10220
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
10221
|
+
* @param {*} [options] Override http request option.
|
|
10222
|
+
* @throws {RequiredError}
|
|
10223
|
+
*/
|
|
10224
|
+
downloadQesDocument: (workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9950
10225
|
/**
|
|
9951
10226
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
9952
10227
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -10487,6 +10762,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10487
10762
|
* @throws {RequiredError}
|
|
10488
10763
|
*/
|
|
10489
10764
|
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10765
|
+
/**
|
|
10766
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
10767
|
+
* @summary Retrieves the signed document or application form
|
|
10768
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
10769
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
10770
|
+
* @param {*} [options] Override http request option.
|
|
10771
|
+
* @throws {RequiredError}
|
|
10772
|
+
*/
|
|
10773
|
+
downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10490
10774
|
/**
|
|
10491
10775
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
10492
10776
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -11027,6 +11311,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11027
11311
|
* @throws {RequiredError}
|
|
11028
11312
|
*/
|
|
11029
11313
|
downloadMotionCaptureFrame(motionCaptureId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
11314
|
+
/**
|
|
11315
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
11316
|
+
* @summary Retrieves the signed document or application form
|
|
11317
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
11318
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
11319
|
+
* @param {*} [options] Override http request option.
|
|
11320
|
+
* @throws {RequiredError}
|
|
11321
|
+
*/
|
|
11322
|
+
downloadQesDocument(workflowRunId: string, fileId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
11030
11323
|
/**
|
|
11031
11324
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
11032
11325
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -11589,6 +11882,16 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11589
11882
|
* @memberof DefaultApi
|
|
11590
11883
|
*/
|
|
11591
11884
|
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11885
|
+
/**
|
|
11886
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
11887
|
+
* @summary Retrieves the signed document or application form
|
|
11888
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
11889
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
11890
|
+
* @param {*} [options] Override http request option.
|
|
11891
|
+
* @throws {RequiredError}
|
|
11892
|
+
* @memberof DefaultApi
|
|
11893
|
+
*/
|
|
11894
|
+
downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11592
11895
|
/**
|
|
11593
11896
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
11594
11897
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -12020,6 +12323,7 @@ export type ListWorkflowRunsSortEnum = typeof ListWorkflowRunsSortEnum[keyof typ
|
|
|
12020
12323
|
*/
|
|
12021
12324
|
export declare const UploadDocumentFileTypeEnum: {
|
|
12022
12325
|
readonly Jpg: "jpg";
|
|
12326
|
+
readonly Jpeg: "jpeg";
|
|
12023
12327
|
readonly Png: "png";
|
|
12024
12328
|
readonly Pdf: "pdf";
|
|
12025
12329
|
readonly UnknownDefaultOpenApi: "11184809";
|
package/dist/api.js
CHANGED
|
@@ -22,7 +22,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
25
|
+
exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WorkflowRunSharedLinkLanguageEnum = exports.WorkflowRunResponseStatusEnum = exports.WorkflowRunStatusEnum = exports.WebhookEventType = exports.WatchlistMonitorSharedReportNameEnum = exports.WatchlistMonitorBuilderReportNameEnum = exports.WatchlistMonitorReportNameEnum = exports.UsDrivingLicenceSharedGenderEnum = exports.UsDrivingLicenceSharedEyeColorCodeEnum = exports.UsDrivingLicenceSharedDocumentCategoryEnum = exports.UsDrivingLicenceBuilderGenderEnum = exports.UsDrivingLicenceBuilderEyeColorCodeEnum = exports.UsDrivingLicenceBuilderDocumentCategoryEnum = exports.ResultsFeedbackExpectedResultEnum = exports.ReportSubResult = exports.ReportStatus = exports.ReportResult = exports.ReportName = exports.RepeatAttemptsListRepeatAttemptsInnerResultEnum = exports.RepeatAttemptsListRepeatAttemptsInnerNamesEnum = exports.RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum = exports.ProofOfAddressPropertiesDocumentTypeEnum = exports.IdNumberTypeEnum = exports.ExtractionExtractedDataGenderEnum = exports.ExtractionDocumentClassificationSubtypeEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentTypes = exports.DocumentSharedSideEnum = exports.DocumentSharedFileTypeEnum = exports.DocumentPropertiesSecurityTierEnum = exports.DocumentPropertiesHasIssuanceConfirmationEnum = exports.DocumentPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentSideEnum = exports.DocumentFileTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum = exports.CountryCodes = exports.ConsentItemNameEnum = exports.CheckResponseResultEnum = exports.CheckResponseStatusEnum = exports.CheckResultEnum = exports.CheckStatusEnum = void 0;
|
|
26
|
+
exports.UploadDocumentSideEnum = exports.UploadDocumentFileTypeEnum = exports.ListWorkflowRunsSortEnum = exports.DefaultApi = void 0;
|
|
26
27
|
const axios_1 = require("axios");
|
|
27
28
|
// URLSearchParams not necessarily used
|
|
28
29
|
// @ts-ignore
|
|
@@ -372,6 +373,7 @@ exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = {
|
|
|
372
373
|
};
|
|
373
374
|
exports.DocumentFileTypeEnum = {
|
|
374
375
|
Jpg: 'jpg',
|
|
376
|
+
Jpeg: 'jpeg',
|
|
375
377
|
Png: 'png',
|
|
376
378
|
Pdf: 'pdf',
|
|
377
379
|
UnknownDefaultOpenApi: '11184809'
|
|
@@ -381,8 +383,33 @@ exports.DocumentSideEnum = {
|
|
|
381
383
|
Back: 'back',
|
|
382
384
|
UnknownDefaultOpenApi: '11184809'
|
|
383
385
|
};
|
|
386
|
+
exports.DocumentPropertiesNistIdentityEvidenceStrengthEnum = {
|
|
387
|
+
Superior: 'superior',
|
|
388
|
+
Strong: 'strong',
|
|
389
|
+
Fair: 'fair',
|
|
390
|
+
Weak: 'weak',
|
|
391
|
+
Unacceptable: 'unacceptable',
|
|
392
|
+
UnspecifiedIdentityEvidenceStrength: 'unspecified_identity_evidence_strength',
|
|
393
|
+
UnknownDefaultOpenApi: '11184809'
|
|
394
|
+
};
|
|
395
|
+
exports.DocumentPropertiesHasIssuanceConfirmationEnum = {
|
|
396
|
+
True: 'true',
|
|
397
|
+
False: 'false',
|
|
398
|
+
Unspecified: 'unspecified',
|
|
399
|
+
UnknownDefaultOpenApi: '11184809'
|
|
400
|
+
};
|
|
401
|
+
exports.DocumentPropertiesSecurityTierEnum = {
|
|
402
|
+
Tier1: 'tier_1',
|
|
403
|
+
Tier2: 'tier_2',
|
|
404
|
+
Tier3: 'tier_3',
|
|
405
|
+
Tier4: 'tier_4',
|
|
406
|
+
Tier5: 'tier_5',
|
|
407
|
+
UnspecifiedSecurityTier: 'unspecified_security_tier',
|
|
408
|
+
UnknownDefaultOpenApi: '11184809'
|
|
409
|
+
};
|
|
384
410
|
exports.DocumentSharedFileTypeEnum = {
|
|
385
411
|
Jpg: 'jpg',
|
|
412
|
+
Jpeg: 'jpeg',
|
|
386
413
|
Png: 'png',
|
|
387
414
|
Pdf: 'pdf',
|
|
388
415
|
UnknownDefaultOpenApi: '11184809'
|
|
@@ -425,6 +452,30 @@ exports.DocumentTypes = {
|
|
|
425
452
|
InternationalDrivingLicence: 'international_driving_licence',
|
|
426
453
|
UnknownDefaultOpenApi: '11184809'
|
|
427
454
|
};
|
|
455
|
+
exports.DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = {
|
|
456
|
+
Superior: 'superior',
|
|
457
|
+
Strong: 'strong',
|
|
458
|
+
Fair: 'fair',
|
|
459
|
+
Weak: 'weak',
|
|
460
|
+
Unacceptable: 'unacceptable',
|
|
461
|
+
UnspecifiedIdentityEvidenceStrength: 'unspecified_identity_evidence_strength',
|
|
462
|
+
UnknownDefaultOpenApi: '11184809'
|
|
463
|
+
};
|
|
464
|
+
exports.DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = {
|
|
465
|
+
True: 'true',
|
|
466
|
+
False: 'false',
|
|
467
|
+
Unspecified: 'unspecified',
|
|
468
|
+
UnknownDefaultOpenApi: '11184809'
|
|
469
|
+
};
|
|
470
|
+
exports.DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = {
|
|
471
|
+
Tier1: 'tier_1',
|
|
472
|
+
Tier2: 'tier_2',
|
|
473
|
+
Tier3: 'tier_3',
|
|
474
|
+
Tier4: 'tier_4',
|
|
475
|
+
Tier5: 'tier_5',
|
|
476
|
+
UnspecifiedSecurityTier: 'unspecified_security_tier',
|
|
477
|
+
UnknownDefaultOpenApi: '11184809'
|
|
478
|
+
};
|
|
428
479
|
exports.ExtractionDocumentClassificationSubtypeEnum = {
|
|
429
480
|
Full: 'full',
|
|
430
481
|
NotFull: 'not_full',
|
|
@@ -1303,6 +1354,45 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1303
1354
|
options: localVarRequestOptions,
|
|
1304
1355
|
};
|
|
1305
1356
|
}),
|
|
1357
|
+
/**
|
|
1358
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
1359
|
+
* @summary Retrieves the signed document or application form
|
|
1360
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
1361
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
1362
|
+
* @param {*} [options] Override http request option.
|
|
1363
|
+
* @throws {RequiredError}
|
|
1364
|
+
*/
|
|
1365
|
+
downloadQesDocument: (workflowRunId, fileId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1366
|
+
// verify required parameter 'workflowRunId' is not null or undefined
|
|
1367
|
+
(0, common_1.assertParamExists)('downloadQesDocument', 'workflowRunId', workflowRunId);
|
|
1368
|
+
// verify required parameter 'fileId' is not null or undefined
|
|
1369
|
+
(0, common_1.assertParamExists)('downloadQesDocument', 'fileId', fileId);
|
|
1370
|
+
const localVarPath = `/qualified_electronic_signature/documents`;
|
|
1371
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1372
|
+
const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1373
|
+
let baseOptions;
|
|
1374
|
+
if (configuration) {
|
|
1375
|
+
baseOptions = configuration.baseOptions;
|
|
1376
|
+
}
|
|
1377
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1378
|
+
const localVarHeaderParameter = {};
|
|
1379
|
+
const localVarQueryParameter = {};
|
|
1380
|
+
// authentication Token required
|
|
1381
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1382
|
+
if (workflowRunId !== undefined) {
|
|
1383
|
+
localVarQueryParameter['workflow_run_id'] = workflowRunId;
|
|
1384
|
+
}
|
|
1385
|
+
if (fileId !== undefined) {
|
|
1386
|
+
localVarQueryParameter['file_id'] = fileId;
|
|
1387
|
+
}
|
|
1388
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1389
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1390
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1391
|
+
return {
|
|
1392
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1393
|
+
options: localVarRequestOptions,
|
|
1394
|
+
};
|
|
1395
|
+
}),
|
|
1306
1396
|
/**
|
|
1307
1397
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
1308
1398
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -3123,6 +3213,23 @@ const DefaultApiFp = function (configuration) {
|
|
|
3123
3213
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3124
3214
|
});
|
|
3125
3215
|
},
|
|
3216
|
+
/**
|
|
3217
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
3218
|
+
* @summary Retrieves the signed document or application form
|
|
3219
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
3220
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
3221
|
+
* @param {*} [options] Override http request option.
|
|
3222
|
+
* @throws {RequiredError}
|
|
3223
|
+
*/
|
|
3224
|
+
downloadQesDocument(workflowRunId, fileId, options) {
|
|
3225
|
+
var _a, _b, _c;
|
|
3226
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3227
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadQesDocument(workflowRunId, fileId, options);
|
|
3228
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3229
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.downloadQesDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3230
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3231
|
+
});
|
|
3232
|
+
},
|
|
3126
3233
|
/**
|
|
3127
3234
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
3128
3235
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -4059,6 +4166,17 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
4059
4166
|
downloadMotionCaptureFrame(motionCaptureId, options) {
|
|
4060
4167
|
return localVarFp.downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(axios, basePath));
|
|
4061
4168
|
},
|
|
4169
|
+
/**
|
|
4170
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
4171
|
+
* @summary Retrieves the signed document or application form
|
|
4172
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
4173
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
4174
|
+
* @param {*} [options] Override http request option.
|
|
4175
|
+
* @throws {RequiredError}
|
|
4176
|
+
*/
|
|
4177
|
+
downloadQesDocument(workflowRunId, fileId, options) {
|
|
4178
|
+
return localVarFp.downloadQesDocument(workflowRunId, fileId, options).then((request) => request(axios, basePath));
|
|
4179
|
+
},
|
|
4062
4180
|
/**
|
|
4063
4181
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
4064
4182
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -4751,6 +4869,18 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
4751
4869
|
downloadMotionCaptureFrame(motionCaptureId, options) {
|
|
4752
4870
|
return (0, exports.DefaultApiFp)(this.configuration).downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(this.axios, this.basePath));
|
|
4753
4871
|
}
|
|
4872
|
+
/**
|
|
4873
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
4874
|
+
* @summary Retrieves the signed document or application form
|
|
4875
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
4876
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
4877
|
+
* @param {*} [options] Override http request option.
|
|
4878
|
+
* @throws {RequiredError}
|
|
4879
|
+
* @memberof DefaultApi
|
|
4880
|
+
*/
|
|
4881
|
+
downloadQesDocument(workflowRunId, fileId, options) {
|
|
4882
|
+
return (0, exports.DefaultApiFp)(this.configuration).downloadQesDocument(workflowRunId, fileId, options).then((request) => request(this.axios, this.basePath));
|
|
4883
|
+
}
|
|
4754
4884
|
/**
|
|
4755
4885
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
4756
4886
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -5270,6 +5400,7 @@ exports.ListWorkflowRunsSortEnum = {
|
|
|
5270
5400
|
*/
|
|
5271
5401
|
exports.UploadDocumentFileTypeEnum = {
|
|
5272
5402
|
Jpg: 'jpg',
|
|
5403
|
+
Jpeg: 'jpeg',
|
|
5273
5404
|
Png: 'png',
|
|
5274
5405
|
Pdf: 'pdf',
|
|
5275
5406
|
UnknownDefaultOpenApi: '11184809'
|
package/dist/configuration.js
CHANGED
|
@@ -32,7 +32,7 @@ class Configuration {
|
|
|
32
32
|
}
|
|
33
33
|
this.apiKey = 'Token token=' + param.apiToken;
|
|
34
34
|
this.basePath = param.basePath || base_1.BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
|
|
35
|
-
this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.
|
|
35
|
+
this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.3.0' }) });
|
|
36
36
|
this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
|
|
37
37
|
}
|
|
38
38
|
/**
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1766,6 +1766,7 @@ export interface Document {
|
|
|
1766
1766
|
}
|
|
1767
1767
|
export declare const DocumentFileTypeEnum: {
|
|
1768
1768
|
readonly Jpg: "jpg";
|
|
1769
|
+
readonly Jpeg: "jpeg";
|
|
1769
1770
|
readonly Png: "png";
|
|
1770
1771
|
readonly Pdf: "pdf";
|
|
1771
1772
|
readonly UnknownDefaultOpenApi: "11184809";
|
|
@@ -2805,6 +2806,12 @@ export interface DocumentProperties {
|
|
|
2805
2806
|
* @memberof DocumentProperties
|
|
2806
2807
|
*/
|
|
2807
2808
|
'date_of_expiry'?: string;
|
|
2809
|
+
/**
|
|
2810
|
+
*
|
|
2811
|
+
* @type {string}
|
|
2812
|
+
* @memberof DocumentProperties
|
|
2813
|
+
*/
|
|
2814
|
+
'personal_number'?: string;
|
|
2808
2815
|
/**
|
|
2809
2816
|
*
|
|
2810
2817
|
* @type {Array<DocumentPropertiesDocumentNumbersInner>}
|
|
@@ -2828,19 +2835,25 @@ export interface DocumentProperties {
|
|
|
2828
2835
|
* @type {string}
|
|
2829
2836
|
* @memberof DocumentProperties
|
|
2830
2837
|
*/
|
|
2831
|
-
'
|
|
2838
|
+
'middle_name'?: string;
|
|
2832
2839
|
/**
|
|
2833
2840
|
*
|
|
2834
2841
|
* @type {string}
|
|
2835
2842
|
* @memberof DocumentProperties
|
|
2836
2843
|
*/
|
|
2837
|
-
'
|
|
2844
|
+
'last_name'?: string;
|
|
2838
2845
|
/**
|
|
2839
2846
|
*
|
|
2840
2847
|
* @type {string}
|
|
2841
2848
|
* @memberof DocumentProperties
|
|
2842
2849
|
*/
|
|
2843
|
-
'
|
|
2850
|
+
'gender'?: string;
|
|
2851
|
+
/**
|
|
2852
|
+
*
|
|
2853
|
+
* @type {string}
|
|
2854
|
+
* @memberof DocumentProperties
|
|
2855
|
+
*/
|
|
2856
|
+
'issuing_country'?: string;
|
|
2844
2857
|
/**
|
|
2845
2858
|
*
|
|
2846
2859
|
* @type {string}
|
|
@@ -2919,12 +2932,102 @@ export interface DocumentProperties {
|
|
|
2919
2932
|
* @memberof DocumentProperties
|
|
2920
2933
|
*/
|
|
2921
2934
|
'issuing_authority'?: string;
|
|
2935
|
+
/**
|
|
2936
|
+
*
|
|
2937
|
+
* @type {string}
|
|
2938
|
+
* @memberof DocumentProperties
|
|
2939
|
+
*/
|
|
2940
|
+
'remarks'?: string;
|
|
2941
|
+
/**
|
|
2942
|
+
*
|
|
2943
|
+
* @type {string}
|
|
2944
|
+
* @memberof DocumentProperties
|
|
2945
|
+
*/
|
|
2946
|
+
'civil_state'?: string;
|
|
2947
|
+
/**
|
|
2948
|
+
*
|
|
2949
|
+
* @type {string}
|
|
2950
|
+
* @memberof DocumentProperties
|
|
2951
|
+
*/
|
|
2952
|
+
'expatriation'?: string;
|
|
2953
|
+
/**
|
|
2954
|
+
*
|
|
2955
|
+
* @type {string}
|
|
2956
|
+
* @memberof DocumentProperties
|
|
2957
|
+
*/
|
|
2958
|
+
'father_name'?: string;
|
|
2959
|
+
/**
|
|
2960
|
+
*
|
|
2961
|
+
* @type {string}
|
|
2962
|
+
* @memberof DocumentProperties
|
|
2963
|
+
*/
|
|
2964
|
+
'mother_name'?: string;
|
|
2965
|
+
/**
|
|
2966
|
+
*
|
|
2967
|
+
* @type {string}
|
|
2968
|
+
* @memberof DocumentProperties
|
|
2969
|
+
*/
|
|
2970
|
+
'religion'?: string;
|
|
2971
|
+
/**
|
|
2972
|
+
*
|
|
2973
|
+
* @type {string}
|
|
2974
|
+
* @memberof DocumentProperties
|
|
2975
|
+
*/
|
|
2976
|
+
'type_of_permit'?: string;
|
|
2977
|
+
/**
|
|
2978
|
+
*
|
|
2979
|
+
* @type {string}
|
|
2980
|
+
* @memberof DocumentProperties
|
|
2981
|
+
*/
|
|
2982
|
+
'version_number'?: string;
|
|
2983
|
+
/**
|
|
2984
|
+
*
|
|
2985
|
+
* @type {string}
|
|
2986
|
+
* @memberof DocumentProperties
|
|
2987
|
+
*/
|
|
2988
|
+
'document_subtype'?: string;
|
|
2989
|
+
/**
|
|
2990
|
+
*
|
|
2991
|
+
* @type {string}
|
|
2992
|
+
* @memberof DocumentProperties
|
|
2993
|
+
*/
|
|
2994
|
+
'profession'?: string;
|
|
2995
|
+
/**
|
|
2996
|
+
*
|
|
2997
|
+
* @type {string}
|
|
2998
|
+
* @memberof DocumentProperties
|
|
2999
|
+
*/
|
|
3000
|
+
'security_document_number'?: string;
|
|
3001
|
+
/**
|
|
3002
|
+
*
|
|
3003
|
+
* @type {string}
|
|
3004
|
+
* @memberof DocumentProperties
|
|
3005
|
+
*/
|
|
3006
|
+
'tax_number'?: string;
|
|
3007
|
+
/**
|
|
3008
|
+
*
|
|
3009
|
+
* @type {string}
|
|
3010
|
+
* @memberof DocumentProperties
|
|
3011
|
+
*/
|
|
3012
|
+
'nist_identity_evidence_strength'?: DocumentPropertiesNistIdentityEvidenceStrengthEnum;
|
|
3013
|
+
/**
|
|
3014
|
+
*
|
|
3015
|
+
* @type {string}
|
|
3016
|
+
* @memberof DocumentProperties
|
|
3017
|
+
*/
|
|
3018
|
+
'has_issuance_confirmation'?: DocumentPropertiesHasIssuanceConfirmationEnum;
|
|
2922
3019
|
/**
|
|
2923
3020
|
*
|
|
2924
3021
|
* @type {boolean}
|
|
2925
3022
|
* @memberof DocumentProperties
|
|
2926
3023
|
*/
|
|
2927
3024
|
'real_id_compliance'?: boolean;
|
|
3025
|
+
/**
|
|
3026
|
+
*
|
|
3027
|
+
* @type {string}
|
|
3028
|
+
* @memberof DocumentProperties
|
|
3029
|
+
*/
|
|
3030
|
+
'security_tier'?: DocumentPropertiesSecurityTierEnum;
|
|
2928
3031
|
/**
|
|
2929
3032
|
*
|
|
2930
3033
|
* @type {DocumentPropertiesAddressLines}
|
|
@@ -2962,6 +3065,33 @@ export interface DocumentProperties {
|
|
|
2962
3065
|
*/
|
|
2963
3066
|
'extracted_data'?: DocumentPropertiesExtractedData;
|
|
2964
3067
|
}
|
|
3068
|
+
export declare const DocumentPropertiesNistIdentityEvidenceStrengthEnum: {
|
|
3069
|
+
readonly Superior: "superior";
|
|
3070
|
+
readonly Strong: "strong";
|
|
3071
|
+
readonly Fair: "fair";
|
|
3072
|
+
readonly Weak: "weak";
|
|
3073
|
+
readonly Unacceptable: "unacceptable";
|
|
3074
|
+
readonly UnspecifiedIdentityEvidenceStrength: "unspecified_identity_evidence_strength";
|
|
3075
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
3076
|
+
};
|
|
3077
|
+
export type DocumentPropertiesNistIdentityEvidenceStrengthEnum = typeof DocumentPropertiesNistIdentityEvidenceStrengthEnum[keyof typeof DocumentPropertiesNistIdentityEvidenceStrengthEnum];
|
|
3078
|
+
export declare const DocumentPropertiesHasIssuanceConfirmationEnum: {
|
|
3079
|
+
readonly True: "true";
|
|
3080
|
+
readonly False: "false";
|
|
3081
|
+
readonly Unspecified: "unspecified";
|
|
3082
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
3083
|
+
};
|
|
3084
|
+
export type DocumentPropertiesHasIssuanceConfirmationEnum = typeof DocumentPropertiesHasIssuanceConfirmationEnum[keyof typeof DocumentPropertiesHasIssuanceConfirmationEnum];
|
|
3085
|
+
export declare const DocumentPropertiesSecurityTierEnum: {
|
|
3086
|
+
readonly Tier1: "tier_1";
|
|
3087
|
+
readonly Tier2: "tier_2";
|
|
3088
|
+
readonly Tier3: "tier_3";
|
|
3089
|
+
readonly Tier4: "tier_4";
|
|
3090
|
+
readonly Tier5: "tier_5";
|
|
3091
|
+
readonly UnspecifiedSecurityTier: "unspecified_security_tier";
|
|
3092
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
3093
|
+
};
|
|
3094
|
+
export type DocumentPropertiesSecurityTierEnum = typeof DocumentPropertiesSecurityTierEnum[keyof typeof DocumentPropertiesSecurityTierEnum];
|
|
2965
3095
|
/**
|
|
2966
3096
|
*
|
|
2967
3097
|
* @export
|
|
@@ -3568,6 +3698,7 @@ export interface DocumentShared {
|
|
|
3568
3698
|
}
|
|
3569
3699
|
export declare const DocumentSharedFileTypeEnum: {
|
|
3570
3700
|
readonly Jpg: "jpg";
|
|
3701
|
+
readonly Jpeg: "jpeg";
|
|
3571
3702
|
readonly Png: "png";
|
|
3572
3703
|
readonly Pdf: "pdf";
|
|
3573
3704
|
readonly UnknownDefaultOpenApi: "11184809";
|
|
@@ -3923,6 +4054,12 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
3923
4054
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
3924
4055
|
*/
|
|
3925
4056
|
'date_of_expiry'?: string;
|
|
4057
|
+
/**
|
|
4058
|
+
*
|
|
4059
|
+
* @type {string}
|
|
4060
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4061
|
+
*/
|
|
4062
|
+
'personal_number'?: string;
|
|
3926
4063
|
/**
|
|
3927
4064
|
*
|
|
3928
4065
|
* @type {Array<DocumentPropertiesDocumentNumbersInner>}
|
|
@@ -3946,19 +4083,25 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
3946
4083
|
* @type {string}
|
|
3947
4084
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
3948
4085
|
*/
|
|
3949
|
-
'
|
|
4086
|
+
'middle_name'?: string;
|
|
3950
4087
|
/**
|
|
3951
4088
|
*
|
|
3952
4089
|
* @type {string}
|
|
3953
4090
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
3954
4091
|
*/
|
|
3955
|
-
'
|
|
4092
|
+
'last_name'?: string;
|
|
3956
4093
|
/**
|
|
3957
4094
|
*
|
|
3958
4095
|
* @type {string}
|
|
3959
4096
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
3960
4097
|
*/
|
|
3961
|
-
'
|
|
4098
|
+
'gender'?: string;
|
|
4099
|
+
/**
|
|
4100
|
+
*
|
|
4101
|
+
* @type {string}
|
|
4102
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4103
|
+
*/
|
|
4104
|
+
'issuing_country'?: string;
|
|
3962
4105
|
/**
|
|
3963
4106
|
*
|
|
3964
4107
|
* @type {string}
|
|
@@ -4037,12 +4180,102 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
4037
4180
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4038
4181
|
*/
|
|
4039
4182
|
'issuing_authority'?: string;
|
|
4183
|
+
/**
|
|
4184
|
+
*
|
|
4185
|
+
* @type {string}
|
|
4186
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4187
|
+
*/
|
|
4188
|
+
'remarks'?: string;
|
|
4189
|
+
/**
|
|
4190
|
+
*
|
|
4191
|
+
* @type {string}
|
|
4192
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4193
|
+
*/
|
|
4194
|
+
'civil_state'?: string;
|
|
4195
|
+
/**
|
|
4196
|
+
*
|
|
4197
|
+
* @type {string}
|
|
4198
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4199
|
+
*/
|
|
4200
|
+
'expatriation'?: string;
|
|
4201
|
+
/**
|
|
4202
|
+
*
|
|
4203
|
+
* @type {string}
|
|
4204
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4205
|
+
*/
|
|
4206
|
+
'father_name'?: string;
|
|
4207
|
+
/**
|
|
4208
|
+
*
|
|
4209
|
+
* @type {string}
|
|
4210
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4211
|
+
*/
|
|
4212
|
+
'mother_name'?: string;
|
|
4213
|
+
/**
|
|
4214
|
+
*
|
|
4215
|
+
* @type {string}
|
|
4216
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4217
|
+
*/
|
|
4218
|
+
'religion'?: string;
|
|
4219
|
+
/**
|
|
4220
|
+
*
|
|
4221
|
+
* @type {string}
|
|
4222
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4223
|
+
*/
|
|
4224
|
+
'type_of_permit'?: string;
|
|
4225
|
+
/**
|
|
4226
|
+
*
|
|
4227
|
+
* @type {string}
|
|
4228
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4229
|
+
*/
|
|
4230
|
+
'version_number'?: string;
|
|
4231
|
+
/**
|
|
4232
|
+
*
|
|
4233
|
+
* @type {string}
|
|
4234
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4235
|
+
*/
|
|
4236
|
+
'document_subtype'?: string;
|
|
4237
|
+
/**
|
|
4238
|
+
*
|
|
4239
|
+
* @type {string}
|
|
4240
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4241
|
+
*/
|
|
4242
|
+
'profession'?: string;
|
|
4243
|
+
/**
|
|
4244
|
+
*
|
|
4245
|
+
* @type {string}
|
|
4246
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4247
|
+
*/
|
|
4248
|
+
'security_document_number'?: string;
|
|
4249
|
+
/**
|
|
4250
|
+
*
|
|
4251
|
+
* @type {string}
|
|
4252
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4253
|
+
*/
|
|
4254
|
+
'tax_number'?: string;
|
|
4255
|
+
/**
|
|
4256
|
+
*
|
|
4257
|
+
* @type {string}
|
|
4258
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4259
|
+
*/
|
|
4260
|
+
'nist_identity_evidence_strength'?: DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum;
|
|
4261
|
+
/**
|
|
4262
|
+
*
|
|
4263
|
+
* @type {string}
|
|
4264
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4265
|
+
*/
|
|
4266
|
+
'has_issuance_confirmation'?: DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum;
|
|
4040
4267
|
/**
|
|
4041
4268
|
*
|
|
4042
4269
|
* @type {boolean}
|
|
4043
4270
|
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4044
4271
|
*/
|
|
4045
4272
|
'real_id_compliance'?: boolean;
|
|
4273
|
+
/**
|
|
4274
|
+
*
|
|
4275
|
+
* @type {string}
|
|
4276
|
+
* @memberof DocumentWithDriverVerificationReportAllOfProperties
|
|
4277
|
+
*/
|
|
4278
|
+
'security_tier'?: DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum;
|
|
4046
4279
|
/**
|
|
4047
4280
|
*
|
|
4048
4281
|
* @type {DocumentPropertiesAddressLines}
|
|
@@ -4116,6 +4349,33 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
|
|
|
4116
4349
|
*/
|
|
4117
4350
|
'passenger_vehicle'?: DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle;
|
|
4118
4351
|
}
|
|
4352
|
+
export declare const DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum: {
|
|
4353
|
+
readonly Superior: "superior";
|
|
4354
|
+
readonly Strong: "strong";
|
|
4355
|
+
readonly Fair: "fair";
|
|
4356
|
+
readonly Weak: "weak";
|
|
4357
|
+
readonly Unacceptable: "unacceptable";
|
|
4358
|
+
readonly UnspecifiedIdentityEvidenceStrength: "unspecified_identity_evidence_strength";
|
|
4359
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
4360
|
+
};
|
|
4361
|
+
export type DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum];
|
|
4362
|
+
export declare const DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum: {
|
|
4363
|
+
readonly True: "true";
|
|
4364
|
+
readonly False: "false";
|
|
4365
|
+
readonly Unspecified: "unspecified";
|
|
4366
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
4367
|
+
};
|
|
4368
|
+
export type DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum];
|
|
4369
|
+
export declare const DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum: {
|
|
4370
|
+
readonly Tier1: "tier_1";
|
|
4371
|
+
readonly Tier2: "tier_2";
|
|
4372
|
+
readonly Tier3: "tier_3";
|
|
4373
|
+
readonly Tier4: "tier_4";
|
|
4374
|
+
readonly Tier5: "tier_5";
|
|
4375
|
+
readonly UnspecifiedSecurityTier: "unspecified_security_tier";
|
|
4376
|
+
readonly UnknownDefaultOpenApi: "11184809";
|
|
4377
|
+
};
|
|
4378
|
+
export type DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum];
|
|
4119
4379
|
/**
|
|
4120
4380
|
* Normalised data for passenger cars
|
|
4121
4381
|
* @export
|
|
@@ -9252,6 +9512,12 @@ export interface WebhookEventPayloadObject {
|
|
|
9252
9512
|
* @memberof WebhookEventPayloadObject
|
|
9253
9513
|
*/
|
|
9254
9514
|
'status'?: string;
|
|
9515
|
+
/**
|
|
9516
|
+
* The date and time when the operation was started, if available.
|
|
9517
|
+
* @type {string}
|
|
9518
|
+
* @memberof WebhookEventPayloadObject
|
|
9519
|
+
*/
|
|
9520
|
+
'started_at_iso8601'?: string;
|
|
9255
9521
|
/**
|
|
9256
9522
|
* The date and time when the operation was completed, if available.
|
|
9257
9523
|
* @type {string}
|
|
@@ -9947,6 +10213,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9947
10213
|
* @throws {RequiredError}
|
|
9948
10214
|
*/
|
|
9949
10215
|
downloadMotionCaptureFrame: (motionCaptureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10216
|
+
/**
|
|
10217
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
10218
|
+
* @summary Retrieves the signed document or application form
|
|
10219
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
10220
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
10221
|
+
* @param {*} [options] Override http request option.
|
|
10222
|
+
* @throws {RequiredError}
|
|
10223
|
+
*/
|
|
10224
|
+
downloadQesDocument: (workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9950
10225
|
/**
|
|
9951
10226
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
9952
10227
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -10487,6 +10762,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
10487
10762
|
* @throws {RequiredError}
|
|
10488
10763
|
*/
|
|
10489
10764
|
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10765
|
+
/**
|
|
10766
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
10767
|
+
* @summary Retrieves the signed document or application form
|
|
10768
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
10769
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
10770
|
+
* @param {*} [options] Override http request option.
|
|
10771
|
+
* @throws {RequiredError}
|
|
10772
|
+
*/
|
|
10773
|
+
downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
|
|
10490
10774
|
/**
|
|
10491
10775
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
10492
10776
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -11027,6 +11311,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
11027
11311
|
* @throws {RequiredError}
|
|
11028
11312
|
*/
|
|
11029
11313
|
downloadMotionCaptureFrame(motionCaptureId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
11314
|
+
/**
|
|
11315
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
11316
|
+
* @summary Retrieves the signed document or application form
|
|
11317
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
11318
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
11319
|
+
* @param {*} [options] Override http request option.
|
|
11320
|
+
* @throws {RequiredError}
|
|
11321
|
+
*/
|
|
11322
|
+
downloadQesDocument(workflowRunId: string, fileId: string, options?: any): AxiosPromise<FileTransfer>;
|
|
11030
11323
|
/**
|
|
11031
11324
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
11032
11325
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -11589,6 +11882,16 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
11589
11882
|
* @memberof DefaultApi
|
|
11590
11883
|
*/
|
|
11591
11884
|
downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11885
|
+
/**
|
|
11886
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
11887
|
+
* @summary Retrieves the signed document or application form
|
|
11888
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
11889
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
11890
|
+
* @param {*} [options] Override http request option.
|
|
11891
|
+
* @throws {RequiredError}
|
|
11892
|
+
* @memberof DefaultApi
|
|
11893
|
+
*/
|
|
11894
|
+
downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
|
|
11592
11895
|
/**
|
|
11593
11896
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
11594
11897
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -12020,6 +12323,7 @@ export type ListWorkflowRunsSortEnum = typeof ListWorkflowRunsSortEnum[keyof typ
|
|
|
12020
12323
|
*/
|
|
12021
12324
|
export declare const UploadDocumentFileTypeEnum: {
|
|
12022
12325
|
readonly Jpg: "jpg";
|
|
12326
|
+
readonly Jpeg: "jpeg";
|
|
12023
12327
|
readonly Png: "png";
|
|
12024
12328
|
readonly Pdf: "pdf";
|
|
12025
12329
|
readonly UnknownDefaultOpenApi: "11184809";
|
package/dist/esm/api.js
CHANGED
|
@@ -369,6 +369,7 @@ export const DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = {
|
|
|
369
369
|
};
|
|
370
370
|
export const DocumentFileTypeEnum = {
|
|
371
371
|
Jpg: 'jpg',
|
|
372
|
+
Jpeg: 'jpeg',
|
|
372
373
|
Png: 'png',
|
|
373
374
|
Pdf: 'pdf',
|
|
374
375
|
UnknownDefaultOpenApi: '11184809'
|
|
@@ -378,8 +379,33 @@ export const DocumentSideEnum = {
|
|
|
378
379
|
Back: 'back',
|
|
379
380
|
UnknownDefaultOpenApi: '11184809'
|
|
380
381
|
};
|
|
382
|
+
export const DocumentPropertiesNistIdentityEvidenceStrengthEnum = {
|
|
383
|
+
Superior: 'superior',
|
|
384
|
+
Strong: 'strong',
|
|
385
|
+
Fair: 'fair',
|
|
386
|
+
Weak: 'weak',
|
|
387
|
+
Unacceptable: 'unacceptable',
|
|
388
|
+
UnspecifiedIdentityEvidenceStrength: 'unspecified_identity_evidence_strength',
|
|
389
|
+
UnknownDefaultOpenApi: '11184809'
|
|
390
|
+
};
|
|
391
|
+
export const DocumentPropertiesHasIssuanceConfirmationEnum = {
|
|
392
|
+
True: 'true',
|
|
393
|
+
False: 'false',
|
|
394
|
+
Unspecified: 'unspecified',
|
|
395
|
+
UnknownDefaultOpenApi: '11184809'
|
|
396
|
+
};
|
|
397
|
+
export const DocumentPropertiesSecurityTierEnum = {
|
|
398
|
+
Tier1: 'tier_1',
|
|
399
|
+
Tier2: 'tier_2',
|
|
400
|
+
Tier3: 'tier_3',
|
|
401
|
+
Tier4: 'tier_4',
|
|
402
|
+
Tier5: 'tier_5',
|
|
403
|
+
UnspecifiedSecurityTier: 'unspecified_security_tier',
|
|
404
|
+
UnknownDefaultOpenApi: '11184809'
|
|
405
|
+
};
|
|
381
406
|
export const DocumentSharedFileTypeEnum = {
|
|
382
407
|
Jpg: 'jpg',
|
|
408
|
+
Jpeg: 'jpeg',
|
|
383
409
|
Png: 'png',
|
|
384
410
|
Pdf: 'pdf',
|
|
385
411
|
UnknownDefaultOpenApi: '11184809'
|
|
@@ -422,6 +448,30 @@ export const DocumentTypes = {
|
|
|
422
448
|
InternationalDrivingLicence: 'international_driving_licence',
|
|
423
449
|
UnknownDefaultOpenApi: '11184809'
|
|
424
450
|
};
|
|
451
|
+
export const DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = {
|
|
452
|
+
Superior: 'superior',
|
|
453
|
+
Strong: 'strong',
|
|
454
|
+
Fair: 'fair',
|
|
455
|
+
Weak: 'weak',
|
|
456
|
+
Unacceptable: 'unacceptable',
|
|
457
|
+
UnspecifiedIdentityEvidenceStrength: 'unspecified_identity_evidence_strength',
|
|
458
|
+
UnknownDefaultOpenApi: '11184809'
|
|
459
|
+
};
|
|
460
|
+
export const DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = {
|
|
461
|
+
True: 'true',
|
|
462
|
+
False: 'false',
|
|
463
|
+
Unspecified: 'unspecified',
|
|
464
|
+
UnknownDefaultOpenApi: '11184809'
|
|
465
|
+
};
|
|
466
|
+
export const DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = {
|
|
467
|
+
Tier1: 'tier_1',
|
|
468
|
+
Tier2: 'tier_2',
|
|
469
|
+
Tier3: 'tier_3',
|
|
470
|
+
Tier4: 'tier_4',
|
|
471
|
+
Tier5: 'tier_5',
|
|
472
|
+
UnspecifiedSecurityTier: 'unspecified_security_tier',
|
|
473
|
+
UnknownDefaultOpenApi: '11184809'
|
|
474
|
+
};
|
|
425
475
|
export const ExtractionDocumentClassificationSubtypeEnum = {
|
|
426
476
|
Full: 'full',
|
|
427
477
|
NotFull: 'not_full',
|
|
@@ -1300,6 +1350,45 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1300
1350
|
options: localVarRequestOptions,
|
|
1301
1351
|
};
|
|
1302
1352
|
}),
|
|
1353
|
+
/**
|
|
1354
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
1355
|
+
* @summary Retrieves the signed document or application form
|
|
1356
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
1357
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
1358
|
+
* @param {*} [options] Override http request option.
|
|
1359
|
+
* @throws {RequiredError}
|
|
1360
|
+
*/
|
|
1361
|
+
downloadQesDocument: (workflowRunId, fileId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1362
|
+
// verify required parameter 'workflowRunId' is not null or undefined
|
|
1363
|
+
assertParamExists('downloadQesDocument', 'workflowRunId', workflowRunId);
|
|
1364
|
+
// verify required parameter 'fileId' is not null or undefined
|
|
1365
|
+
assertParamExists('downloadQesDocument', 'fileId', fileId);
|
|
1366
|
+
const localVarPath = `/qualified_electronic_signature/documents`;
|
|
1367
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1368
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1369
|
+
let baseOptions;
|
|
1370
|
+
if (configuration) {
|
|
1371
|
+
baseOptions = configuration.baseOptions;
|
|
1372
|
+
}
|
|
1373
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1374
|
+
const localVarHeaderParameter = {};
|
|
1375
|
+
const localVarQueryParameter = {};
|
|
1376
|
+
// authentication Token required
|
|
1377
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1378
|
+
if (workflowRunId !== undefined) {
|
|
1379
|
+
localVarQueryParameter['workflow_run_id'] = workflowRunId;
|
|
1380
|
+
}
|
|
1381
|
+
if (fileId !== undefined) {
|
|
1382
|
+
localVarQueryParameter['file_id'] = fileId;
|
|
1383
|
+
}
|
|
1384
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1385
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1386
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1387
|
+
return {
|
|
1388
|
+
url: toPathString(localVarUrlObj),
|
|
1389
|
+
options: localVarRequestOptions,
|
|
1390
|
+
};
|
|
1391
|
+
}),
|
|
1303
1392
|
/**
|
|
1304
1393
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
1305
1394
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -3119,6 +3208,23 @@ export const DefaultApiFp = function (configuration) {
|
|
|
3119
3208
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3120
3209
|
});
|
|
3121
3210
|
},
|
|
3211
|
+
/**
|
|
3212
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
3213
|
+
* @summary Retrieves the signed document or application form
|
|
3214
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
3215
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
3216
|
+
* @param {*} [options] Override http request option.
|
|
3217
|
+
* @throws {RequiredError}
|
|
3218
|
+
*/
|
|
3219
|
+
downloadQesDocument(workflowRunId, fileId, options) {
|
|
3220
|
+
var _a, _b, _c;
|
|
3221
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3222
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadQesDocument(workflowRunId, fileId, options);
|
|
3223
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3224
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.downloadQesDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3225
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3226
|
+
});
|
|
3227
|
+
},
|
|
3122
3228
|
/**
|
|
3123
3229
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
3124
3230
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -4054,6 +4160,17 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
4054
4160
|
downloadMotionCaptureFrame(motionCaptureId, options) {
|
|
4055
4161
|
return localVarFp.downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(axios, basePath));
|
|
4056
4162
|
},
|
|
4163
|
+
/**
|
|
4164
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
4165
|
+
* @summary Retrieves the signed document or application form
|
|
4166
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
4167
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
4168
|
+
* @param {*} [options] Override http request option.
|
|
4169
|
+
* @throws {RequiredError}
|
|
4170
|
+
*/
|
|
4171
|
+
downloadQesDocument(workflowRunId, fileId, options) {
|
|
4172
|
+
return localVarFp.downloadQesDocument(workflowRunId, fileId, options).then((request) => request(axios, basePath));
|
|
4173
|
+
},
|
|
4057
4174
|
/**
|
|
4058
4175
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
4059
4176
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -4745,6 +4862,18 @@ export class DefaultApi extends BaseAPI {
|
|
|
4745
4862
|
downloadMotionCaptureFrame(motionCaptureId, options) {
|
|
4746
4863
|
return DefaultApiFp(this.configuration).downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(this.axios, this.basePath));
|
|
4747
4864
|
}
|
|
4865
|
+
/**
|
|
4866
|
+
* Retrieves the signed document or application form depending on the file_id provided.
|
|
4867
|
+
* @summary Retrieves the signed document or application form
|
|
4868
|
+
* @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
|
|
4869
|
+
* @param {string} fileId The unique identifier of the file which you want to retrieve.
|
|
4870
|
+
* @param {*} [options] Override http request option.
|
|
4871
|
+
* @throws {RequiredError}
|
|
4872
|
+
* @memberof DefaultApi
|
|
4873
|
+
*/
|
|
4874
|
+
downloadQesDocument(workflowRunId, fileId, options) {
|
|
4875
|
+
return DefaultApiFp(this.configuration).downloadQesDocument(workflowRunId, fileId, options).then((request) => request(this.axios, this.basePath));
|
|
4876
|
+
}
|
|
4748
4877
|
/**
|
|
4749
4878
|
* Retrieves the signed evidence file for the designated Workflow Run
|
|
4750
4879
|
* @summary Retrieve Workflow Run Evidence Summary File
|
|
@@ -5263,6 +5392,7 @@ export const ListWorkflowRunsSortEnum = {
|
|
|
5263
5392
|
*/
|
|
5264
5393
|
export const UploadDocumentFileTypeEnum = {
|
|
5265
5394
|
Jpg: 'jpg',
|
|
5395
|
+
Jpeg: 'jpeg',
|
|
5266
5396
|
Png: 'png',
|
|
5267
5397
|
Pdf: 'pdf',
|
|
5268
5398
|
UnknownDefaultOpenApi: '11184809'
|
|
@@ -29,7 +29,7 @@ export class Configuration {
|
|
|
29
29
|
}
|
|
30
30
|
this.apiKey = 'Token token=' + param.apiToken;
|
|
31
31
|
this.basePath = param.basePath || BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
|
|
32
|
-
this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.
|
|
32
|
+
this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.3.0' }) });
|
|
33
33
|
this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
|
|
34
34
|
}
|
|
35
35
|
/**
|