idmission-web-sdk 1.0.49 → 1.0.51

package/README.md

@@ -52,7 +52,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 
 <table>
 <tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
-<tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>submissionUrl</code> (optional)</td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
 <tr><td><code>onBeforeSubmit</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onComplete</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onApproved</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow with a valid ID. Arguments: same as onComplete.</td></tr>
@@ -186,12 +186,12 @@ Render a fullscreen capture component that analyzes frames from the user's front
 
 <table>
 <tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
-<tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>submissionUrl</code> (optional)</td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
 <tr><td><code>onBeforeSubmit</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed the FaceValidation flow, regardless of whether they are approved or denied. 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.</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. Arguments: same as onComplete.</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. Arguments: same as onComplete.</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>onApproved</code> (optional)</td><td>callback function that fires when the user completes the FaceValidation flow and passes the realness check. Arguments: same as onComplete.</td></tr>
+<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user completes the FaceValidation flow and fails the realness check. Arguments: same as onComplete.</td></tr>
+<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the FaceValidation 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>skipSuccessScreen</code> (optional)</td><td>boolean 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.</td></tr>
@@ -292,7 +292,8 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 
 <table>
 <tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
-<tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>submissionUrl</code> (optional)</td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>onBeforeLivenessCheck</code> (optional)</td><td>callback function that fires immediately prior to liveness check, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The liveness check request is passed in as a parameter and a promise resolving to the updated request should be returned.</td></tr>
 <tr><td><code>onBeforeSubmit</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onComplete</code> (optional)</td><td>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.</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. Arguments: same as onComplete.</td></tr>
@@ -311,7 +312,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean 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.</td></tr>
 <tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
 <tr><td><code>manualReviewRequired</code> (optional)</td><td>boolean flag to indicate whether responses should always be reviewed by a human.</td></tr>
-<tr><td><code>idBackImageRequired</code> (optional)</td><td>boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Default is `true</td></tr>
+<tr><td><code>idBackImageRequired</code> (optional)</td><td>boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Default is `true`.</td></tr>
 <tr><td><code>verifyIdWithExternalDatabases</code> (optional)</td><td>boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc.</td></tr>
 <tr><td><code>personalData</code> (optional)</td><td>object of personal data to store with the submitted ID. Valid keys: uniqueNumber, name, phone, phoneCountryCode, email, dob, gender, addressLine1, addressLine2, city, district, postalCode, country.</td></tr>
 <tr><td><code>cardData</code> (optional)</td><td>object of credit/debit card data to store with the submitted ID. Valid keys: cardToken, cardLast4, cardExpDate, nameOnCard.</td></tr>
@@ -353,7 +354,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 
 <table>
 <tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
-<tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>submissionUrl</code> (optional)</td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
 <tr><td><code>enrollmentId</code></td><td>the unique identifier to use for the customer to be enrolled. Overrides <code>personalData.uniqueNumber</code> if both are specified.</td></tr>
 <tr><td><code>onBeforeSubmit</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onComplete</code> (optional)</td><td>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.</td></tr>
@@ -414,12 +415,12 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 
 <table>
 <tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
-<tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>submissionUrl</code> (optional)</td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
 <tr><td><code>enrollmentId</code></td><td>the unique identifier to use for the customer to be enrolled. Overrides <code>personalData.uniqueNumber</code> if both are specified.</td></tr>
 <tr><td><code>onBeforeSubmit</code> (optional)</td><td>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.</td></tr>
-<tr><td><code>onComplete</code> (optional)</td><td>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.</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>onComplete</code> (optional)</td><td>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.</td></tr>
+<tr><td><code>onEnrolled</code> (optional)</td><td>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.</td></tr>
+<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user has completed the CustomerBiometricsEnrollment 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>
@@ -462,12 +463,13 @@ Render a fullscreen capture component that analyzes frames from the user's front
 
 <table>
 <tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
-<tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>submissionUrl</code> (optional)</td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
 <tr><td><code>enrollmentId</code></td><td>the unique identifier to match from previously enrolled customers.</td></tr>
 <tr><td><code>onBeforeSubmit</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onComplete</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onCustomerMatched</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onCustomerNotMatched</code> (optional)</td><td>callback function that fires when the user has completed the CustomerVerification flow but does not match 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.</td></tr>
+<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after 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>skipSuccessScreen</code> (optional)</td><td>boolean 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.</td></tr>
@@ -500,12 +502,12 @@ Render a fullscreen capture component that analyzes frames from the user's front
 
 <table>
 <tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
-<tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>submissionUrl</code> (optional)</td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
 <tr><td><code>onBeforeSubmit</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onComplete</code> (optional)</td><td>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.</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>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after failing the realness check.</td></tr>
 <tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean 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.</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>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>

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

@@ -1,5 +1,5 @@
 import { FC, PropsWithChildren } from 'react';
-import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
 import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
@@ -23,7 +23,6 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
     enrollmentId: string;
     lang?: LangOption;
     submissionToken: string;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
     companyId?: string;
     deduplicationEnabled?: boolean;
@@ -38,9 +37,9 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
     onEnrolled?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     onDenied?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     onExitAfterFailure?: () => void;
-    captureAdditionalDocuments?: AdditionalDocument[];
     captureSignature?: boolean | (() => Promise<boolean>);
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
+    captureAdditionalDocuments?: AdditionalDocument[];
     assets?: CustomerBiometricsEnrollmentAssets;
     colors?: CustomerBiometricsEnrollmentColors;
     verbiage?: CustomerBiometricsEnrollmentVerbiage;

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

@@ -1,5 +1,5 @@
 import { FC, PropsWithChildren } from 'react';
-import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
 import { AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
@@ -27,7 +27,6 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     enrollmentId: string;
     lang?: LangOption;
     submissionToken: string;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
     companyId?: string;
     manualReviewRequired?: boolean;
@@ -53,9 +52,9 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     onEnrolled?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     onDenied?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     onExitAfterFailure?: () => void;
-    captureAdditionalDocuments?: AdditionalDocument[];
     captureSignature?: boolean | (() => Promise<boolean>);
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
+    captureAdditionalDocuments?: AdditionalDocument[];
     assets?: CustomerEnrollmentAssets;
     colors?: CustomerEnrollmentColors;
     verbiage?: CustomerEnrollmentVerbiage;

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

@@ -1,11 +1,10 @@
 import { FC, PropsWithChildren } from 'react';
-import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { CustomerIdentificationAssets, CustomerIdentificationColors, CustomerIdentificationVerbiage } from '../customer_identification/CustomerIdentificationWizard';
 import { LangOption } from '../../lib/locales';
 export interface CustomerIdentificationProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
     companyId?: string;
     webhooksEnabled?: boolean;

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

@@ -1,12 +1,11 @@
 import { FC, PropsWithChildren } from 'react';
-import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { LangOption } from '../../lib/locales';
 import { CustomerVerificationAssets, CustomerVerificationColors, CustomerVerificationVerbiage } from '../customer_verification/CustomerVerificationWizard';
 export interface CustomerVerificationProps extends PropsWithChildren {
     enrollmentId: string;
     lang?: LangOption;
     submissionToken: string;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
     companyId?: string;
     webhooksEnabled?: boolean;

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

@@ -1,11 +1,10 @@
 import { FC, PropsWithChildren } from 'react';
-import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { LangOption } from '../../lib/locales';
 export interface FaceValidationProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
     companyId?: string;
     webhooksEnabled?: boolean;
@@ -13,10 +12,10 @@ export interface FaceValidationProps extends PropsWithChildren {
     webhooksStripSpecialCharacters?: boolean;
     timeoutDurationMs?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
-    onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
-    onComplete?: (resp: SubmissionResponse | null, req: SubmissionRequest | null) => void;
-    onApproved?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
-    onDenied?: (resp: SubmissionResponse | null, req: SubmissionRequest | null) => void;
+    onBeforeSubmit?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
+    onComplete?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
+    onApproved?: (resp: SubmissionResponse, req: LivenessCheckRequest) => void;
+    onDenied?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
     onExitAfterFailure?: () => void;
     assets?: FaceLivenessAssets;
     colors?: FaceLivenessColors;

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

@@ -1,5 +1,5 @@
 import { FC, PropsWithChildren } from 'react';
-import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, LivenessCheckRequest, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
 import { AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
@@ -26,7 +26,6 @@ export type IdAndFaceValidationVerbiage = {
 export interface IdAndFaceValidationProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
     companyId?: string;
     manualReviewRequired?: boolean;
@@ -45,10 +44,11 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     passportFocusScoreThreshold?: number;
     faceLivenessTimeoutDurationMs?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     onApproved?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
-    onDenied?: (resp: SubmissionResponse | null, req: SubmissionRequest | null) => void;
+    onDenied?: (resp: SubmissionResponse | null, req: SubmissionRequest | LivenessCheckRequest | null) => void;
     onExitAfterFailure?: () => void;
     captureSignature?: boolean | (() => Promise<boolean>);
     captureSignatureVideo?: boolean | (() => Promise<boolean>);

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

@@ -1,5 +1,5 @@
 import { FC, PropsWithChildren } from 'react';
-import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
 import { AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
 import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
@@ -18,7 +18,6 @@ export type IdValidationVerbiage = IdCaptureWizardVerbiage & {
 export interface IdValidationProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
     companyId?: string;
     manualReviewRequired?: boolean;

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

@@ -1,11 +1,10 @@
 import { FC, PropsWithChildren } from 'react';
 import { LangOption } from '../../lib/locales';
-import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 export interface SignatureKYCProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;

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

@@ -1,5 +1,5 @@
 import { FC, PropsWithChildren } from 'react';
-import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, LivenessCheckRequest, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { CustomerSuppliedVerbiage, LangOption } from '../../lib/locales';
 import { VideoIdWizardAssets, VideoIdWizardColors, VideoIdWizardVerbiage } from '../video_id/IdVideoCaptureWizard';
 import { IdCaptureWizardProps } from '../id_capture/IdCaptureWizard';
@@ -10,7 +10,6 @@ export type VideoIdValidationVerbiage = VideoIdWizardVerbiage;
 export interface VideoIdValidationProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
     companyId?: string;
     manualReviewRequired?: boolean;
@@ -23,7 +22,7 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     webhooksStripSpecialCharacters?: boolean;
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
-    onExitAfterFailure?: (resp: SubmissionResponse | null, req: SubmissionRequest | null) => void;
+    onExitAfterFailure?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
     idCaptureProps?: IdCaptureWizardProps;
     faceLivenessProps?: FaceLivenessWizardProps;
     idCardFrontDetectionThreshold?: number;
@@ -33,11 +32,11 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     readTextPrompt?: CustomerSuppliedVerbiage;
     readTextTimeoutDurationMs?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
-    geolocationEnabled?: boolean;
-    geolocationRequired?: boolean;
     assets?: VideoIdValidationAssets;
     colors?: VideoIdValidationColors;
     verbiage?: VideoIdValidationVerbiage;
+    geolocationEnabled?: boolean;
+    geolocationRequired?: boolean;
     debugMode?: boolean;
 }
 export declare const VideoIdValidation: FC<VideoIdValidationProps>;

package/dist/components/face_liveness/FaceLivenessWizard.d.ts

@@ -3,7 +3,7 @@ import { FaceLivenessCaptureColors, FaceLivenessCaptureVerbiage } from './FaceLi
 import { SelfieCaptureLoadingOverlayAssets, SelfieCaptureLoadingOverlayColors, SelfieCaptureLoadingOverlayVerbiage } from '../selfie_capture/SelfieCaptureLoadingOverlay';
 import { FaceLivenessSuccessColors, FaceLivenessSuccessVerbiage } from './FaceLivenessSuccess';
 import { FaceLivenessFailureAssets, FaceLivenessFailureColors, FaceLivenessFailureVerbiage } from './FaceLivenessFailure';
-import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 export type FaceLivenessAssets = {
     loadingOverlay?: SelfieCaptureLoadingOverlayAssets;
     failure?: FaceLivenessFailureAssets;
@@ -19,10 +19,10 @@ export type FaceLivenessVerbiage = FaceLivenessCaptureVerbiage & {
     failure?: FaceLivenessFailureVerbiage;
 };
 export type FaceLivenessWizardProps = {
-    onSuccess?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
-    onComplete?: (resp: SubmissionResponse | null, req: SubmissionRequest | null) => void;
-    onTimeout?: (resp: SubmissionResponse | null, req: SubmissionRequest | null) => void;
-    onExitAfterFailure?: (resp: SubmissionResponse | null, req: SubmissionRequest | null) => void;
+    onSuccess?: (resp: SubmissionResponse, req: LivenessCheckRequest) => void;
+    onComplete?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
+    onTimeout?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
+    onExitAfterFailure?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
     timeoutDurationMs?: number;
     maxRetries?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);

package/dist/components/submission/SubmissionProvider.d.ts

@@ -1,5 +1,5 @@
 import { ReactElement } from 'react';
-import { CardData, PersonalData, SubmissionAction, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, LivenessCheckRequest, PersonalData, SubmissionAction, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 export type SubmissionProviderProps = {
     action: SubmissionAction;
     children: ReactElement;
@@ -21,7 +21,8 @@ export type SubmissionProviderProps = {
     webhooksClientTraceId?: string;
     webhooksStripSpecialCharacters?: boolean;
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
+    onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
     onResponseReceived?: (res: SubmissionResponse, req: SubmissionRequest) => void;
     onRequestFailure?: (err: Error) => void;
 };
-export declare const SubmissionProvider: ({ action, children, url, environment, token, companyId, enrollmentId, personalData, cardData, manualReviewRequired, idBackImageRequired, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, onBeforeSubmit, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;
+export declare const SubmissionProvider: ({ action, children, url, environment, token, companyId, enrollmentId, personalData, cardData, manualReviewRequired, idBackImageRequired, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;

package/dist/components/video_id/IdVideoCaptureWizard.d.ts

@@ -4,7 +4,7 @@ import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage, FaceLiven
 import { IdVideoCaptureAssets, IdVideoCaptureColors, IdVideoCaptureVerbiage } from './IdVideoCapture';
 import { IdVideoCaptureSuccessColors, IdVideoCaptureSuccessVerbiage } from './IdVideoCaptureSuccess';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
-import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 export type VideoIdWizardAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
@@ -25,7 +25,7 @@ export type VideoIdWizardVerbiage = {
 export type VideoIdWizardProps = {
     idCaptureProps?: IdCaptureWizardProps;
     faceLivenessProps?: FaceLivenessWizardProps;
-    onExitAfterFailure?: (resp: SubmissionResponse | null, req: SubmissionRequest | null) => void;
+    onExitAfterFailure?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
     idCardFrontDetectionThreshold?: number;
     idCardFrontFocusThreshold?: number;
     goodIdCardFrontFramesThreshold?: number;

package/dist/contexts/SubmissionContext.d.ts

@@ -176,6 +176,7 @@ export type SubmissionState = {
     logIdFrontCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logIdBackCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logSelfieCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
+    livenessCheckRequest: LivenessCheckRequest | null;
     checkLiveness: (imageDataUrl: string) => Promise<LiveCheckResponse>;
     retryLocationAccess: () => void;
 };