idmission-web-sdk 1.0.55 → 1.0.57

package/README.md

@@ -616,6 +616,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</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>onSubmit</code> (optional)</td><td>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!</td></tr>
 <tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed the VideoIdValidation 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>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>
@@ -637,6 +638,8 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>readTextPrompt</code> (optional)</td><td>an optional text prompt to display on screen for the user to read during video capture after the ID card has been shown. Leave blank to skip the read text screen.</td></tr>
 <tr><td><code>readTextTimeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user is allowed to spend reading the <code>readTextPrompt</code>. Defaults to 15000ms.</td></tr>
 <tr><td><code>skipSuccessScreen</code> (optional)</td><td>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.</td></tr>
+<tr><td><code>skipIdCapture</code> (optional)</td><td>boolean to indicate whether to skip the initial ID capture flow. Note that when this flag is set, submission to IDmission's servers will not be attempted; it should be used in tandem with onSubmit. Defaults to false.</td></tr>
+<tr><td><code>skipShowIdCardBack</code> (optional)</td><td>boolean or async function to indicate whether to instruct the user to show the back of their ID card during video capture. If an async function is supplied returning a boolean, it will be evaluated at the time of ID front video capture completion. Defaults to false.</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>colors</code> (optional)</td><td>object containing any asset overrides, for available options consult the Colors 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/VideoIdValidation.d.ts

@@ -34,6 +34,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     webhooksStripSpecialCharacters?: boolean;
     /** 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. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
+    /** 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! */
+    onSubmit?: (req: SubmissionRequest) => void;
     /** Callback function that fires when the user has completed all 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. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
     /** Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. */
@@ -56,6 +58,10 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     readTextTimeoutDurationMs?: number;
     /** 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`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Boolean to indicate whether to skip the initial ID capture flow. Note that when this flag is set, submission to IDmission's servers will not be attempted; it should be used in tandem with `onSubmit`. Defaults to `false`. */
+    skipIdCapture?: boolean;
+    /** Boolean or async function to indicate whether to instruct the user to show the back of their ID card during video capture. If an async function is supplied returning a boolean, it will be evaluated at the time of ID front video capture completion. Defaults to `false`. */
+    skipShowIdCardBack?: boolean | (() => Promise<boolean>);
     /** Object containing any asset overrides. */
     assets?: VideoIdValidationAssets;
     /** Object containing any color overrides. */

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

@@ -20,9 +20,10 @@ export type SubmissionProviderProps = {
     webhooksEnabled?: boolean;
     webhooksClientTraceId?: string;
     webhooksStripSpecialCharacters?: boolean;
+    onSubmit?: (payload: SubmissionRequest) => void;
     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, onBeforeLivenessCheck, 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, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;

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

@@ -23,6 +23,7 @@ export type IdVideoCaptureProps = {
     idCardFrontFocusThreshold?: number;
     goodIdCardFrontFramesThreshold?: number;
     showIdCardBackDurationMs?: number;
+    skipShowIdCardBack?: boolean | (() => Promise<boolean>);
     readTextPrompt?: CustomerSuppliedVerbiage;
     readTextTimeoutDurationMs?: number;
     assets?: IdVideoCaptureAssets;
@@ -30,4 +31,4 @@ export type IdVideoCaptureProps = {
     verbiage?: IdVideoCaptureVerbiage;
     debugMode?: boolean;
 };
-export declare const IdVideoCapture: ({ onComplete, onFaceNotDetected, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, assets, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;
+export declare const IdVideoCapture: ({ onComplete, onFaceNotDetected, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, skipShowIdCardBack, readTextPrompt, readTextTimeoutDurationMs, assets, colors, verbiage: rawVerbiage, debugMode, }: IdVideoCaptureProps) => ReactElement;

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

@@ -33,9 +33,11 @@ export type VideoIdWizardProps = {
     readTextPrompt?: CustomerSuppliedVerbiage;
     readTextTimeoutDurationMs?: number;
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    skipIdCapture?: boolean;
+    skipShowIdCardBack?: boolean | (() => Promise<boolean>);
     assets?: VideoIdWizardAssets;
     colors?: VideoIdWizardColors;
     verbiage?: VideoIdWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoIdWizard: ({ idCaptureProps, faceLivenessProps, onExitAfterFailure, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, assets, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
+export declare const VideoIdWizard: ({ idCaptureProps, faceLivenessProps, onExitAfterFailure, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, assets, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;