idmission-web-sdk 1.0.73 → 1.0.75

package/README.md

@@ -103,6 +103,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <tr><td><code>webhooksStripSpecialCharacters</code> (optional)</td><td>boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true.</td></tr>
 <tr><td><code>webhooksSendInputImages</code> (optional)</td><td>boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksSendProcessedImages</code> (optional)</td><td>boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
+<tr><td><code>webhooksFireOnReview</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. 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 color 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>
@@ -358,6 +359,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>webhooksStripSpecialCharacters</code> (optional)</td><td>boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true.</td></tr>
 <tr><td><code>webhooksSendInputImages</code> (optional)</td><td>boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksSendProcessedImages</code> (optional)</td><td>boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
+<tr><td><code>webhooksFireOnReview</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. Defaults to false.</td></tr>
 <tr><td><code>assets.idCapture</code> (optional)</td><td>object containing any asset overrides, for available options consult the ID Capture Assets table above.</td></tr>
 <tr><td><code>assets.faceLiveness</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
 <tr><td><code>colors.idCapture</code> (optional)</td><td>object containing any color overrides, for available options consult the ID Capture Colors table above.</td></tr>
@@ -429,6 +431,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>webhooksStripSpecialCharacters</code> (optional)</td><td>boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true.</td></tr>
 <tr><td><code>webhooksSendInputImages</code> (optional)</td><td>boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksSendProcessedImages</code> (optional)</td><td>boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
+<tr><td><code>webhooksFireOnReview</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. Defaults to false.</td></tr>
 <tr><td><code>assets.idCapture</code> (optional)</td><td>object containing any asset overrides, for available options consult the ID Capture Assets table above.</td></tr>
 <tr><td><code>assets.faceLiveness</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
 <tr><td><code>colors.idCapture</code> (optional)</td><td>object containing any color overrides, for available options consult the ID Capture Colors table above.</td></tr>
@@ -660,6 +663,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>
@@ -675,6 +681,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>webhooksStripSpecialCharacters</code> (optional)</td><td>boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true.</td></tr>
 <tr><td><code>webhooksSendInputImages</code> (optional)</td><td>boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksSendProcessedImages</code> (optional)</td><td>boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
+<tr><td><code>webhooksFireOnReview</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. Defaults to false.</td></tr>
 <tr><td><code>idCaptureProps</code> (optional)</td><td>object containing any overrides for IDValidation.</td></tr>
 <tr><td><code>faceLivenessProps</code> (optional)</td><td>object containing any overrides for IDValidation.</td></tr>
 <tr><td><code>idCardFrontDetectionThreshold</code> (optional)</td><td>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. Defaults to 0.48.</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/CustomerIdAndBiometricsEnrollment.d.ts

@@ -74,6 +74,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     webhooksSendInputImages?: boolean;
     /** Boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. */
     webhooksSendProcessedImages?: boolean;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. */
+    webhooksFireOnReview?: boolean;
     /** Boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`. */
     idAutoCaptureEnabled?: boolean;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. */

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

@@ -66,6 +66,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     webhooksSendInputImages?: boolean;
     /** Boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. */
     webhooksSendProcessedImages?: boolean;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. */
+    webhooksFireOnReview?: boolean;
     /** Boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`. */
     idAutoCaptureEnabled?: boolean;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. */

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

@@ -56,6 +56,8 @@ export interface IdValidationProps extends PropsWithChildren {
     webhooksSendInputImages?: boolean;
     /** Boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. */
     webhooksSendProcessedImages?: boolean;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. */
+    webhooksFireOnReview?: boolean;
     /** Boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`. */
     idAutoCaptureEnabled?: boolean;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. */

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;
@@ -44,6 +58,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     webhooksSendInputImages?: boolean;
     /** Boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. */
     webhooksSendProcessedImages?: boolean;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. */
+    webhooksFireOnReview?: 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! */
@@ -58,6 +74,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/submission/SubmissionProvider.d.ts

@@ -27,10 +27,11 @@ export type SubmissionProviderProps = {
     webhooksStripSpecialCharacters?: boolean;
     webhooksSendInputImages?: boolean;
     webhooksSendProcessedImages?: boolean;
+    webhooksFireOnReview?: 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, bypassAgeValidation, bypassNameMatching, needImmediateResponse, manualReviewRequired, idBackImageRequired, idImageResolutionCheck, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, webhooksSendInputImages, webhooksSendProcessedImages, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;
+export declare const SubmissionProvider: ({ action, children, url, environment, token, companyId, enrollmentId, personalData, cardData, bypassAgeValidation, bypassNameMatching, needImmediateResponse, manualReviewRequired, idBackImageRequired, idImageResolutionCheck, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, webhooksSendInputImages, webhooksSendProcessedImages, webhooksFireOnReview, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;

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;

package/dist/contexts/SubmissionContext.d.ts

@@ -56,6 +56,7 @@ export type SubmissionRequest = {
         deDuplicationRequired: 'Y' | 'N';
         bypassNameMatching: 'Y' | 'N';
         postDataAPIRequired: 'Y' | 'N';
+        postDataOnReviewRequired: 'Y' | 'N';
         sendInputImagesInPost: 'Y' | 'N';
         sendProcessedImagesInPost: 'Y' | 'N';
         needImmediateResponse: 'Y' | 'N';