@onfido/api 5.1.0 → 5.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.
Files changed (7) hide show
  1. package/dist/api.d.ts +70 -0
  2. package/dist/api.js +7 -2
  3. package/dist/configuration.js +1 -1
  4. package/dist/esm/api.d.ts +70 -0
  5. package/dist/esm/api.js +5 -0
  6. package/dist/esm/configuration.js +1 -1
  7. package/package.json +1 -1
package/dist/api.d.ts CHANGED
@@ -894,6 +894,13 @@ export interface CheckBuilder {
894
894
  * @memberof CheckBuilder
895
895
  */
896
896
  'us_driving_licence'?: UsDrivingLicenceBuilder;
897
+ /**
898
+ *
899
+ * @type {ReportConfiguration}
900
+ * @memberof CheckBuilder
901
+ * @deprecated
902
+ */
903
+ 'report_configuration'?: ReportConfiguration;
897
904
  }
898
905
  /**
899
906
  *
@@ -949,6 +956,13 @@ export interface CheckRequest {
949
956
  * @memberof CheckRequest
950
957
  */
951
958
  'us_driving_licence'?: UsDrivingLicenceBuilder;
959
+ /**
960
+ *
961
+ * @type {ReportConfiguration}
962
+ * @memberof CheckRequest
963
+ * @deprecated
964
+ */
965
+ 'report_configuration'?: ReportConfiguration;
952
966
  }
953
967
  /**
954
968
  *
@@ -4428,6 +4442,12 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4428
4442
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4429
4443
  */
4430
4444
  'raw_vehicle_classes'?: string;
4445
+ /**
4446
+ * True if the user is not qualified to drive a manual transmission
4447
+ * @type {boolean}
4448
+ * @memberof DocumentWithDriverVerificationReportAllOfProperties
4449
+ */
4450
+ 'manual_transmission_restriction'?: boolean;
4431
4451
  /**
4432
4452
  * Detailed classes/categories information
4433
4453
  * @type {Array<DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner>}
@@ -7792,6 +7812,56 @@ export type Report = {
7792
7812
  } & WatchlistSanctionsOnlyReport | {
7793
7813
  name: 'watchlist_standard';
7794
7814
  } & WatchlistStandardReport;
7815
+ /**
7816
+ * Defines configuration options for facial similarity checks used to distinguish between onboarding and reverification scenarios.
7817
+ * @export
7818
+ * @interface ReportConfiguration
7819
+ */
7820
+ export interface ReportConfiguration {
7821
+ /**
7822
+ *
7823
+ * @type {ReportConfigurationFacialSimilarity}
7824
+ * @memberof ReportConfiguration
7825
+ */
7826
+ 'facial_similarity_photo'?: ReportConfigurationFacialSimilarity;
7827
+ /**
7828
+ *
7829
+ * @type {ReportConfigurationFacialSimilarity}
7830
+ * @memberof ReportConfiguration
7831
+ */
7832
+ 'facial_similarity_photo_fully_auto'?: ReportConfigurationFacialSimilarity;
7833
+ /**
7834
+ *
7835
+ * @type {ReportConfigurationFacialSimilarity}
7836
+ * @memberof ReportConfiguration
7837
+ */
7838
+ 'facial_similarity_video'?: ReportConfigurationFacialSimilarity;
7839
+ /**
7840
+ *
7841
+ * @type {ReportConfigurationFacialSimilarity}
7842
+ * @memberof ReportConfiguration
7843
+ */
7844
+ 'facial_similarity_motion'?: ReportConfigurationFacialSimilarity;
7845
+ }
7846
+ /**
7847
+ *
7848
+ * @export
7849
+ * @interface ReportConfigurationFacialSimilarity
7850
+ */
7851
+ export interface ReportConfigurationFacialSimilarity {
7852
+ /**
7853
+ * You should set it to \"reverification\" on a post-onboarding scenario (e.g. ongoing authentication).
7854
+ * @type {string}
7855
+ * @memberof ReportConfigurationFacialSimilarity
7856
+ */
7857
+ 'use_case'?: ReportConfigurationFacialSimilarityUseCaseEnum;
7858
+ }
7859
+ export declare const ReportConfigurationFacialSimilarityUseCaseEnum: {
7860
+ readonly Onboarding: "onboarding";
7861
+ readonly Reverification: "reverification";
7862
+ readonly UnknownDefaultOpenApi: "11184809";
7863
+ };
7864
+ export type ReportConfigurationFacialSimilarityUseCaseEnum = typeof ReportConfigurationFacialSimilarityUseCaseEnum[keyof typeof ReportConfigurationFacialSimilarityUseCaseEnum];
7795
7865
  /**
7796
7866
  *
7797
7867
  * @export
package/dist/api.js CHANGED
@@ -22,8 +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.ListWorkflowRunsSortEnum = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WorkflowRunStatus = exports.WorkflowRunLinkLanguageEnum = exports.WebhookEventType = exports.WebhookEventResourceType = exports.WebhookEventObjectStatus = 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.DocumentPropertiesSecurityTierEnum = exports.DocumentPropertiesHasIssuanceConfirmationEnum = exports.DocumentPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentSideEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum = exports.CountryCodes = exports.CheckStatus = exports.CheckResponseResultEnum = exports.CheckResultEnum = exports.ApplicantConsentName = void 0;
26
- exports.UploadDocumentSideEnum = void 0;
25
+ exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WorkflowRunStatus = exports.WorkflowRunLinkLanguageEnum = exports.WebhookEventType = exports.WebhookEventResourceType = exports.WebhookEventObjectStatus = 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.ReportConfigurationFacialSimilarityUseCaseEnum = 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.DocumentPropertiesSecurityTierEnum = exports.DocumentPropertiesHasIssuanceConfirmationEnum = exports.DocumentPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentSideEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum = exports.CountryCodes = exports.CheckStatus = exports.CheckResponseResultEnum = exports.CheckResultEnum = exports.ApplicantConsentName = void 0;
26
+ exports.UploadDocumentSideEnum = exports.ListWorkflowRunsSortEnum = void 0;
27
27
  const axios_1 = require("axios");
28
28
  // URLSearchParams not necessarily used
29
29
  // @ts-ignore
@@ -567,6 +567,11 @@ exports.RepeatAttemptsListRepeatAttemptsInnerResultEnum = {
567
567
  Consider: 'consider',
568
568
  UnknownDefaultOpenApi: '11184809'
569
569
  };
570
+ exports.ReportConfigurationFacialSimilarityUseCaseEnum = {
571
+ Onboarding: 'onboarding',
572
+ Reverification: 'reverification',
573
+ UnknownDefaultOpenApi: '11184809'
574
+ };
570
575
  /**
571
576
  *
572
577
  * @export
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/5.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/5.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
@@ -894,6 +894,13 @@ export interface CheckBuilder {
894
894
  * @memberof CheckBuilder
895
895
  */
896
896
  'us_driving_licence'?: UsDrivingLicenceBuilder;
897
+ /**
898
+ *
899
+ * @type {ReportConfiguration}
900
+ * @memberof CheckBuilder
901
+ * @deprecated
902
+ */
903
+ 'report_configuration'?: ReportConfiguration;
897
904
  }
898
905
  /**
899
906
  *
@@ -949,6 +956,13 @@ export interface CheckRequest {
949
956
  * @memberof CheckRequest
950
957
  */
951
958
  'us_driving_licence'?: UsDrivingLicenceBuilder;
959
+ /**
960
+ *
961
+ * @type {ReportConfiguration}
962
+ * @memberof CheckRequest
963
+ * @deprecated
964
+ */
965
+ 'report_configuration'?: ReportConfiguration;
952
966
  }
953
967
  /**
954
968
  *
@@ -4428,6 +4442,12 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4428
4442
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4429
4443
  */
4430
4444
  'raw_vehicle_classes'?: string;
4445
+ /**
4446
+ * True if the user is not qualified to drive a manual transmission
4447
+ * @type {boolean}
4448
+ * @memberof DocumentWithDriverVerificationReportAllOfProperties
4449
+ */
4450
+ 'manual_transmission_restriction'?: boolean;
4431
4451
  /**
4432
4452
  * Detailed classes/categories information
4433
4453
  * @type {Array<DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner>}
@@ -7792,6 +7812,56 @@ export type Report = {
7792
7812
  } & WatchlistSanctionsOnlyReport | {
7793
7813
  name: 'watchlist_standard';
7794
7814
  } & WatchlistStandardReport;
7815
+ /**
7816
+ * Defines configuration options for facial similarity checks used to distinguish between onboarding and reverification scenarios.
7817
+ * @export
7818
+ * @interface ReportConfiguration
7819
+ */
7820
+ export interface ReportConfiguration {
7821
+ /**
7822
+ *
7823
+ * @type {ReportConfigurationFacialSimilarity}
7824
+ * @memberof ReportConfiguration
7825
+ */
7826
+ 'facial_similarity_photo'?: ReportConfigurationFacialSimilarity;
7827
+ /**
7828
+ *
7829
+ * @type {ReportConfigurationFacialSimilarity}
7830
+ * @memberof ReportConfiguration
7831
+ */
7832
+ 'facial_similarity_photo_fully_auto'?: ReportConfigurationFacialSimilarity;
7833
+ /**
7834
+ *
7835
+ * @type {ReportConfigurationFacialSimilarity}
7836
+ * @memberof ReportConfiguration
7837
+ */
7838
+ 'facial_similarity_video'?: ReportConfigurationFacialSimilarity;
7839
+ /**
7840
+ *
7841
+ * @type {ReportConfigurationFacialSimilarity}
7842
+ * @memberof ReportConfiguration
7843
+ */
7844
+ 'facial_similarity_motion'?: ReportConfigurationFacialSimilarity;
7845
+ }
7846
+ /**
7847
+ *
7848
+ * @export
7849
+ * @interface ReportConfigurationFacialSimilarity
7850
+ */
7851
+ export interface ReportConfigurationFacialSimilarity {
7852
+ /**
7853
+ * You should set it to \"reverification\" on a post-onboarding scenario (e.g. ongoing authentication).
7854
+ * @type {string}
7855
+ * @memberof ReportConfigurationFacialSimilarity
7856
+ */
7857
+ 'use_case'?: ReportConfigurationFacialSimilarityUseCaseEnum;
7858
+ }
7859
+ export declare const ReportConfigurationFacialSimilarityUseCaseEnum: {
7860
+ readonly Onboarding: "onboarding";
7861
+ readonly Reverification: "reverification";
7862
+ readonly UnknownDefaultOpenApi: "11184809";
7863
+ };
7864
+ export type ReportConfigurationFacialSimilarityUseCaseEnum = typeof ReportConfigurationFacialSimilarityUseCaseEnum[keyof typeof ReportConfigurationFacialSimilarityUseCaseEnum];
7795
7865
  /**
7796
7866
  *
7797
7867
  * @export
package/dist/esm/api.js CHANGED
@@ -563,6 +563,11 @@ export const RepeatAttemptsListRepeatAttemptsInnerResultEnum = {
563
563
  Consider: 'consider',
564
564
  UnknownDefaultOpenApi: '11184809'
565
565
  };
566
+ export const ReportConfigurationFacialSimilarityUseCaseEnum = {
567
+ Onboarding: 'onboarding',
568
+ Reverification: 'reverification',
569
+ UnknownDefaultOpenApi: '11184809'
570
+ };
566
571
  /**
567
572
  *
568
573
  * @export
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/5.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/5.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": "5.1.0",
3
+ "version": "5.3.0",
4
4
  "description": "Node.js library for the Onfido API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {