idmission-web-sdk 1.0.79 → 1.0.80

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.
@@ -59,6 +59,8 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
59
59
  skipSuccessScreen?: boolean | (() => Promise<boolean>);
60
60
  /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
61
61
  onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
62
+ /** Callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! */
63
+ onSubmit?: (req: SubmissionRequest) => void;
62
64
  /** Callback function that fires when the user has completed the CustomerBiometricsEnrollment flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
63
65
  onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
64
66
  /** Callback function that fires when the user has completed the CustomerBiometricsEnrollment flow successfully. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. */
@@ -94,6 +94,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
94
94
  skipSuccessScreen?: boolean | (() => Promise<boolean>);
95
95
  /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
96
96
  onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
97
+ /** Callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! */
98
+ onSubmit?: (req: SubmissionRequest) => void;
97
99
  /** Callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
98
100
  onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
99
101
  /** Callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow successfully. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. */
@@ -30,6 +30,8 @@ export interface CustomerIdentificationProps extends PropsWithChildren {
30
30
  skipSuccessScreen?: boolean | (() => Promise<boolean>);
31
31
  /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
32
32
  onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
33
+ /** Callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! */
34
+ onSubmit?: (req: SubmissionRequest) => void;
33
35
  /** Callback function that fires when the user has completed the CustomerIdentification flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
34
36
  onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
35
37
  /** Callback function that fires when the user has completed the CustomerIdentification flow and matches a pre-registered customer <code>enrollmentId</code> in IDmission's database. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. */
@@ -42,6 +42,8 @@ export interface CustomerVerificationProps extends PropsWithChildren {
42
42
  verbiage?: CustomerVerificationVerbiage;
43
43
  /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
44
44
  onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
45
+ /** Callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! */
46
+ onSubmit?: (req: SubmissionRequest) => void;
45
47
  /** Callback function that fires when the user has completed the CustomerVerification flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
46
48
  onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
47
49
  /** Callback function that fires when the user has completed the CustomerVerification flow and matches the specified customer <code>enrollmentId</code>. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. */
@@ -88,6 +88,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
88
88
  onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
89
89
  /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
90
90
  onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
91
+ /** Callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! */
92
+ onSubmit?: (req: SubmissionRequest) => void;
91
93
  /** Callback function that fires when the user has completed both flows. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
92
94
  onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
93
95
  /** Callback function that fires when the user completes both flows with a valid ID and passes the realness check. Arguments: same as `onComplete`. */
@@ -72,6 +72,8 @@ export interface IdValidationProps extends PropsWithChildren {
72
72
  skipSuccessScreen?: boolean | (() => Promise<boolean>);
73
73
  /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
74
74
  onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
75
+ /** Callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! */
76
+ onSubmit?: (req: SubmissionRequest) => void;
75
77
  /** Callback function that fires when the user completes the IDValidation flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
76
78
  onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
77
79
  /** Callback function that fires when the user completes the IDValidation flow with a valid ID. Arguments: same as `onComplete`. */
@@ -12,6 +12,8 @@ export interface SignatureKYCProps extends PropsWithChildren {
12
12
  submissionUrl?: string;
13
13
  /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
14
14
  onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
15
+ /** Callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! */
16
+ onSubmit?: (req: SubmissionRequest) => void;
15
17
  /** Callback function that fires when the user completes the SignatureKYC flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the data submitted by the user. */
16
18
  onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
17
19
  /** Boolean or async function to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to `false`. */
@@ -46,7 +46,7 @@ var LanguageDetector__default = /*#__PURE__*/_interopDefaultLegacy(LanguageDetec
46
46
  var i18n__default = /*#__PURE__*/_interopDefaultLegacy(i18n);
47
47
  var SignatureCanvas__default = /*#__PURE__*/_interopDefaultLegacy(SignatureCanvas);
48
48
 
49
- var webSdkVersion = '1.0.79';
49
+ var webSdkVersion = '1.0.80';
50
50
 
51
51
  function getPlatform() {
52
52
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -14250,6 +14250,7 @@ var IdValidation = function IdValidation(_a) {
14250
14250
  _h = _a.skipSuccessScreen,
14251
14251
  skipSuccessScreen = _h === void 0 ? false : _h,
14252
14252
  onBeforeSubmit = _a.onBeforeSubmit,
14253
+ onSubmit = _a.onSubmit,
14253
14254
  onComplete = _a.onComplete,
14254
14255
  onApproved = _a.onApproved,
14255
14256
  onDenied = _a.onDenied,
@@ -14348,6 +14349,7 @@ var IdValidation = function IdValidation(_a) {
14348
14349
  webhooksSendProcessedImages: webhooksSendProcessedImages,
14349
14350
  webhooksFireOnReview: webhooksFireOnReview,
14350
14351
  onBeforeSubmit: onBeforeSubmit,
14352
+ onSubmit: onSubmit,
14351
14353
  onResponseReceived: onResponseReceived,
14352
14354
  geolocationEnabled: geolocationEnabled,
14353
14355
  geolocationRequired: geolocationRequired
@@ -14483,6 +14485,7 @@ var IdAndFaceValidation = function IdAndFaceValidation(_a) {
14483
14485
  skipSuccessScreen = _k === void 0 ? false : _k,
14484
14486
  onBeforeLivenessCheck = _a.onBeforeLivenessCheck,
14485
14487
  onBeforeSubmit = _a.onBeforeSubmit,
14488
+ onSubmit = _a.onSubmit,
14486
14489
  onComplete = _a.onComplete,
14487
14490
  onApproved = _a.onApproved,
14488
14491
  onDenied = _a.onDenied,
@@ -14596,6 +14599,7 @@ var IdAndFaceValidation = function IdAndFaceValidation(_a) {
14596
14599
  webhooksFireOnReview: webhooksFireOnReview,
14597
14600
  onBeforeSubmit: onBeforeSubmit,
14598
14601
  onBeforeLivenessCheck: onBeforeLivenessCheck,
14602
+ onSubmit: onSubmit,
14599
14603
  onResponseReceived: onResponseReceived,
14600
14604
  geolocationEnabled: geolocationEnabled,
14601
14605
  geolocationRequired: geolocationRequired
@@ -14658,6 +14662,7 @@ var CustomerIdAndBiometricsEnrollment = function CustomerIdAndBiometricsEnrollme
14658
14662
  _k = _a.skipSuccessScreen,
14659
14663
  skipSuccessScreen = _k === void 0 ? false : _k,
14660
14664
  onBeforeSubmit = _a.onBeforeSubmit,
14665
+ onSubmit = _a.onSubmit,
14661
14666
  onComplete = _a.onComplete,
14662
14667
  onEnrolled = _a.onEnrolled,
14663
14668
  onDenied = _a.onDenied,
@@ -14773,6 +14778,7 @@ var CustomerIdAndBiometricsEnrollment = function CustomerIdAndBiometricsEnrollme
14773
14778
  webhooksSendProcessedImages: webhooksSendProcessedImages,
14774
14779
  webhooksFireOnReview: webhooksFireOnReview,
14775
14780
  onBeforeSubmit: onBeforeSubmit,
14781
+ onSubmit: onSubmit,
14776
14782
  onResponseReceived: onResponseReceived,
14777
14783
  geolocationEnabled: geolocationEnabled,
14778
14784
  geolocationRequired: geolocationRequired
@@ -15236,6 +15242,7 @@ var CustomerVerification = function CustomerVerification(_a) {
15236
15242
  colors = _a.colors,
15237
15243
  verbiage = _a.verbiage,
15238
15244
  onBeforeSubmit = _a.onBeforeSubmit,
15245
+ onSubmit = _a.onSubmit,
15239
15246
  onComplete = _a.onComplete,
15240
15247
  onCustomerMatched = _a.onCustomerMatched,
15241
15248
  onCustomerNotMatched = _a.onCustomerNotMatched,
@@ -15263,6 +15270,7 @@ var CustomerVerification = function CustomerVerification(_a) {
15263
15270
  webhooksSendInputImages: webhooksSendInputImages,
15264
15271
  webhooksSendProcessedImages: webhooksSendProcessedImages,
15265
15272
  onBeforeSubmit: onBeforeSubmit,
15273
+ onSubmit: onSubmit,
15266
15274
  geolocationEnabled: geolocationEnabled,
15267
15275
  geolocationRequired: geolocationRequired
15268
15276
  }, /*#__PURE__*/React__default['default'].createElement(CameraProvider, {
@@ -15719,6 +15727,7 @@ var CustomerIdentification = function CustomerIdentification(_a) {
15719
15727
  _d = _a.skipSuccessScreen,
15720
15728
  skipSuccessScreen = _d === void 0 ? false : _d,
15721
15729
  onBeforeSubmit = _a.onBeforeSubmit,
15730
+ onSubmit = _a.onSubmit,
15722
15731
  onComplete = _a.onComplete,
15723
15732
  onCustomerMatched = _a.onCustomerMatched,
15724
15733
  onCustomerNotMatched = _a.onCustomerNotMatched,
@@ -15751,6 +15760,7 @@ var CustomerIdentification = function CustomerIdentification(_a) {
15751
15760
  webhooksSendInputImages: webhooksSendInputImages,
15752
15761
  webhooksSendProcessedImages: webhooksSendProcessedImages,
15753
15762
  onBeforeSubmit: onBeforeSubmit,
15763
+ onSubmit: onSubmit,
15754
15764
  geolocationEnabled: geolocationEnabled,
15755
15765
  geolocationRequired: geolocationRequired
15756
15766
  }, /*#__PURE__*/React__default['default'].createElement(CameraProvider, {
@@ -15801,6 +15811,7 @@ var SignatureKYC = function SignatureKYC(_a) {
15801
15811
  url: submissionUrl,
15802
15812
  token: submissionToken,
15803
15813
  onBeforeSubmit: onBeforeSubmit,
15814
+ onSubmit: onBeforeSubmit,
15804
15815
  onResponseReceived: onComplete,
15805
15816
  geolocationEnabled: geolocationEnabled,
15806
15817
  geolocationRequired: geolocationRequired
@@ -16035,6 +16046,7 @@ var CustomerBiometricsEnrollment = function CustomerBiometricsEnrollment(_a) {
16035
16046
  _d = _a.skipSuccessScreen,
16036
16047
  skipSuccessScreen = _d === void 0 ? false : _d,
16037
16048
  onBeforeSubmit = _a.onBeforeSubmit,
16049
+ onSubmit = _a.onSubmit,
16038
16050
  onComplete = _a.onComplete,
16039
16051
  onEnrolled = _a.onEnrolled,
16040
16052
  onDenied = _a.onDenied,
@@ -16124,6 +16136,7 @@ var CustomerBiometricsEnrollment = function CustomerBiometricsEnrollment(_a) {
16124
16136
  webhooksSendInputImages: webhooksSendInputImages,
16125
16137
  webhooksSendProcessedImages: webhooksSendProcessedImages,
16126
16138
  onBeforeSubmit: onBeforeSubmit,
16139
+ onSubmit: onSubmit,
16127
16140
  onResponseReceived: onResponseReceived,
16128
16141
  geolocationEnabled: geolocationEnabled,
16129
16142
  geolocationRequired: geolocationRequired