@onfido/api 4.1.0 → 4.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/dist/api.d.ts CHANGED
@@ -3022,10 +3022,10 @@ export interface DocumentProperties {
3022
3022
  'address_lines'?: DocumentPropertiesAddressLines;
3023
3023
  /**
3024
3024
  *
3025
- * @type {DocumentPropertiesBarcode}
3025
+ * @type {Array<DocumentPropertiesBarcodeInner>}
3026
3026
  * @memberof DocumentProperties
3027
3027
  */
3028
- 'barcode'?: DocumentPropertiesBarcode;
3028
+ 'barcode'?: Array<DocumentPropertiesBarcodeInner>;
3029
3029
  /**
3030
3030
  *
3031
3031
  * @type {DocumentPropertiesNfc}
@@ -3124,115 +3124,115 @@ export interface DocumentPropertiesAddressLines {
3124
3124
  /**
3125
3125
  *
3126
3126
  * @export
3127
- * @interface DocumentPropertiesBarcode
3127
+ * @interface DocumentPropertiesBarcodeInner
3128
3128
  */
3129
- export interface DocumentPropertiesBarcode {
3129
+ export interface DocumentPropertiesBarcodeInner {
3130
3130
  /**
3131
3131
  *
3132
3132
  * @type {string}
3133
- * @memberof DocumentPropertiesBarcode
3133
+ * @memberof DocumentPropertiesBarcodeInner
3134
3134
  */
3135
3135
  'first_name'?: string;
3136
3136
  /**
3137
3137
  *
3138
3138
  * @type {string}
3139
- * @memberof DocumentPropertiesBarcode
3139
+ * @memberof DocumentPropertiesBarcodeInner
3140
3140
  */
3141
3141
  'middle_name'?: string;
3142
3142
  /**
3143
3143
  *
3144
3144
  * @type {string}
3145
- * @memberof DocumentPropertiesBarcode
3145
+ * @memberof DocumentPropertiesBarcodeInner
3146
3146
  */
3147
3147
  'last_name'?: string;
3148
3148
  /**
3149
3149
  *
3150
3150
  * @type {string}
3151
- * @memberof DocumentPropertiesBarcode
3151
+ * @memberof DocumentPropertiesBarcodeInner
3152
3152
  */
3153
3153
  'document_type'?: string;
3154
3154
  /**
3155
3155
  *
3156
3156
  * @type {string}
3157
- * @memberof DocumentPropertiesBarcode
3157
+ * @memberof DocumentPropertiesBarcodeInner
3158
3158
  */
3159
3159
  'date_of_expiry'?: string;
3160
3160
  /**
3161
3161
  *
3162
3162
  * @type {string}
3163
- * @memberof DocumentPropertiesBarcode
3163
+ * @memberof DocumentPropertiesBarcodeInner
3164
3164
  */
3165
3165
  'date_of_birth'?: string;
3166
3166
  /**
3167
3167
  *
3168
3168
  * @type {string}
3169
- * @memberof DocumentPropertiesBarcode
3169
+ * @memberof DocumentPropertiesBarcodeInner
3170
3170
  */
3171
3171
  'issuing_date'?: string;
3172
3172
  /**
3173
3173
  *
3174
3174
  * @type {string}
3175
- * @memberof DocumentPropertiesBarcode
3175
+ * @memberof DocumentPropertiesBarcodeInner
3176
3176
  */
3177
3177
  'address_line_1'?: string;
3178
3178
  /**
3179
3179
  *
3180
3180
  * @type {string}
3181
- * @memberof DocumentPropertiesBarcode
3181
+ * @memberof DocumentPropertiesBarcodeInner
3182
3182
  */
3183
3183
  'address_line_2'?: string;
3184
3184
  /**
3185
3185
  *
3186
3186
  * @type {string}
3187
- * @memberof DocumentPropertiesBarcode
3187
+ * @memberof DocumentPropertiesBarcodeInner
3188
3188
  */
3189
3189
  'address_line_3'?: string;
3190
3190
  /**
3191
3191
  *
3192
3192
  * @type {string}
3193
- * @memberof DocumentPropertiesBarcode
3193
+ * @memberof DocumentPropertiesBarcodeInner
3194
3194
  */
3195
3195
  'address_line_4'?: string;
3196
3196
  /**
3197
3197
  *
3198
3198
  * @type {string}
3199
- * @memberof DocumentPropertiesBarcode
3199
+ * @memberof DocumentPropertiesBarcodeInner
3200
3200
  */
3201
3201
  'address_line_5'?: string;
3202
3202
  /**
3203
3203
  *
3204
3204
  * @type {string}
3205
- * @memberof DocumentPropertiesBarcode
3205
+ * @memberof DocumentPropertiesBarcodeInner
3206
3206
  */
3207
3207
  'issuing_state'?: string;
3208
3208
  /**
3209
3209
  *
3210
3210
  * @type {string}
3211
- * @memberof DocumentPropertiesBarcode
3211
+ * @memberof DocumentPropertiesBarcodeInner
3212
3212
  */
3213
3213
  'class'?: string;
3214
3214
  /**
3215
3215
  *
3216
3216
  * @type {string}
3217
- * @memberof DocumentPropertiesBarcode
3217
+ * @memberof DocumentPropertiesBarcodeInner
3218
3218
  */
3219
3219
  'gender'?: string;
3220
3220
  /**
3221
3221
  *
3222
3222
  * @type {string}
3223
- * @memberof DocumentPropertiesBarcode
3223
+ * @memberof DocumentPropertiesBarcodeInner
3224
3224
  */
3225
3225
  'issuing_country'?: string;
3226
3226
  /**
3227
3227
  *
3228
3228
  * @type {string}
3229
- * @memberof DocumentPropertiesBarcode
3229
+ * @memberof DocumentPropertiesBarcodeInner
3230
3230
  */
3231
3231
  'document_number'?: string;
3232
3232
  /**
3233
3233
  *
3234
3234
  * @type {string}
3235
- * @memberof DocumentPropertiesBarcode
3235
+ * @memberof DocumentPropertiesBarcodeInner
3236
3236
  */
3237
3237
  'real_id_classification'?: string;
3238
3238
  }
@@ -3732,6 +3732,52 @@ export declare const DocumentTypes: {
3732
3732
  readonly VehicleRegistrationCertificate: "vehicle_registration_certificate";
3733
3733
  readonly FormForAffixingTheVisa: "form_for_affixing_the_visa";
3734
3734
  readonly IdentificationNumberDocument: "identification_number_document";
3735
+ readonly AdoptionCertificate: "adoption_certificate";
3736
+ readonly BankBuildingSocietyStatement: "bank_building_society_statement";
3737
+ readonly BankStatement: "bank_statement";
3738
+ readonly BenefitLetters: "benefit_letters";
3739
+ readonly Cbt: "cbt";
3740
+ readonly CertificateOfSponsorship: "certificate_of_sponsorship";
3741
+ readonly CharacterReference: "character_reference";
3742
+ readonly CivilPartnershipCertificate: "civil_partnership_certificate";
3743
+ readonly CouncilTax: "council_tax";
3744
+ readonly CreditCardStatement: "credit_card_statement";
3745
+ readonly DeedPoll: "deed_poll";
3746
+ readonly DivorceAbsoluteDecree: "divorce_absolute_decree";
3747
+ readonly EducationalStatement: "educational_statement";
3748
+ readonly ElectricityBill: "electricity_bill";
3749
+ readonly GasBill: "gas_bill";
3750
+ readonly GovernmentLetter: "government_letter";
3751
+ readonly InternetBill: "internet_bill";
3752
+ readonly MarriageCertificate: "marriage_certificate";
3753
+ readonly MotorcycleInsurance: "motorcycle_insurance";
3754
+ readonly NationalInsuranceCard: "national_insurance_card";
3755
+ readonly NaturalisationCertificate: "naturalisation_certificate";
3756
+ readonly NonUkDrivingLicence: "non_uk_driving_licence";
3757
+ readonly P45P60: "p45_p60";
3758
+ readonly Payslip: "payslip";
3759
+ readonly PhoneBill: "phone_bill";
3760
+ readonly ProfessionalIdentificationCard: "professional_identification_card";
3761
+ readonly RightToWorkShareCodeResult: "right_to_work_share_code_result";
3762
+ readonly StatementFact: "statement_fact";
3763
+ readonly T4StudentUniversityTermDatesEvidence: "t4_student_university_term_dates_evidence";
3764
+ readonly UkBiometricResidencePermit: "uk_biometric_residence_permit";
3765
+ readonly UkDrivingLicence: "uk_driving_licence";
3766
+ readonly Unknown: "unknown";
3767
+ readonly UtilityBill: "utility_bill";
3768
+ readonly UtilityBillElectric: "utility_bill_electric";
3769
+ readonly UtilityBillGas: "utility_bill_gas";
3770
+ readonly UtilityBillOther: "utility_bill_other";
3771
+ readonly WaterBill: "water_bill";
3772
+ readonly AddressCertificate: "address_certificate";
3773
+ readonly GeneralLetter: "general_letter";
3774
+ readonly InsuranceStatement: "insurance_statement";
3775
+ readonly PensionPropertyStatementLetter: "pension_property_statement_letter";
3776
+ readonly MortgageStatement: "mortgage_statement";
3777
+ readonly MobilePhoneBill: "mobile_phone_bill";
3778
+ readonly IdentityDocumentWithAddress: "identity_document_with_address";
3779
+ readonly ExchangeHouseStatement: "exchange_house_statement";
3780
+ readonly AccommodationTenancyCertificate: "accommodation_tenancy_certificate";
3735
3781
  readonly UnknownDefaultOpenApi: "11184809";
3736
3782
  };
3737
3783
  export type DocumentTypes = typeof DocumentTypes[keyof typeof DocumentTypes];
@@ -4275,10 +4321,10 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4275
4321
  'address_lines'?: DocumentPropertiesAddressLines;
4276
4322
  /**
4277
4323
  *
4278
- * @type {DocumentPropertiesBarcode}
4324
+ * @type {Array<DocumentPropertiesBarcodeInner>}
4279
4325
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4280
4326
  */
4281
- 'barcode'?: DocumentPropertiesBarcode;
4327
+ 'barcode'?: Array<DocumentPropertiesBarcodeInner>;
4282
4328
  /**
4283
4329
  *
4284
4330
  * @type {DocumentPropertiesNfc}
@@ -5081,6 +5127,30 @@ export interface FacialSimilarityMotionReport {
5081
5127
  * @memberof FacialSimilarityMotionReport
5082
5128
  */
5083
5129
  'name': ReportName;
5130
+ /**
5131
+ * Array of objects with live photo ids that were used in the Onfido engine.
5132
+ * @type {Array<FacialSimilarityReportMedia>}
5133
+ * @memberof FacialSimilarityMotionReport
5134
+ */
5135
+ 'live_photos'?: Array<FacialSimilarityReportMedia>;
5136
+ /**
5137
+ * Array of objects with live video ids that were used in the Onfido engine.
5138
+ * @type {Array<FacialSimilarityReportMedia>}
5139
+ * @memberof FacialSimilarityMotionReport
5140
+ */
5141
+ 'live_videos'?: Array<FacialSimilarityReportMedia>;
5142
+ /**
5143
+ * Array of objects with motion capture ids that were used in the Onfido engine.
5144
+ * @type {Array<FacialSimilarityReportMedia>}
5145
+ * @memberof FacialSimilarityMotionReport
5146
+ */
5147
+ 'motion_captures'?: Array<FacialSimilarityReportMedia>;
5148
+ /**
5149
+ * Array of objects with id photo ids that were used in the Onfido engine.
5150
+ * @type {Array<FacialSimilarityReportMedia>}
5151
+ * @memberof FacialSimilarityMotionReport
5152
+ */
5153
+ 'id_photos'?: Array<FacialSimilarityReportMedia>;
5084
5154
  /**
5085
5155
  *
5086
5156
  * @type {FacialSimilarityMotionBreakdown}
@@ -5484,6 +5554,30 @@ export interface FacialSimilarityPhotoFullyAutoReport {
5484
5554
  * @memberof FacialSimilarityPhotoFullyAutoReport
5485
5555
  */
5486
5556
  'name': ReportName;
5557
+ /**
5558
+ * Array of objects with live photo ids that were used in the Onfido engine.
5559
+ * @type {Array<FacialSimilarityReportMedia>}
5560
+ * @memberof FacialSimilarityPhotoFullyAutoReport
5561
+ */
5562
+ 'live_photos'?: Array<FacialSimilarityReportMedia>;
5563
+ /**
5564
+ * Array of objects with live video ids that were used in the Onfido engine.
5565
+ * @type {Array<FacialSimilarityReportMedia>}
5566
+ * @memberof FacialSimilarityPhotoFullyAutoReport
5567
+ */
5568
+ 'live_videos'?: Array<FacialSimilarityReportMedia>;
5569
+ /**
5570
+ * Array of objects with motion capture ids that were used in the Onfido engine.
5571
+ * @type {Array<FacialSimilarityReportMedia>}
5572
+ * @memberof FacialSimilarityPhotoFullyAutoReport
5573
+ */
5574
+ 'motion_captures'?: Array<FacialSimilarityReportMedia>;
5575
+ /**
5576
+ * Array of objects with id photo ids that were used in the Onfido engine.
5577
+ * @type {Array<FacialSimilarityReportMedia>}
5578
+ * @memberof FacialSimilarityPhotoFullyAutoReport
5579
+ */
5580
+ 'id_photos'?: Array<FacialSimilarityReportMedia>;
5487
5581
  /**
5488
5582
  *
5489
5583
  * @type {FacialSimilarityPhotoFullyAutoBreakdown}
@@ -5570,6 +5664,30 @@ export interface FacialSimilarityPhotoReport {
5570
5664
  * @memberof FacialSimilarityPhotoReport
5571
5665
  */
5572
5666
  'name': ReportName;
5667
+ /**
5668
+ * Array of objects with live photo ids that were used in the Onfido engine.
5669
+ * @type {Array<FacialSimilarityReportMedia>}
5670
+ * @memberof FacialSimilarityPhotoReport
5671
+ */
5672
+ 'live_photos'?: Array<FacialSimilarityReportMedia>;
5673
+ /**
5674
+ * Array of objects with live video ids that were used in the Onfido engine.
5675
+ * @type {Array<FacialSimilarityReportMedia>}
5676
+ * @memberof FacialSimilarityPhotoReport
5677
+ */
5678
+ 'live_videos'?: Array<FacialSimilarityReportMedia>;
5679
+ /**
5680
+ * Array of objects with motion capture ids that were used in the Onfido engine.
5681
+ * @type {Array<FacialSimilarityReportMedia>}
5682
+ * @memberof FacialSimilarityPhotoReport
5683
+ */
5684
+ 'motion_captures'?: Array<FacialSimilarityReportMedia>;
5685
+ /**
5686
+ * Array of objects with id photo ids that were used in the Onfido engine.
5687
+ * @type {Array<FacialSimilarityReportMedia>}
5688
+ * @memberof FacialSimilarityPhotoReport
5689
+ */
5690
+ 'id_photos'?: Array<FacialSimilarityReportMedia>;
5573
5691
  /**
5574
5692
  *
5575
5693
  * @type {FacialSimilarityPhotoBreakdown}
@@ -5583,6 +5701,50 @@ export interface FacialSimilarityPhotoReport {
5583
5701
  */
5584
5702
  'properties'?: FacialSimilarityPhotoProperties;
5585
5703
  }
5704
+ /**
5705
+ *
5706
+ * @export
5707
+ * @interface FacialSimilarityReportMedia
5708
+ */
5709
+ export interface FacialSimilarityReportMedia {
5710
+ /**
5711
+ * ID of uploaded biometric media to use.
5712
+ * @type {string}
5713
+ * @memberof FacialSimilarityReportMedia
5714
+ */
5715
+ 'id': string;
5716
+ }
5717
+ /**
5718
+ *
5719
+ * @export
5720
+ * @interface FacialSimilarityReportShared
5721
+ */
5722
+ export interface FacialSimilarityReportShared {
5723
+ /**
5724
+ * Array of objects with live photo ids that were used in the Onfido engine.
5725
+ * @type {Array<FacialSimilarityReportMedia>}
5726
+ * @memberof FacialSimilarityReportShared
5727
+ */
5728
+ 'live_photos'?: Array<FacialSimilarityReportMedia>;
5729
+ /**
5730
+ * Array of objects with live video ids that were used in the Onfido engine.
5731
+ * @type {Array<FacialSimilarityReportMedia>}
5732
+ * @memberof FacialSimilarityReportShared
5733
+ */
5734
+ 'live_videos'?: Array<FacialSimilarityReportMedia>;
5735
+ /**
5736
+ * Array of objects with motion capture ids that were used in the Onfido engine.
5737
+ * @type {Array<FacialSimilarityReportMedia>}
5738
+ * @memberof FacialSimilarityReportShared
5739
+ */
5740
+ 'motion_captures'?: Array<FacialSimilarityReportMedia>;
5741
+ /**
5742
+ * Array of objects with id photo ids that were used in the Onfido engine.
5743
+ * @type {Array<FacialSimilarityReportMedia>}
5744
+ * @memberof FacialSimilarityReportShared
5745
+ */
5746
+ 'id_photos'?: Array<FacialSimilarityReportMedia>;
5747
+ }
5586
5748
  /**
5587
5749
  *
5588
5750
  * @export
@@ -5852,6 +6014,30 @@ export interface FacialSimilarityVideoReport {
5852
6014
  * @memberof FacialSimilarityVideoReport
5853
6015
  */
5854
6016
  'name': ReportName;
6017
+ /**
6018
+ * Array of objects with live photo ids that were used in the Onfido engine.
6019
+ * @type {Array<FacialSimilarityReportMedia>}
6020
+ * @memberof FacialSimilarityVideoReport
6021
+ */
6022
+ 'live_photos'?: Array<FacialSimilarityReportMedia>;
6023
+ /**
6024
+ * Array of objects with live video ids that were used in the Onfido engine.
6025
+ * @type {Array<FacialSimilarityReportMedia>}
6026
+ * @memberof FacialSimilarityVideoReport
6027
+ */
6028
+ 'live_videos'?: Array<FacialSimilarityReportMedia>;
6029
+ /**
6030
+ * Array of objects with motion capture ids that were used in the Onfido engine.
6031
+ * @type {Array<FacialSimilarityReportMedia>}
6032
+ * @memberof FacialSimilarityVideoReport
6033
+ */
6034
+ 'motion_captures'?: Array<FacialSimilarityReportMedia>;
6035
+ /**
6036
+ * Array of objects with id photo ids that were used in the Onfido engine.
6037
+ * @type {Array<FacialSimilarityReportMedia>}
6038
+ * @memberof FacialSimilarityVideoReport
6039
+ */
6040
+ 'id_photos'?: Array<FacialSimilarityReportMedia>;
5855
6041
  /**
5856
6042
  *
5857
6043
  * @type {FacialSimilarityVideoBreakdown}
package/dist/api.js CHANGED
@@ -456,6 +456,52 @@ exports.DocumentTypes = {
456
456
  VehicleRegistrationCertificate: 'vehicle_registration_certificate',
457
457
  FormForAffixingTheVisa: 'form_for_affixing_the_visa',
458
458
  IdentificationNumberDocument: 'identification_number_document',
459
+ AdoptionCertificate: 'adoption_certificate',
460
+ BankBuildingSocietyStatement: 'bank_building_society_statement',
461
+ BankStatement: 'bank_statement',
462
+ BenefitLetters: 'benefit_letters',
463
+ Cbt: 'cbt',
464
+ CertificateOfSponsorship: 'certificate_of_sponsorship',
465
+ CharacterReference: 'character_reference',
466
+ CivilPartnershipCertificate: 'civil_partnership_certificate',
467
+ CouncilTax: 'council_tax',
468
+ CreditCardStatement: 'credit_card_statement',
469
+ DeedPoll: 'deed_poll',
470
+ DivorceAbsoluteDecree: 'divorce_absolute_decree',
471
+ EducationalStatement: 'educational_statement',
472
+ ElectricityBill: 'electricity_bill',
473
+ GasBill: 'gas_bill',
474
+ GovernmentLetter: 'government_letter',
475
+ InternetBill: 'internet_bill',
476
+ MarriageCertificate: 'marriage_certificate',
477
+ MotorcycleInsurance: 'motorcycle_insurance',
478
+ NationalInsuranceCard: 'national_insurance_card',
479
+ NaturalisationCertificate: 'naturalisation_certificate',
480
+ NonUkDrivingLicence: 'non_uk_driving_licence',
481
+ P45P60: 'p45_p60',
482
+ Payslip: 'payslip',
483
+ PhoneBill: 'phone_bill',
484
+ ProfessionalIdentificationCard: 'professional_identification_card',
485
+ RightToWorkShareCodeResult: 'right_to_work_share_code_result',
486
+ StatementFact: 'statement_fact',
487
+ T4StudentUniversityTermDatesEvidence: 't4_student_university_term_dates_evidence',
488
+ UkBiometricResidencePermit: 'uk_biometric_residence_permit',
489
+ UkDrivingLicence: 'uk_driving_licence',
490
+ Unknown: 'unknown',
491
+ UtilityBill: 'utility_bill',
492
+ UtilityBillElectric: 'utility_bill_electric',
493
+ UtilityBillGas: 'utility_bill_gas',
494
+ UtilityBillOther: 'utility_bill_other',
495
+ WaterBill: 'water_bill',
496
+ AddressCertificate: 'address_certificate',
497
+ GeneralLetter: 'general_letter',
498
+ InsuranceStatement: 'insurance_statement',
499
+ PensionPropertyStatementLetter: 'pension_property_statement_letter',
500
+ MortgageStatement: 'mortgage_statement',
501
+ MobilePhoneBill: 'mobile_phone_bill',
502
+ IdentityDocumentWithAddress: 'identity_document_with_address',
503
+ ExchangeHouseStatement: 'exchange_house_statement',
504
+ AccommodationTenancyCertificate: 'accommodation_tenancy_certificate',
459
505
  UnknownDefaultOpenApi: '11184809'
460
506
  };
461
507
  exports.DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = {
@@ -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/4.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/4.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
@@ -3022,10 +3022,10 @@ export interface DocumentProperties {
3022
3022
  'address_lines'?: DocumentPropertiesAddressLines;
3023
3023
  /**
3024
3024
  *
3025
- * @type {DocumentPropertiesBarcode}
3025
+ * @type {Array<DocumentPropertiesBarcodeInner>}
3026
3026
  * @memberof DocumentProperties
3027
3027
  */
3028
- 'barcode'?: DocumentPropertiesBarcode;
3028
+ 'barcode'?: Array<DocumentPropertiesBarcodeInner>;
3029
3029
  /**
3030
3030
  *
3031
3031
  * @type {DocumentPropertiesNfc}
@@ -3124,115 +3124,115 @@ export interface DocumentPropertiesAddressLines {
3124
3124
  /**
3125
3125
  *
3126
3126
  * @export
3127
- * @interface DocumentPropertiesBarcode
3127
+ * @interface DocumentPropertiesBarcodeInner
3128
3128
  */
3129
- export interface DocumentPropertiesBarcode {
3129
+ export interface DocumentPropertiesBarcodeInner {
3130
3130
  /**
3131
3131
  *
3132
3132
  * @type {string}
3133
- * @memberof DocumentPropertiesBarcode
3133
+ * @memberof DocumentPropertiesBarcodeInner
3134
3134
  */
3135
3135
  'first_name'?: string;
3136
3136
  /**
3137
3137
  *
3138
3138
  * @type {string}
3139
- * @memberof DocumentPropertiesBarcode
3139
+ * @memberof DocumentPropertiesBarcodeInner
3140
3140
  */
3141
3141
  'middle_name'?: string;
3142
3142
  /**
3143
3143
  *
3144
3144
  * @type {string}
3145
- * @memberof DocumentPropertiesBarcode
3145
+ * @memberof DocumentPropertiesBarcodeInner
3146
3146
  */
3147
3147
  'last_name'?: string;
3148
3148
  /**
3149
3149
  *
3150
3150
  * @type {string}
3151
- * @memberof DocumentPropertiesBarcode
3151
+ * @memberof DocumentPropertiesBarcodeInner
3152
3152
  */
3153
3153
  'document_type'?: string;
3154
3154
  /**
3155
3155
  *
3156
3156
  * @type {string}
3157
- * @memberof DocumentPropertiesBarcode
3157
+ * @memberof DocumentPropertiesBarcodeInner
3158
3158
  */
3159
3159
  'date_of_expiry'?: string;
3160
3160
  /**
3161
3161
  *
3162
3162
  * @type {string}
3163
- * @memberof DocumentPropertiesBarcode
3163
+ * @memberof DocumentPropertiesBarcodeInner
3164
3164
  */
3165
3165
  'date_of_birth'?: string;
3166
3166
  /**
3167
3167
  *
3168
3168
  * @type {string}
3169
- * @memberof DocumentPropertiesBarcode
3169
+ * @memberof DocumentPropertiesBarcodeInner
3170
3170
  */
3171
3171
  'issuing_date'?: string;
3172
3172
  /**
3173
3173
  *
3174
3174
  * @type {string}
3175
- * @memberof DocumentPropertiesBarcode
3175
+ * @memberof DocumentPropertiesBarcodeInner
3176
3176
  */
3177
3177
  'address_line_1'?: string;
3178
3178
  /**
3179
3179
  *
3180
3180
  * @type {string}
3181
- * @memberof DocumentPropertiesBarcode
3181
+ * @memberof DocumentPropertiesBarcodeInner
3182
3182
  */
3183
3183
  'address_line_2'?: string;
3184
3184
  /**
3185
3185
  *
3186
3186
  * @type {string}
3187
- * @memberof DocumentPropertiesBarcode
3187
+ * @memberof DocumentPropertiesBarcodeInner
3188
3188
  */
3189
3189
  'address_line_3'?: string;
3190
3190
  /**
3191
3191
  *
3192
3192
  * @type {string}
3193
- * @memberof DocumentPropertiesBarcode
3193
+ * @memberof DocumentPropertiesBarcodeInner
3194
3194
  */
3195
3195
  'address_line_4'?: string;
3196
3196
  /**
3197
3197
  *
3198
3198
  * @type {string}
3199
- * @memberof DocumentPropertiesBarcode
3199
+ * @memberof DocumentPropertiesBarcodeInner
3200
3200
  */
3201
3201
  'address_line_5'?: string;
3202
3202
  /**
3203
3203
  *
3204
3204
  * @type {string}
3205
- * @memberof DocumentPropertiesBarcode
3205
+ * @memberof DocumentPropertiesBarcodeInner
3206
3206
  */
3207
3207
  'issuing_state'?: string;
3208
3208
  /**
3209
3209
  *
3210
3210
  * @type {string}
3211
- * @memberof DocumentPropertiesBarcode
3211
+ * @memberof DocumentPropertiesBarcodeInner
3212
3212
  */
3213
3213
  'class'?: string;
3214
3214
  /**
3215
3215
  *
3216
3216
  * @type {string}
3217
- * @memberof DocumentPropertiesBarcode
3217
+ * @memberof DocumentPropertiesBarcodeInner
3218
3218
  */
3219
3219
  'gender'?: string;
3220
3220
  /**
3221
3221
  *
3222
3222
  * @type {string}
3223
- * @memberof DocumentPropertiesBarcode
3223
+ * @memberof DocumentPropertiesBarcodeInner
3224
3224
  */
3225
3225
  'issuing_country'?: string;
3226
3226
  /**
3227
3227
  *
3228
3228
  * @type {string}
3229
- * @memberof DocumentPropertiesBarcode
3229
+ * @memberof DocumentPropertiesBarcodeInner
3230
3230
  */
3231
3231
  'document_number'?: string;
3232
3232
  /**
3233
3233
  *
3234
3234
  * @type {string}
3235
- * @memberof DocumentPropertiesBarcode
3235
+ * @memberof DocumentPropertiesBarcodeInner
3236
3236
  */
3237
3237
  'real_id_classification'?: string;
3238
3238
  }
@@ -3732,6 +3732,52 @@ export declare const DocumentTypes: {
3732
3732
  readonly VehicleRegistrationCertificate: "vehicle_registration_certificate";
3733
3733
  readonly FormForAffixingTheVisa: "form_for_affixing_the_visa";
3734
3734
  readonly IdentificationNumberDocument: "identification_number_document";
3735
+ readonly AdoptionCertificate: "adoption_certificate";
3736
+ readonly BankBuildingSocietyStatement: "bank_building_society_statement";
3737
+ readonly BankStatement: "bank_statement";
3738
+ readonly BenefitLetters: "benefit_letters";
3739
+ readonly Cbt: "cbt";
3740
+ readonly CertificateOfSponsorship: "certificate_of_sponsorship";
3741
+ readonly CharacterReference: "character_reference";
3742
+ readonly CivilPartnershipCertificate: "civil_partnership_certificate";
3743
+ readonly CouncilTax: "council_tax";
3744
+ readonly CreditCardStatement: "credit_card_statement";
3745
+ readonly DeedPoll: "deed_poll";
3746
+ readonly DivorceAbsoluteDecree: "divorce_absolute_decree";
3747
+ readonly EducationalStatement: "educational_statement";
3748
+ readonly ElectricityBill: "electricity_bill";
3749
+ readonly GasBill: "gas_bill";
3750
+ readonly GovernmentLetter: "government_letter";
3751
+ readonly InternetBill: "internet_bill";
3752
+ readonly MarriageCertificate: "marriage_certificate";
3753
+ readonly MotorcycleInsurance: "motorcycle_insurance";
3754
+ readonly NationalInsuranceCard: "national_insurance_card";
3755
+ readonly NaturalisationCertificate: "naturalisation_certificate";
3756
+ readonly NonUkDrivingLicence: "non_uk_driving_licence";
3757
+ readonly P45P60: "p45_p60";
3758
+ readonly Payslip: "payslip";
3759
+ readonly PhoneBill: "phone_bill";
3760
+ readonly ProfessionalIdentificationCard: "professional_identification_card";
3761
+ readonly RightToWorkShareCodeResult: "right_to_work_share_code_result";
3762
+ readonly StatementFact: "statement_fact";
3763
+ readonly T4StudentUniversityTermDatesEvidence: "t4_student_university_term_dates_evidence";
3764
+ readonly UkBiometricResidencePermit: "uk_biometric_residence_permit";
3765
+ readonly UkDrivingLicence: "uk_driving_licence";
3766
+ readonly Unknown: "unknown";
3767
+ readonly UtilityBill: "utility_bill";
3768
+ readonly UtilityBillElectric: "utility_bill_electric";
3769
+ readonly UtilityBillGas: "utility_bill_gas";
3770
+ readonly UtilityBillOther: "utility_bill_other";
3771
+ readonly WaterBill: "water_bill";
3772
+ readonly AddressCertificate: "address_certificate";
3773
+ readonly GeneralLetter: "general_letter";
3774
+ readonly InsuranceStatement: "insurance_statement";
3775
+ readonly PensionPropertyStatementLetter: "pension_property_statement_letter";
3776
+ readonly MortgageStatement: "mortgage_statement";
3777
+ readonly MobilePhoneBill: "mobile_phone_bill";
3778
+ readonly IdentityDocumentWithAddress: "identity_document_with_address";
3779
+ readonly ExchangeHouseStatement: "exchange_house_statement";
3780
+ readonly AccommodationTenancyCertificate: "accommodation_tenancy_certificate";
3735
3781
  readonly UnknownDefaultOpenApi: "11184809";
3736
3782
  };
3737
3783
  export type DocumentTypes = typeof DocumentTypes[keyof typeof DocumentTypes];
@@ -4275,10 +4321,10 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4275
4321
  'address_lines'?: DocumentPropertiesAddressLines;
4276
4322
  /**
4277
4323
  *
4278
- * @type {DocumentPropertiesBarcode}
4324
+ * @type {Array<DocumentPropertiesBarcodeInner>}
4279
4325
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4280
4326
  */
4281
- 'barcode'?: DocumentPropertiesBarcode;
4327
+ 'barcode'?: Array<DocumentPropertiesBarcodeInner>;
4282
4328
  /**
4283
4329
  *
4284
4330
  * @type {DocumentPropertiesNfc}
@@ -5081,6 +5127,30 @@ export interface FacialSimilarityMotionReport {
5081
5127
  * @memberof FacialSimilarityMotionReport
5082
5128
  */
5083
5129
  'name': ReportName;
5130
+ /**
5131
+ * Array of objects with live photo ids that were used in the Onfido engine.
5132
+ * @type {Array<FacialSimilarityReportMedia>}
5133
+ * @memberof FacialSimilarityMotionReport
5134
+ */
5135
+ 'live_photos'?: Array<FacialSimilarityReportMedia>;
5136
+ /**
5137
+ * Array of objects with live video ids that were used in the Onfido engine.
5138
+ * @type {Array<FacialSimilarityReportMedia>}
5139
+ * @memberof FacialSimilarityMotionReport
5140
+ */
5141
+ 'live_videos'?: Array<FacialSimilarityReportMedia>;
5142
+ /**
5143
+ * Array of objects with motion capture ids that were used in the Onfido engine.
5144
+ * @type {Array<FacialSimilarityReportMedia>}
5145
+ * @memberof FacialSimilarityMotionReport
5146
+ */
5147
+ 'motion_captures'?: Array<FacialSimilarityReportMedia>;
5148
+ /**
5149
+ * Array of objects with id photo ids that were used in the Onfido engine.
5150
+ * @type {Array<FacialSimilarityReportMedia>}
5151
+ * @memberof FacialSimilarityMotionReport
5152
+ */
5153
+ 'id_photos'?: Array<FacialSimilarityReportMedia>;
5084
5154
  /**
5085
5155
  *
5086
5156
  * @type {FacialSimilarityMotionBreakdown}
@@ -5484,6 +5554,30 @@ export interface FacialSimilarityPhotoFullyAutoReport {
5484
5554
  * @memberof FacialSimilarityPhotoFullyAutoReport
5485
5555
  */
5486
5556
  'name': ReportName;
5557
+ /**
5558
+ * Array of objects with live photo ids that were used in the Onfido engine.
5559
+ * @type {Array<FacialSimilarityReportMedia>}
5560
+ * @memberof FacialSimilarityPhotoFullyAutoReport
5561
+ */
5562
+ 'live_photos'?: Array<FacialSimilarityReportMedia>;
5563
+ /**
5564
+ * Array of objects with live video ids that were used in the Onfido engine.
5565
+ * @type {Array<FacialSimilarityReportMedia>}
5566
+ * @memberof FacialSimilarityPhotoFullyAutoReport
5567
+ */
5568
+ 'live_videos'?: Array<FacialSimilarityReportMedia>;
5569
+ /**
5570
+ * Array of objects with motion capture ids that were used in the Onfido engine.
5571
+ * @type {Array<FacialSimilarityReportMedia>}
5572
+ * @memberof FacialSimilarityPhotoFullyAutoReport
5573
+ */
5574
+ 'motion_captures'?: Array<FacialSimilarityReportMedia>;
5575
+ /**
5576
+ * Array of objects with id photo ids that were used in the Onfido engine.
5577
+ * @type {Array<FacialSimilarityReportMedia>}
5578
+ * @memberof FacialSimilarityPhotoFullyAutoReport
5579
+ */
5580
+ 'id_photos'?: Array<FacialSimilarityReportMedia>;
5487
5581
  /**
5488
5582
  *
5489
5583
  * @type {FacialSimilarityPhotoFullyAutoBreakdown}
@@ -5570,6 +5664,30 @@ export interface FacialSimilarityPhotoReport {
5570
5664
  * @memberof FacialSimilarityPhotoReport
5571
5665
  */
5572
5666
  'name': ReportName;
5667
+ /**
5668
+ * Array of objects with live photo ids that were used in the Onfido engine.
5669
+ * @type {Array<FacialSimilarityReportMedia>}
5670
+ * @memberof FacialSimilarityPhotoReport
5671
+ */
5672
+ 'live_photos'?: Array<FacialSimilarityReportMedia>;
5673
+ /**
5674
+ * Array of objects with live video ids that were used in the Onfido engine.
5675
+ * @type {Array<FacialSimilarityReportMedia>}
5676
+ * @memberof FacialSimilarityPhotoReport
5677
+ */
5678
+ 'live_videos'?: Array<FacialSimilarityReportMedia>;
5679
+ /**
5680
+ * Array of objects with motion capture ids that were used in the Onfido engine.
5681
+ * @type {Array<FacialSimilarityReportMedia>}
5682
+ * @memberof FacialSimilarityPhotoReport
5683
+ */
5684
+ 'motion_captures'?: Array<FacialSimilarityReportMedia>;
5685
+ /**
5686
+ * Array of objects with id photo ids that were used in the Onfido engine.
5687
+ * @type {Array<FacialSimilarityReportMedia>}
5688
+ * @memberof FacialSimilarityPhotoReport
5689
+ */
5690
+ 'id_photos'?: Array<FacialSimilarityReportMedia>;
5573
5691
  /**
5574
5692
  *
5575
5693
  * @type {FacialSimilarityPhotoBreakdown}
@@ -5583,6 +5701,50 @@ export interface FacialSimilarityPhotoReport {
5583
5701
  */
5584
5702
  'properties'?: FacialSimilarityPhotoProperties;
5585
5703
  }
5704
+ /**
5705
+ *
5706
+ * @export
5707
+ * @interface FacialSimilarityReportMedia
5708
+ */
5709
+ export interface FacialSimilarityReportMedia {
5710
+ /**
5711
+ * ID of uploaded biometric media to use.
5712
+ * @type {string}
5713
+ * @memberof FacialSimilarityReportMedia
5714
+ */
5715
+ 'id': string;
5716
+ }
5717
+ /**
5718
+ *
5719
+ * @export
5720
+ * @interface FacialSimilarityReportShared
5721
+ */
5722
+ export interface FacialSimilarityReportShared {
5723
+ /**
5724
+ * Array of objects with live photo ids that were used in the Onfido engine.
5725
+ * @type {Array<FacialSimilarityReportMedia>}
5726
+ * @memberof FacialSimilarityReportShared
5727
+ */
5728
+ 'live_photos'?: Array<FacialSimilarityReportMedia>;
5729
+ /**
5730
+ * Array of objects with live video ids that were used in the Onfido engine.
5731
+ * @type {Array<FacialSimilarityReportMedia>}
5732
+ * @memberof FacialSimilarityReportShared
5733
+ */
5734
+ 'live_videos'?: Array<FacialSimilarityReportMedia>;
5735
+ /**
5736
+ * Array of objects with motion capture ids that were used in the Onfido engine.
5737
+ * @type {Array<FacialSimilarityReportMedia>}
5738
+ * @memberof FacialSimilarityReportShared
5739
+ */
5740
+ 'motion_captures'?: Array<FacialSimilarityReportMedia>;
5741
+ /**
5742
+ * Array of objects with id photo ids that were used in the Onfido engine.
5743
+ * @type {Array<FacialSimilarityReportMedia>}
5744
+ * @memberof FacialSimilarityReportShared
5745
+ */
5746
+ 'id_photos'?: Array<FacialSimilarityReportMedia>;
5747
+ }
5586
5748
  /**
5587
5749
  *
5588
5750
  * @export
@@ -5852,6 +6014,30 @@ export interface FacialSimilarityVideoReport {
5852
6014
  * @memberof FacialSimilarityVideoReport
5853
6015
  */
5854
6016
  'name': ReportName;
6017
+ /**
6018
+ * Array of objects with live photo ids that were used in the Onfido engine.
6019
+ * @type {Array<FacialSimilarityReportMedia>}
6020
+ * @memberof FacialSimilarityVideoReport
6021
+ */
6022
+ 'live_photos'?: Array<FacialSimilarityReportMedia>;
6023
+ /**
6024
+ * Array of objects with live video ids that were used in the Onfido engine.
6025
+ * @type {Array<FacialSimilarityReportMedia>}
6026
+ * @memberof FacialSimilarityVideoReport
6027
+ */
6028
+ 'live_videos'?: Array<FacialSimilarityReportMedia>;
6029
+ /**
6030
+ * Array of objects with motion capture ids that were used in the Onfido engine.
6031
+ * @type {Array<FacialSimilarityReportMedia>}
6032
+ * @memberof FacialSimilarityVideoReport
6033
+ */
6034
+ 'motion_captures'?: Array<FacialSimilarityReportMedia>;
6035
+ /**
6036
+ * Array of objects with id photo ids that were used in the Onfido engine.
6037
+ * @type {Array<FacialSimilarityReportMedia>}
6038
+ * @memberof FacialSimilarityVideoReport
6039
+ */
6040
+ 'id_photos'?: Array<FacialSimilarityReportMedia>;
5855
6041
  /**
5856
6042
  *
5857
6043
  * @type {FacialSimilarityVideoBreakdown}
package/dist/esm/api.js CHANGED
@@ -452,6 +452,52 @@ export const DocumentTypes = {
452
452
  VehicleRegistrationCertificate: 'vehicle_registration_certificate',
453
453
  FormForAffixingTheVisa: 'form_for_affixing_the_visa',
454
454
  IdentificationNumberDocument: 'identification_number_document',
455
+ AdoptionCertificate: 'adoption_certificate',
456
+ BankBuildingSocietyStatement: 'bank_building_society_statement',
457
+ BankStatement: 'bank_statement',
458
+ BenefitLetters: 'benefit_letters',
459
+ Cbt: 'cbt',
460
+ CertificateOfSponsorship: 'certificate_of_sponsorship',
461
+ CharacterReference: 'character_reference',
462
+ CivilPartnershipCertificate: 'civil_partnership_certificate',
463
+ CouncilTax: 'council_tax',
464
+ CreditCardStatement: 'credit_card_statement',
465
+ DeedPoll: 'deed_poll',
466
+ DivorceAbsoluteDecree: 'divorce_absolute_decree',
467
+ EducationalStatement: 'educational_statement',
468
+ ElectricityBill: 'electricity_bill',
469
+ GasBill: 'gas_bill',
470
+ GovernmentLetter: 'government_letter',
471
+ InternetBill: 'internet_bill',
472
+ MarriageCertificate: 'marriage_certificate',
473
+ MotorcycleInsurance: 'motorcycle_insurance',
474
+ NationalInsuranceCard: 'national_insurance_card',
475
+ NaturalisationCertificate: 'naturalisation_certificate',
476
+ NonUkDrivingLicence: 'non_uk_driving_licence',
477
+ P45P60: 'p45_p60',
478
+ Payslip: 'payslip',
479
+ PhoneBill: 'phone_bill',
480
+ ProfessionalIdentificationCard: 'professional_identification_card',
481
+ RightToWorkShareCodeResult: 'right_to_work_share_code_result',
482
+ StatementFact: 'statement_fact',
483
+ T4StudentUniversityTermDatesEvidence: 't4_student_university_term_dates_evidence',
484
+ UkBiometricResidencePermit: 'uk_biometric_residence_permit',
485
+ UkDrivingLicence: 'uk_driving_licence',
486
+ Unknown: 'unknown',
487
+ UtilityBill: 'utility_bill',
488
+ UtilityBillElectric: 'utility_bill_electric',
489
+ UtilityBillGas: 'utility_bill_gas',
490
+ UtilityBillOther: 'utility_bill_other',
491
+ WaterBill: 'water_bill',
492
+ AddressCertificate: 'address_certificate',
493
+ GeneralLetter: 'general_letter',
494
+ InsuranceStatement: 'insurance_statement',
495
+ PensionPropertyStatementLetter: 'pension_property_statement_letter',
496
+ MortgageStatement: 'mortgage_statement',
497
+ MobilePhoneBill: 'mobile_phone_bill',
498
+ IdentityDocumentWithAddress: 'identity_document_with_address',
499
+ ExchangeHouseStatement: 'exchange_house_statement',
500
+ AccommodationTenancyCertificate: 'accommodation_tenancy_certificate',
455
501
  UnknownDefaultOpenApi: '11184809'
456
502
  };
457
503
  export const DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = {
@@ -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/4.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/4.3.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": "4.1.0",
3
+ "version": "4.3.0",
4
4
  "description": "Node.js library for the Onfido API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {