idmission-web-sdk 1.0.80 → 1.0.82

package/README.md

@@ -82,6 +82,8 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <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>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</td></tr>
+<tr><td><code>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</td></tr>
 <tr><td><code>idAutoCaptureEnabled</code> (optional)</td><td>boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`.</td></tr>
 <tr><td><code>idCardAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8.</td></tr>
 <tr><td><code>passportAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75.</td></tr>
@@ -337,6 +339,8 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <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>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>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</td></tr>
+<tr><td><code>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</td></tr>
 <tr><td><code>idAutoCaptureEnabled</code> (optional)</td><td>boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`.</td></tr>
 <tr><td><code>idCardAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8.</td></tr>
 <tr><td><code>passportAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75.</td></tr>
@@ -407,6 +411,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <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>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>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</td></tr>
 <tr><td><code>idAutoCaptureEnabled</code> (optional)</td><td>boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`.</td></tr>
 <tr><td><code>idCardAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8.</td></tr>
 <tr><td><code>passportAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75.</td></tr>

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

@@ -8,6 +8,7 @@ import { LangOption } from '../../lib/locales';
 import { SignatureCaptureClassNames, SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
 import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 import { ThemeInput } from '../../themes';
+import { IdCaptureRequirementOption } from '../id_capture/IdCaptureRequirementOption';
 export type CustomerEnrollmentAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
@@ -76,6 +77,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     webhooksSendProcessedImages?: boolean;
     /** Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. */
     webhooksFireOnReview?: boolean;
+    /** String to indicate which types of ID documents should be captured. Valid values: `idCard`, `passport`, `idCardOrPassport`, `idCardAndPassport`. Default is `idCardOrPassport`. */
+    idCaptureRequirement?: IdCaptureRequirementOption;
     /** 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

@@ -8,6 +8,7 @@ import { LangOption } from '../../lib/locales';
 import { SignatureCaptureClassNames, SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
 import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 import { ThemeInput } from '../../themes';
+import { IdCaptureRequirementOption } from '../id_capture/IdCaptureRequirementOption';
 export type IdAndFaceValidationAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
@@ -68,6 +69,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     webhooksSendProcessedImages?: boolean;
     /** Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. */
     webhooksFireOnReview?: boolean;
+    /** String to indicate which types of ID documents should be captured. Valid values: `idCard`, `passport`, `idCardOrPassport`, `idCardAndPassport`. Default is `idCardOrPassport`. */
+    idCaptureRequirement?: IdCaptureRequirementOption;
     /** 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

@@ -7,6 +7,7 @@ import { LangOption } from '../../lib/locales';
 import { SignatureCaptureClassNames, SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
 import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 import { ThemeInput } from '../../themes';
+import { IdCaptureRequirementOption } from '../id_capture/IdCaptureRequirementOption';
 export type IdValidationAssets = IdCaptureWizardAssets;
 export type IdValidationClassNames = IdCaptureWizardClassNames & {
     additionalDocumentCapture?: AdditionalDocumentCaptureWizardClassNames;
@@ -58,6 +59,8 @@ export interface IdValidationProps extends PropsWithChildren {
     webhooksSendProcessedImages?: boolean;
     /** Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. */
     webhooksFireOnReview?: boolean;
+    /** String to indicate which types of documents should be captured. Valid values: `idCard`, `passport`, `idCardOrPassport`, `idCardAndPassport`. Default is `idCardOrPassport`. */
+    idCaptureRequirement?: IdCaptureRequirementOption;
     /** 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/fallback_flows/IdCapture.d.ts

@@ -1,6 +1,7 @@
 import { ReactElement } from 'react';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
 import { LoaderButtonColors } from '../common/LoaderButton';
+import { IdCaptureRequirementOption } from '../id_capture/IdCaptureRequirementOption';
 export type IdCaptureFallbackClassNames = {
     container?: string;
     inner?: string;
@@ -25,15 +26,17 @@ export type IdCaptureFallbackVerbiage = {
     descriptionText?: CustomerSuppliedVerbiage;
     firstInstructionText?: CustomerSuppliedVerbiage;
     secondInstructionText?: CustomerSuppliedVerbiage;
+    thirdInstructionText?: CustomerSuppliedVerbiage;
     captureBtnText?: CustomerSuppliedVerbiage;
     captureMoreBtnText?: CustomerSuppliedVerbiage;
     doneBtnText?: CustomerSuppliedVerbiage;
 };
 export type IdCaptureFallbackProps = {
+    idCaptureRequirement?: IdCaptureRequirementOption;
     onCapture?: (imageData: string) => void;
     onFinished?: (images: string[]) => void;
     classNames?: IdCaptureFallbackClassNames;
     colors?: IdCaptureFallbackColors;
     verbiage?: IdCaptureFallbackVerbiage;
 };
-export declare const IdCaptureFallback: ({ onCapture, onFinished, classNames, colors, verbiage: rawVerbiage, }: IdCaptureFallbackProps) => ReactElement;
+export declare const IdCaptureFallback: ({ idCaptureRequirement, onCapture, onFinished, classNames, colors, verbiage: rawVerbiage, }: IdCaptureFallbackProps) => ReactElement;

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

@@ -0,0 +1 @@
+export type IdCaptureRequirementOption = 'idCard' | 'passport' | 'idCardOrPassport' | 'idCardAndPassport';

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

@@ -4,6 +4,7 @@ import { IdCaptureLoadingOverlayAssets, IdCaptureLoadingOverlayClassNames, IdCap
 import { FlipIdPromptAssets, FlipIdPromptClassNames, FlipIdPromptVerbiage } from './FlipIdPrompt';
 import { IdCaptureSuccessClassNames, IdCaptureSuccessColors, IdCaptureSuccessVerbiage } from './IdCaptureSuccess';
 import { IdCaptureFallbackClassNames, IdCaptureFallbackColors, IdCaptureFallbackVerbiage } from '../fallback_flows/IdCapture';
+import { IdCaptureRequirementOption } from './IdCaptureRequirementOption';
 export type IdCaptureWizardAssets = {
     documentDetectionModelUrl?: string;
     focusModelUrl?: string;
@@ -44,6 +45,7 @@ export type IdCaptureSubmission = {
 export type IdCaptureWizardProps = {
     onSuccess?: (submission: IdCaptureSubmission) => void;
     onExitCapture?: () => void;
+    captureRequirement?: IdCaptureRequirementOption;
     autoCaptureEnabled?: boolean;
     autoCaptureGoodFramesRequired?: number;
     autoCaptureBarcodeRequired?: 'mobile' | boolean;
@@ -61,4 +63,4 @@ export type IdCaptureWizardProps = {
     verbiage?: IdCaptureWizardVerbiage;
     debugMode?: boolean;
 };
-export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, releaseCameraAccessOnExit, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
+export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, captureRequirement, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, releaseCameraAccessOnExit, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;