idmission-web-sdk 1.0.73 → 1.0.74

package/README.md

@@ -660,6 +660,9 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</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>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>
 <tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
 <tr><td><code>needImmediateResponse</code> (optional)</td><td>boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true.</td></tr>
 <tr><td><code>manualReviewRequired</code> (optional)</td><td>boolean flag to indicate whether responses should always be reviewed by a human. Defaults to false.</td></tr>

package/dist/components/CompositeWizard.d.ts

@@ -5,14 +5,16 @@ import { SubmissionAction, SubmissionEnvironment, SubmissionResponse } from '../
 import { AdditionalDocumentCaptureWizardProps } from './additional_document_capture/AdditionalDocumentCaptureWizard';
 import { SignatureCaptureProps } from './signature_capture/SignatureCapture';
 import { VideoSignatureWizardProps } from './video_signature_capture/VideoSignatureWizard';
-export type CompositeWizardCheck = 'IdCapture' | 'FaceLiveness' | 'SignatureCapture' | 'VideoSignatureCapture' | 'AdditionalDocumentCapture';
+import { VideoIdWizardProps } from './video_id/IdVideoCaptureWizard';
+export type CompositeWizardCheck = 'IdCapture' | 'FaceLiveness' | 'SignatureCapture' | 'VideoSignatureCapture' | 'AdditionalDocumentCapture' | 'VideoIdCapture';
 export type CompositeWizardComponentProps = {
     checks: CompositeWizardCheck[];
     idCaptureProps?: IdCaptureWizardProps;
     faceLivenessProps?: FaceLivenessWizardProps;
+    additionalDocumentCaptureProps?: AdditionalDocumentCaptureWizardProps;
     signatureCaptureProps?: SignatureCaptureProps;
     videoSignatureCaptureProps?: VideoSignatureWizardProps;
-    additionalDocumentCaptureProps?: AdditionalDocumentCaptureWizardProps;
+    videoIdCaptureProps?: VideoIdWizardProps;
     captureSignature?: boolean | (() => Promise<boolean>);
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
     debugMode?: boolean;
@@ -25,4 +27,4 @@ export type CompositeWizardProps = CompositeWizardComponentProps & {
     onComplete?: (submissionResponse: SubmissionResponse) => void;
 };
 export declare const CompositeWizard: (props: CompositeWizardProps) => ReactElement;
-export declare const CompositeWizardComponent: ({ checks: userChecks, idCaptureProps, faceLivenessProps, signatureCaptureProps, videoSignatureCaptureProps, additionalDocumentCaptureProps, captureSignature, captureSignatureVideo, debugMode, }: CompositeWizardComponentProps) => ReactElement;
+export declare const CompositeWizardComponent: ({ checks: userChecks, idCaptureProps, faceLivenessProps, additionalDocumentCaptureProps, signatureCaptureProps, videoSignatureCaptureProps, videoIdCaptureProps, captureSignature, captureSignatureVideo, debugMode, }: CompositeWizardComponentProps) => ReactElement;

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

@@ -5,10 +5,24 @@ import { VideoIdWizardAssets, VideoIdWizardClassNames, VideoIdWizardColors, Vide
 import { IdCaptureWizardProps } from '../id_capture/IdCaptureWizard';
 import { FaceLivenessWizardProps } from '../face_liveness/FaceLivenessWizard';
 import { ThemeInput } from '../../themes';
+import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
+import { AdditionalDocumentCaptureWizardClassNames, AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
+import { SignatureCaptureClassNames, SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
+import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 export type VideoIdValidationAssets = VideoIdWizardAssets;
-export type VideoIdValidationClassNames = VideoIdWizardClassNames;
-export type VideoIdValidationColors = VideoIdWizardColors;
-export type VideoIdValidationVerbiage = VideoIdWizardVerbiage;
+export type VideoIdValidationClassNames = VideoIdWizardClassNames & {
+    additionalDocumentCapture?: AdditionalDocumentCaptureWizardClassNames;
+    signatureCapture?: SignatureCaptureClassNames;
+    videoSignatureCapture?: VideoSignatureClassNames;
+};
+export type VideoIdValidationColors = VideoIdWizardColors & {
+    videoSignatureCapture?: VideoSignatureColors;
+};
+export type VideoIdValidationVerbiage = VideoIdWizardVerbiage & {
+    additionalDocumentCapture?: AdditionalDocumentCaptureWizardVerbiage;
+    signatureCapture?: SignatureCaptureVerbiage;
+    videoSignatureCapture?: VideoSignatureVerbiage;
+};
 export interface VideoIdValidationProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
@@ -58,6 +72,12 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     idCaptureProps?: IdCaptureWizardProps;
     /** Object containing any overrides for FaceLiveness. */
     faceLivenessProps?: FaceLivenessWizardProps;
+    /** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
+    captureSignature?: boolean | (() => Promise<boolean>);
+    /** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */
+    captureSignatureVideo?: boolean | (() => Promise<boolean>);
+    /** Array of additional documents to be captured. Each element includes a name and description. */
+    captureAdditionalDocuments?: AdditionalDocument[];
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for the ID card front during video capture. */
     idCardFrontDetectionThreshold?: number;
     /** Number between 0 and 1 at which focus guidance score condition is considered to be met for the ID card front during video capture. */

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

@@ -27,10 +27,11 @@ export type VideoIdWizardVerbiage = {
     success?: IdVideoCaptureSuccessVerbiage;
 };
 export type VideoIdWizardProps = {
-    idCaptureProps?: IdCaptureWizardProps;
-    faceLivenessProps?: FaceLivenessWizardProps;
+    onComplete?: () => void;
     onExitCapture?: () => void;
     onExitAfterFailure?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
+    idCaptureProps?: IdCaptureWizardProps;
+    faceLivenessProps?: FaceLivenessWizardProps;
     idCardFrontDetectionThreshold?: number;
     idCardFrontFocusThreshold?: number;
     goodIdCardFrontFramesThreshold?: number;
@@ -46,4 +47,4 @@ export type VideoIdWizardProps = {
     verbiage?: VideoIdWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const VideoIdWizard: ({ idCaptureProps, faceLivenessProps, onExitCapture, onExitAfterFailure, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
+export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, idCaptureProps, faceLivenessProps, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;