idmission-web-sdk 1.0.165 → 1.0.166

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

@@ -9,6 +9,7 @@ import { SignatureCaptureClassNames, SignatureCaptureVerbiage } from '../signatu
 import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 import { ThemeInput } from '../../themes';
 import { IdCaptureRequirementOption } from '../id_capture/IdCaptureRequirementOption';
+import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
 export type CustomerEnrollmentAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
@@ -95,7 +96,12 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     faceLivenessTimeoutDurationMs?: 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>);
+    /** ReactNode to render within the ID capture instructions. */
     idCaptureInstructions?: ReactNode;
+    /** String to indicate what type of guides to use during capture. Using `fit` is highly recommended in order to capture the best quality image. Valid values: `fit`, `overlay`. Defaults to `fit`. */
+    idCaptureGuideType?: IdCaptureGuideType;
+    /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `false`. */
+    idCapturePortraitGuidesOnMobile?: 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! */

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

@@ -10,6 +10,7 @@ import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage
 import { ThemeInput } from '../../themes';
 import { IdCaptureRequirementOption } from '../id_capture/IdCaptureRequirementOption';
 import { CapturedDocument, CapturedDocuments } from '../id_capture/CapturedDocuments';
+import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
 export type IdAndFaceValidationAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
@@ -94,6 +95,10 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     /** React element or string to render on the instructions screen. */
     idCaptureInstructions?: ReactNode;
+    /** String to indicate what type of guides to use during capture. Using `fit` is highly recommended in order to capture the best quality image. Valid values: `fit`, `overlay`. Defaults to `fit`. */
+    idCaptureGuideType?: IdCaptureGuideType;
+    /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `false`. */
+    idCapturePortraitGuidesOnMobile?: boolean;
     /** 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. */
     onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
     /** 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. */

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

@@ -79,6 +79,8 @@ export interface IdValidationProps extends PropsWithChildren {
     instructions?: ReactNode;
     /** String to indicate what type of guides to use during capture. Using `fit` is highly recommended in order to capture the best quality image. Valid values: `fit`, `overlay`. Defaults to `fit`. */
     guideType?: IdCaptureGuideType;
+    /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `false`. */
+    portraitGuidesOnMobile?: boolean;
     /** Object to allow documents that have been previously captured to be submitted. Valid keys: `idCardFront`, `idCardBack , `passport`.*/
     precapturedDocuments?: CapturedDocuments;
     /** 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. */

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

@@ -9,6 +9,7 @@ import { AdditionalDocument } from '../additional_document_capture/AdditionalDoc
 import { AdditionalDocumentCaptureWizardClassNames, AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
 import { SignatureCaptureClassNames, SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
 import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
+import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
 export type VideoIdValidationAssets = VideoIdWizardAssets;
 export type VideoIdValidationClassNames = VideoIdWizardClassNames & {
     additionalDocumentCapture?: AdditionalDocumentCaptureWizardClassNames;
@@ -100,6 +101,10 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     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>);
+    /** String to indicate what type of guides to use during capture. Using `fit` is highly recommended in order to capture the best quality image. Valid values: `fit`, `overlay`. Defaults to `fit`. */
+    idCaptureGuideType?: IdCaptureGuideType;
+    /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `false`. */
+    idCapturePortraitGuidesOnMobile?: boolean;
     /** Name of an included theme or object containing theme properties. **/
     theme?: ThemeInput;
     /** Object containing any asset overrides. */

package/dist/components/id_capture/IdCaptureGuides.d.ts

@@ -1,12 +1,13 @@
 import { IdCaptureFitGuideClassNames } from './IdCaptureFitGuide';
 import React from 'react';
 import { IdCaptureAssets, IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
+import { FlipIdPromptAssets } from './FlipIdPrompt';
 export type IdCaptureGuideType = 'fit' | 'overlay';
-export declare function IdCaptureGuides({ guideType, requestingFlip, frontImageUrl, backImageUrl, classNames, assets, colors, verbiage: rawVerbiage, }: {
+export declare function IdCaptureGuides({ guideType, portraitGuidesOnMobile, requestingFlip, flipIdPromptAssets, classNames, assets, colors, verbiage: rawVerbiage, }: {
     guideType?: IdCaptureGuideType;
+    portraitGuidesOnMobile?: boolean;
     requestingFlip?: boolean;
-    frontImageUrl?: string;
-    backImageUrl?: string;
+    flipIdPromptAssets?: FlipIdPromptAssets;
     classNames?: IdCaptureFitGuideClassNames;
     assets?: IdCaptureAssets;
     colors?: IdCaptureColors;

package/dist/components/id_capture/IdCaptureWizard.d.ts

@@ -63,10 +63,11 @@ export type IdCaptureWizardProps = {
     instructions?: ReactNode;
     releaseCameraAccessOnExit?: boolean;
     guideType?: IdCaptureGuideType;
+    portraitGuidesOnMobile?: boolean;
     assets?: IdCaptureWizardAssets;
     classNames?: IdCaptureWizardClassNames;
     colors?: IdCaptureWizardColors;
     verbiage?: IdCaptureWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, precapturedDocuments, captureRequirement, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
+export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, precapturedDocuments, captureRequirement, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, instructions, releaseCameraAccessOnExit, guideType, portraitGuidesOnMobile, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;

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

@@ -5,6 +5,7 @@ import { IdVideoCaptureAssets, IdVideoCaptureClassNames, IdVideoCaptureColors, I
 import { IdVideoCaptureSuccessClassNames, IdVideoCaptureSuccessColors, IdVideoCaptureSuccessVerbiage } from './IdVideoCaptureSuccess';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { IdCaptureGuideType } from '../id_capture/IdCaptureGuides';
 export type VideoIdWizardAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
@@ -44,10 +45,12 @@ export type VideoIdWizardProps = {
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
     skipIdCapture?: boolean;
     skipShowIdCardBack?: boolean | (() => Promise<boolean>);
+    idCaptureGuideType?: IdCaptureGuideType;
+    idCapturePortraitGuidesOnMobile?: boolean;
     assets?: VideoIdWizardAssets;
     classNames?: VideoIdWizardClassNames;
     colors?: VideoIdWizardColors;
     verbiage?: VideoIdWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, idCaptureProps, faceLivenessProps, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
+export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, idCaptureProps, faceLivenessProps, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, skipSuccessScreen, idCaptureGuideType, idCapturePortraitGuidesOnMobile, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;