@onfido/api 4.1.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -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];
@@ -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.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
@@ -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];
@@ -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.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": "4.1.0",
3
+ "version": "4.2.0",
4
4
  "description": "Node.js library for the Onfido API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {