idmission-web-sdk 0.0.10 → 0.0.12

package/README.md

@@ -137,6 +137,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed the FaceValidation flow. 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.</td></tr>
 <tr><td><code>onApproved</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow and passes the realness check. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling.</td></tr>
 <tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow and fails the realness check. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling.</td></tr>
+<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
 <tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
 <tr><td><code>timeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds).</td></tr>
 <tr><td><code>assets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Assets table below.</td></tr>
@@ -207,6 +208,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed both flows. 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.</td></tr>
 <tr><td><code>onApproved</code> (optional)</td><td>callback function that fires when the user completes both flows with a valid ID and passes the realness check. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling.</td></tr>
 <tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user completes both flows with an invalid ID or fails the realness check. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling.</td></tr>
+<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
@@ -255,6 +257,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow. 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.</td></tr>
 <tr><td><code>onEnrolled</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow but could not be enrolled. 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.</td></tr>
+<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
@@ -298,6 +301,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 <tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow. 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.</td></tr>
 <tr><td><code>onEnrolled</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow but could not be enrolled. 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.</td></tr>
+<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
@@ -364,6 +368,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdentification flow. 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.</td></tr>
 <tr><td><code>onCustomerMatched</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onCustomerNotMatched</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdentification flow but does not match any registered customer. 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.</td></tr>
+<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
 <tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
 <tr><td><code>assets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Assets table below.</td></tr>
 <tr><td><code>verbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Verbiage table below.</td></tr>

package/dist/components/customer_flows/CustomerBiometricsEnrollment.d.ts

@@ -19,6 +19,7 @@ export type CustomerBiometricsEnrollmentProps = {
     onComplete?: (submissionResponse: SubmissionResponse) => void;
     onEnrolled?: (submissionResponse: SubmissionResponse) => void;
     onDenied?: (submissionResponse: SubmissionResponse) => void;
+    onExitAfterFailure?: () => void;
     captureSignature?: boolean | (() => Promise<boolean>);
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
     captureAdditionalDocuments?: AdditionalDocument[];
@@ -26,4 +27,4 @@ export type CustomerBiometricsEnrollmentProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const CustomerBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, timeoutDurationMs, assets, verbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerBiometricsEnrollmentProps) => ReactElement;
+export declare const CustomerBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, timeoutDurationMs, assets, verbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerBiometricsEnrollmentProps) => ReactElement;

package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts

@@ -27,6 +27,7 @@ export type CustomerEnrollmentProps = {
     onComplete?: (submissionResponse: SubmissionResponse) => void;
     onEnrolled?: (submissionResponse: SubmissionResponse) => void;
     onDenied?: (submissionResponse: SubmissionResponse) => void;
+    onExitAfterFailure?: () => void;
     captureSignature?: boolean | (() => Promise<boolean>);
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
     captureAdditionalDocuments?: AdditionalDocument[];
@@ -34,4 +35,4 @@ export type CustomerEnrollmentProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const CustomerIdAndBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, documentDetectionNonMaxSuppressionEnabled, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerEnrollmentProps) => ReactElement;
+export declare const CustomerIdAndBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, documentDetectionNonMaxSuppressionEnabled, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerEnrollmentProps) => ReactElement;

package/dist/components/customer_flows/CustomerVerification.d.ts

@@ -15,8 +15,9 @@ export type CustomerVerificationProps = {
     onComplete?: (submissionResponse: SubmissionResponse) => void;
     onCustomerMatched?: (submissionResponse: SubmissionResponse) => void;
     onCustomerNotMatched?: (submissionResponse: SubmissionResponse) => void;
+    onExitAfterFailure?: () => void;
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const CustomerVerification: ({ lang, enrollmentId, submissionToken, submissionEnvironment, submissionUrl, timeoutDurationMs, assets, verbiage, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, geolocationEnabled, geolocationRequired, debugMode, }: CustomerVerificationProps) => ReactElement;
+export declare const CustomerVerification: ({ lang, enrollmentId, submissionToken, submissionEnvironment, submissionUrl, timeoutDurationMs, assets, verbiage, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onExitAfterFailure, geolocationEnabled, geolocationRequired, debugMode, }: CustomerVerificationProps) => ReactElement;

package/dist/components/customer_flows/FaceValidation.d.ts

@@ -12,10 +12,11 @@ export type FaceValidationProps = {
     onComplete?: (submissionResponse: SubmissionResponse | null) => void;
     onApproved?: (submissionResponse: SubmissionResponse | null) => void;
     onDenied?: (submissionResponse: SubmissionResponse | null) => void;
+    onExitAfterFailure?: () => void;
     assets?: FaceLivenessAssets;
     verbiage?: FaceLivenessVerbiage;
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const FaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, timeoutDurationMs, onBeforeSubmit, onComplete, onApproved, onDenied, assets, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: FaceValidationProps) => ReactElement;
+export declare const FaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, timeoutDurationMs, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, assets, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: FaceValidationProps) => ReactElement;

package/dist/components/customer_flows/IdAndFaceValidation.d.ts

@@ -26,6 +26,7 @@ export type IdAndFaceValidationProps = {
     onComplete?: (submissionResponse: SubmissionResponse) => void;
     onApproved?: (submissionResponse: SubmissionResponse) => void;
     onDenied?: (submissionResponse: SubmissionResponse | null) => void;
+    onExitAfterFailure?: () => void;
     captureSignature?: boolean | (() => Promise<boolean>);
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
     captureAdditionalDocuments?: AdditionalDocument[];
@@ -33,4 +34,4 @@ export type IdAndFaceValidationProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const IdAndFaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, documentDetectionNonMaxSuppressionEnabled, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onApproved, onDenied, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdAndFaceValidationProps) => ReactElement;
+export declare const IdAndFaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, documentDetectionNonMaxSuppressionEnabled, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdAndFaceValidationProps) => ReactElement;

package/dist/sdk2.cjs.development.js

@@ -11879,6 +11879,7 @@ var FaceValidation = function FaceValidation(_a) {
     onComplete = _a.onComplete,
     onApproved = _a.onApproved,
     onDenied = _a.onDenied,
+    onExitAfterFailure = _a.onExitAfterFailure,
     assets = _a.assets,
     verbiage = _a.verbiage,
     _e = _a.geolocationEnabled,
@@ -11894,12 +11895,12 @@ var FaceValidation = function FaceValidation(_a) {
       onComplete: onComplete,
       onSuccess: onApproved,
       onTimeout: onDenied,
-      onExitAfterFailure: onDenied,
+      onExitAfterFailure: onExitAfterFailure,
       assets: assets,
       verbiage: verbiage,
       debugMode: debugMode
     };
-  }, [assets, debugMode, onApproved, onComplete, onDenied, timeoutDurationMs, verbiage]);
+  }, [assets, debugMode, onApproved, onComplete, onDenied, onExitAfterFailure, timeoutDurationMs, verbiage]);
   return /*#__PURE__*/React__default['default'].createElement(SubmissionProvider, {
     action: SubmissionAction.NONE,
     environment: submissionEnvironment,
@@ -11948,6 +11949,7 @@ var IdAndFaceValidation = function IdAndFaceValidation(_a) {
     onComplete = _a.onComplete,
     onApproved = _a.onApproved,
     onDenied = _a.onDenied,
+    onExitAfterFailure = _a.onExitAfterFailure,
     _m = _a.captureSignature,
     captureSignature = _m === void 0 ? false : _m,
     _o = _a.captureSignatureVideo,
@@ -11979,12 +11981,12 @@ var IdAndFaceValidation = function IdAndFaceValidation(_a) {
     return {
       timeoutDurationMs: faceLivenessTimeoutDurationMs,
       onTimeout: onDenied,
-      onExitAfterFailure: onDenied,
+      onExitAfterFailure: onExitAfterFailure,
       assets: faceLivenessAssets,
       verbiage: faceLivenessVerbiage,
       debugMode: debugMode
     };
-  }, [debugMode, faceLivenessAssets, faceLivenessTimeoutDurationMs, faceLivenessVerbiage, onDenied]);
+  }, [debugMode, faceLivenessAssets, faceLivenessTimeoutDurationMs, faceLivenessVerbiage, onDenied, onExitAfterFailure]);
   var signatureCaptureProps = React.useMemo(function () {
     return {
       verbiage: {
@@ -12065,6 +12067,7 @@ var CustomerIdAndBiometricsEnrollment = function CustomerIdAndBiometricsEnrollme
     onComplete = _a.onComplete,
     onEnrolled = _a.onEnrolled,
     onDenied = _a.onDenied,
+    onExitAfterFailure = _a.onExitAfterFailure,
     _m = _a.captureSignature,
     captureSignature = _m === void 0 ? false : _m,
     _o = _a.captureSignatureVideo,
@@ -12094,12 +12097,13 @@ var CustomerIdAndBiometricsEnrollment = function CustomerIdAndBiometricsEnrollme
   }, [debugMode, documentDetectionNonMaxSuppressionEnabled, idAutoCaptureEnabled, idCaptureAssets, idCaptureVerbiage, idCardAutoCaptureScoreThreshold, idCardFocusScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, passportFocusScoreThreshold]);
   var faceLivenessProps = React.useMemo(function () {
     return {
+      onExitAfterFailure: onExitAfterFailure,
       timeoutDurationMs: faceLivenessTimeoutDurationMs,
       assets: faceLivenessAssets,
       verbiage: faceLivenessVerbiage,
       debugMode: debugMode
     };
-  }, [debugMode, faceLivenessAssets, faceLivenessTimeoutDurationMs, faceLivenessVerbiage]);
+  }, [debugMode, faceLivenessAssets, faceLivenessTimeoutDurationMs, faceLivenessVerbiage, onExitAfterFailure]);
   var signatureCaptureProps = React.useMemo(function () {
     return {
       verbiage: {
@@ -12524,6 +12528,7 @@ var CustomerVerification = function CustomerVerification(_a) {
     onComplete = _a.onComplete,
     onCustomerMatched = _a.onCustomerMatched,
     onCustomerNotMatched = _a.onCustomerNotMatched,
+    onExitAfterFailure = _a.onExitAfterFailure,
     _e = _a.geolocationEnabled,
     geolocationEnabled = _e === void 0 ? true : _e,
     _f = _a.geolocationRequired,
@@ -12546,6 +12551,7 @@ var CustomerVerification = function CustomerVerification(_a) {
     onComplete: onComplete,
     onCustomerMatched: onCustomerMatched,
     onCustomerNotMatched: onCustomerNotMatched,
+    onExitAfterFailure: onExitAfterFailure,
     captureGuidanceTimeoutDurationMs: timeoutDurationMs,
     assets: assets,
     verbiage: verbiage,
@@ -13010,6 +13016,7 @@ var CustomerBiometricsEnrollment = function CustomerBiometricsEnrollment(_a) {
     onComplete = _a.onComplete,
     onEnrolled = _a.onEnrolled,
     onDenied = _a.onDenied,
+    onExitAfterFailure = _a.onExitAfterFailure,
     _e = _a.captureSignature,
     captureSignature = _e === void 0 ? false : _e,
     _f = _a.captureSignatureVideo,
@@ -13025,12 +13032,13 @@ var CustomerBiometricsEnrollment = function CustomerBiometricsEnrollment(_a) {
   useLanguage(lang);
   var faceLivenessProps = React.useMemo(function () {
     return {
+      onExitAfterFailure: onExitAfterFailure,
       timeoutDurationMs: timeoutDurationMs,
       assets: assets,
       verbiage: verbiage,
       debugMode: debugMode
     };
-  }, [assets, debugMode, timeoutDurationMs, verbiage]);
+  }, [assets, debugMode, onExitAfterFailure, timeoutDurationMs, verbiage]);
   var signatureCaptureProps = React.useMemo(function () {
     return {
       verbiage: {