@onfido/api 3.1.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.
Files changed (8) hide show
  1. package/README.md +3 -0
  2. package/dist/api.d.ts +246 -0
  3. package/dist/api.js +50 -1
  4. package/dist/configuration.js +1 -1
  5. package/dist/esm/api.d.ts +246 -0
  6. package/dist/esm/api.js +48 -0
  7. package/dist/esm/configuration.js +1 -1
  8. 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
+ [![npm version](https://badge.fury.io/js/@onfido%2Fapi.svg)](https://badge.fury.io/js/@onfido%2Fapi)
12
+ ![Build Status](https://github.com/onfido/onfido-node/actions/workflows/node.yml/badge.svg)
13
+
11
14
  ## Installation & Usage
12
15
 
13
16
  ### Installation
package/dist/api.d.ts CHANGED
@@ -2805,6 +2805,12 @@ export interface DocumentProperties {
2805
2805
  * @memberof DocumentProperties
2806
2806
  */
2807
2807
  'date_of_expiry'?: string;
2808
+ /**
2809
+ *
2810
+ * @type {string}
2811
+ * @memberof DocumentProperties
2812
+ */
2813
+ 'personal_number'?: string;
2808
2814
  /**
2809
2815
  *
2810
2816
  * @type {Array<DocumentPropertiesDocumentNumbersInner>}
@@ -2919,12 +2925,102 @@ export interface DocumentProperties {
2919
2925
  * @memberof DocumentProperties
2920
2926
  */
2921
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;
2922
3012
  /**
2923
3013
  *
2924
3014
  * @type {boolean}
2925
3015
  * @memberof DocumentProperties
2926
3016
  */
2927
3017
  'real_id_compliance'?: boolean;
3018
+ /**
3019
+ *
3020
+ * @type {string}
3021
+ * @memberof DocumentProperties
3022
+ */
3023
+ 'security_tier'?: DocumentPropertiesSecurityTierEnum;
2928
3024
  /**
2929
3025
  *
2930
3026
  * @type {DocumentPropertiesAddressLines}
@@ -2962,6 +3058,33 @@ export interface DocumentProperties {
2962
3058
  */
2963
3059
  'extracted_data'?: DocumentPropertiesExtractedData;
2964
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];
2965
3088
  /**
2966
3089
  *
2967
3090
  * @export
@@ -3923,6 +4046,12 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
3923
4046
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
3924
4047
  */
3925
4048
  'date_of_expiry'?: string;
4049
+ /**
4050
+ *
4051
+ * @type {string}
4052
+ * @memberof DocumentWithDriverVerificationReportAllOfProperties
4053
+ */
4054
+ 'personal_number'?: string;
3926
4055
  /**
3927
4056
  *
3928
4057
  * @type {Array<DocumentPropertiesDocumentNumbersInner>}
@@ -4037,12 +4166,102 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4037
4166
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4038
4167
  */
4039
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;
4040
4253
  /**
4041
4254
  *
4042
4255
  * @type {boolean}
4043
4256
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4044
4257
  */
4045
4258
  'real_id_compliance'?: boolean;
4259
+ /**
4260
+ *
4261
+ * @type {string}
4262
+ * @memberof DocumentWithDriverVerificationReportAllOfProperties
4263
+ */
4264
+ 'security_tier'?: DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum;
4046
4265
  /**
4047
4266
  *
4048
4267
  * @type {DocumentPropertiesAddressLines}
@@ -4116,6 +4335,33 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4116
4335
  */
4117
4336
  'passenger_vehicle'?: DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle;
4118
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];
4119
4365
  /**
4120
4366
  * Normalised data for passenger cars
4121
4367
  * @export
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.UploadDocumentSideEnum = exports.UploadDocumentFileTypeEnum = exports.ListWorkflowRunsSortEnum = exports.DefaultApi = 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.DocumentTypes = exports.DocumentSharedSideEnum = exports.DocumentSharedFileTypeEnum = 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;
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
@@ -381,6 +382,30 @@ exports.DocumentSideEnum = {
381
382
  Back: 'back',
382
383
  UnknownDefaultOpenApi: '11184809'
383
384
  };
385
+ exports.DocumentPropertiesNistIdentityEvidenceStrengthEnum = {
386
+ Superior: 'superior',
387
+ Strong: 'strong',
388
+ Fair: 'fair',
389
+ Weak: 'weak',
390
+ Unacceptable: 'unacceptable',
391
+ UnspecifiedIdentityEvidenceStrength: 'unspecified_identity_evidence_strength',
392
+ UnknownDefaultOpenApi: '11184809'
393
+ };
394
+ exports.DocumentPropertiesHasIssuanceConfirmationEnum = {
395
+ True: 'true',
396
+ False: 'false',
397
+ Unspecified: 'unspecified',
398
+ UnknownDefaultOpenApi: '11184809'
399
+ };
400
+ exports.DocumentPropertiesSecurityTierEnum = {
401
+ Tier1: 'tier_1',
402
+ Tier2: 'tier_2',
403
+ Tier3: 'tier_3',
404
+ Tier4: 'tier_4',
405
+ Tier5: 'tier_5',
406
+ UnspecifiedSecurityTier: 'unspecified_security_tier',
407
+ UnknownDefaultOpenApi: '11184809'
408
+ };
384
409
  exports.DocumentSharedFileTypeEnum = {
385
410
  Jpg: 'jpg',
386
411
  Png: 'png',
@@ -425,6 +450,30 @@ exports.DocumentTypes = {
425
450
  InternationalDrivingLicence: 'international_driving_licence',
426
451
  UnknownDefaultOpenApi: '11184809'
427
452
  };
453
+ exports.DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = {
454
+ Superior: 'superior',
455
+ Strong: 'strong',
456
+ Fair: 'fair',
457
+ Weak: 'weak',
458
+ Unacceptable: 'unacceptable',
459
+ UnspecifiedIdentityEvidenceStrength: 'unspecified_identity_evidence_strength',
460
+ UnknownDefaultOpenApi: '11184809'
461
+ };
462
+ exports.DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = {
463
+ True: 'true',
464
+ False: 'false',
465
+ Unspecified: 'unspecified',
466
+ UnknownDefaultOpenApi: '11184809'
467
+ };
468
+ exports.DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = {
469
+ Tier1: 'tier_1',
470
+ Tier2: 'tier_2',
471
+ Tier3: 'tier_3',
472
+ Tier4: 'tier_4',
473
+ Tier5: 'tier_5',
474
+ UnspecifiedSecurityTier: 'unspecified_security_tier',
475
+ UnknownDefaultOpenApi: '11184809'
476
+ };
428
477
  exports.ExtractionDocumentClassificationSubtypeEnum = {
429
478
  Full: 'full',
430
479
  NotFull: 'not_full',
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.1.0' }) });
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.2.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
@@ -2805,6 +2805,12 @@ export interface DocumentProperties {
2805
2805
  * @memberof DocumentProperties
2806
2806
  */
2807
2807
  'date_of_expiry'?: string;
2808
+ /**
2809
+ *
2810
+ * @type {string}
2811
+ * @memberof DocumentProperties
2812
+ */
2813
+ 'personal_number'?: string;
2808
2814
  /**
2809
2815
  *
2810
2816
  * @type {Array<DocumentPropertiesDocumentNumbersInner>}
@@ -2919,12 +2925,102 @@ export interface DocumentProperties {
2919
2925
  * @memberof DocumentProperties
2920
2926
  */
2921
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;
2922
3012
  /**
2923
3013
  *
2924
3014
  * @type {boolean}
2925
3015
  * @memberof DocumentProperties
2926
3016
  */
2927
3017
  'real_id_compliance'?: boolean;
3018
+ /**
3019
+ *
3020
+ * @type {string}
3021
+ * @memberof DocumentProperties
3022
+ */
3023
+ 'security_tier'?: DocumentPropertiesSecurityTierEnum;
2928
3024
  /**
2929
3025
  *
2930
3026
  * @type {DocumentPropertiesAddressLines}
@@ -2962,6 +3058,33 @@ export interface DocumentProperties {
2962
3058
  */
2963
3059
  'extracted_data'?: DocumentPropertiesExtractedData;
2964
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];
2965
3088
  /**
2966
3089
  *
2967
3090
  * @export
@@ -3923,6 +4046,12 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
3923
4046
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
3924
4047
  */
3925
4048
  'date_of_expiry'?: string;
4049
+ /**
4050
+ *
4051
+ * @type {string}
4052
+ * @memberof DocumentWithDriverVerificationReportAllOfProperties
4053
+ */
4054
+ 'personal_number'?: string;
3926
4055
  /**
3927
4056
  *
3928
4057
  * @type {Array<DocumentPropertiesDocumentNumbersInner>}
@@ -4037,12 +4166,102 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4037
4166
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4038
4167
  */
4039
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;
4040
4253
  /**
4041
4254
  *
4042
4255
  * @type {boolean}
4043
4256
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4044
4257
  */
4045
4258
  'real_id_compliance'?: boolean;
4259
+ /**
4260
+ *
4261
+ * @type {string}
4262
+ * @memberof DocumentWithDriverVerificationReportAllOfProperties
4263
+ */
4264
+ 'security_tier'?: DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum;
4046
4265
  /**
4047
4266
  *
4048
4267
  * @type {DocumentPropertiesAddressLines}
@@ -4116,6 +4335,33 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4116
4335
  */
4117
4336
  'passenger_vehicle'?: DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle;
4118
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];
4119
4365
  /**
4120
4366
  * Normalised data for passenger cars
4121
4367
  * @export
package/dist/esm/api.js CHANGED
@@ -378,6 +378,30 @@ export const DocumentSideEnum = {
378
378
  Back: 'back',
379
379
  UnknownDefaultOpenApi: '11184809'
380
380
  };
381
+ export const DocumentPropertiesNistIdentityEvidenceStrengthEnum = {
382
+ Superior: 'superior',
383
+ Strong: 'strong',
384
+ Fair: 'fair',
385
+ Weak: 'weak',
386
+ Unacceptable: 'unacceptable',
387
+ UnspecifiedIdentityEvidenceStrength: 'unspecified_identity_evidence_strength',
388
+ UnknownDefaultOpenApi: '11184809'
389
+ };
390
+ export const DocumentPropertiesHasIssuanceConfirmationEnum = {
391
+ True: 'true',
392
+ False: 'false',
393
+ Unspecified: 'unspecified',
394
+ UnknownDefaultOpenApi: '11184809'
395
+ };
396
+ export const DocumentPropertiesSecurityTierEnum = {
397
+ Tier1: 'tier_1',
398
+ Tier2: 'tier_2',
399
+ Tier3: 'tier_3',
400
+ Tier4: 'tier_4',
401
+ Tier5: 'tier_5',
402
+ UnspecifiedSecurityTier: 'unspecified_security_tier',
403
+ UnknownDefaultOpenApi: '11184809'
404
+ };
381
405
  export const DocumentSharedFileTypeEnum = {
382
406
  Jpg: 'jpg',
383
407
  Png: 'png',
@@ -422,6 +446,30 @@ export const DocumentTypes = {
422
446
  InternationalDrivingLicence: 'international_driving_licence',
423
447
  UnknownDefaultOpenApi: '11184809'
424
448
  };
449
+ export const DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = {
450
+ Superior: 'superior',
451
+ Strong: 'strong',
452
+ Fair: 'fair',
453
+ Weak: 'weak',
454
+ Unacceptable: 'unacceptable',
455
+ UnspecifiedIdentityEvidenceStrength: 'unspecified_identity_evidence_strength',
456
+ UnknownDefaultOpenApi: '11184809'
457
+ };
458
+ export const DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = {
459
+ True: 'true',
460
+ False: 'false',
461
+ Unspecified: 'unspecified',
462
+ UnknownDefaultOpenApi: '11184809'
463
+ };
464
+ export const DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = {
465
+ Tier1: 'tier_1',
466
+ Tier2: 'tier_2',
467
+ Tier3: 'tier_3',
468
+ Tier4: 'tier_4',
469
+ Tier5: 'tier_5',
470
+ UnspecifiedSecurityTier: 'unspecified_security_tier',
471
+ UnknownDefaultOpenApi: '11184809'
472
+ };
425
473
  export const ExtractionDocumentClassificationSubtypeEnum = {
426
474
  Full: 'full',
427
475
  NotFull: 'not_full',
package/dist/esm/configuration.js CHANGED
@@ -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.1.0' }) });
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.2.0' }) });
33
33
  this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
34
34
  }
35
35
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onfido/api",
3
- "version": "3.1.0",
3
+ "version": "3.2.0",
4
4
  "description": "Node.js library for the Onfido API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {