idmission-web-sdk 1.0.17 → 1.0.18

package/dist/components/common/debug.d.ts

@@ -306,8 +306,9 @@ export type DetectedObjectDebugBoxProps = {
     obj: DetectedObject;
     scaling: DebugScalingDetails;
     flipX?: boolean;
+    color?: string;
 };
-export declare function IdCaptureDetectedObjectDebugBox({ obj, flipX, scaling: { horizontal, pageWidth, pageHeight, scaledWidth, scaledHeight, xOffset, yOffset, }, }: DetectedObjectDebugBoxProps): ReactElement;
+export declare function IdCaptureDetectedObjectDebugBox({ obj, flipX, color, scaling: { horizontal, pageWidth, pageHeight, scaledWidth, scaledHeight, xOffset, yOffset, }, }: DetectedObjectDebugBoxProps): ReactElement;
 export type SelfieCaptureFaceDebugBoxProps = {
     face: Face;
     scaling: DebugScalingDetails;

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

@@ -1,4 +1,4 @@
-import { ReactElement } from 'react';
+import { FC, PropsWithChildren } from 'react';
 import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
@@ -19,7 +19,7 @@ export type CustomerBiometricsEnrollmentVerbiage = {
     signatureCapture?: SignatureCaptureVerbiage;
     videoSignatureCapture?: VideoSignatureVerbiage;
 };
-export type CustomerBiometricsEnrollmentProps = {
+export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
     enrollmentId: string;
     lang?: LangOption;
     submissionToken: string;
@@ -47,5 +47,5 @@ export type CustomerBiometricsEnrollmentProps = {
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     debugMode?: boolean;
-};
-export declare const CustomerBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, companyId, deduplicationEnabled, deduplicationSynchronous, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, skipSuccessScreen, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureAdditionalDocuments, captureSignature, captureSignatureVideo, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerBiometricsEnrollmentProps) => ReactElement;
+}
+export declare const CustomerBiometricsEnrollment: FC<CustomerBiometricsEnrollmentProps>;

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

@@ -1,4 +1,4 @@
-import { ReactElement } from 'react';
+import { FC, PropsWithChildren } from 'react';
 import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
@@ -23,7 +23,7 @@ export type CustomerEnrollmentVerbiage = {
     signatureCapture?: SignatureCaptureVerbiage;
     videoSignatureCapture?: VideoSignatureVerbiage;
 };
-export type CustomerEnrollmentProps = {
+export interface CustomerEnrollmentProps extends PropsWithChildren {
     enrollmentId: string;
     lang?: LangOption;
     submissionToken: string;
@@ -61,5 +61,5 @@ export type CustomerEnrollmentProps = {
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     debugMode?: boolean;
-};
-export declare const CustomerIdAndBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, deduplicationEnabled, deduplicationSynchronous, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, faceLivenessTimeoutDurationMs, skipSuccessScreen, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureAdditionalDocuments, captureSignature, captureSignatureVideo, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerEnrollmentProps) => ReactElement;
+}
+export declare const CustomerIdAndBiometricsEnrollment: FC<CustomerEnrollmentProps>;

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

@@ -1,8 +1,8 @@
-import { ReactElement } from 'react';
+import { FC, PropsWithChildren } from 'react';
 import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { CustomerIdentificationAssets, CustomerIdentificationColors, CustomerIdentificationVerbiage } from '../customer_identification/CustomerIdentificationWizard';
 import { LangOption } from '../../lib/locales';
-export type CustomerIdentificationProps = {
+export interface CustomerIdentificationProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
@@ -25,5 +25,5 @@ export type CustomerIdentificationProps = {
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     debugMode?: boolean;
-};
-export declare const CustomerIdentification: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, skipSuccessScreen, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onCaptureGuidanceTimeout, onExitAfterFailure, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerIdentificationProps) => ReactElement;
+}
+export declare const CustomerIdentification: FC<CustomerIdentificationProps>;

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

@@ -1,8 +1,8 @@
-import { ReactElement } from 'react';
+import { FC, PropsWithChildren } from 'react';
 import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { LangOption } from '../../lib/locales';
 import { CustomerVerificationAssets, CustomerVerificationColors, CustomerVerificationVerbiage } from '../customer_verification/CustomerVerificationWizard';
-export type CustomerVerificationProps = {
+export interface CustomerVerificationProps extends PropsWithChildren {
     enrollmentId: string;
     lang?: LangOption;
     submissionToken: string;
@@ -25,5 +25,5 @@ export type CustomerVerificationProps = {
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     debugMode?: boolean;
-};
-export declare const CustomerVerification: ({ lang, enrollmentId, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, skipSuccessScreen, assets, colors, verbiage, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onExitAfterFailure, geolocationEnabled, geolocationRequired, debugMode, }: CustomerVerificationProps) => ReactElement;
+}
+export declare const CustomerVerification: FC<CustomerVerificationProps>;

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

@@ -1,8 +1,8 @@
-import { ReactElement } from 'react';
+import { FC, PropsWithChildren } from 'react';
 import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { LangOption } from '../../lib/locales';
-export type FaceValidationProps = {
+export interface FaceValidationProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
@@ -24,5 +24,5 @@ export type FaceValidationProps = {
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     debugMode?: boolean;
-};
-export declare const FaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, skipSuccessScreen, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: FaceValidationProps) => ReactElement;
+}
+export declare const FaceValidation: FC<FaceValidationProps>;

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

@@ -1,4 +1,4 @@
-import { ReactElement } from 'react';
+import { FC, PropsWithChildren } from 'react';
 import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
@@ -23,7 +23,7 @@ export type IdAndFaceValidationVerbiage = {
     signatureCapture?: SignatureCaptureVerbiage;
     videoSignatureCapture?: VideoSignatureVerbiage;
 };
-export type IdAndFaceValidationProps = {
+export interface IdAndFaceValidationProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
@@ -58,5 +58,5 @@ export type IdAndFaceValidationProps = {
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     debugMode?: boolean;
-};
-export declare const IdAndFaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, faceLivenessTimeoutDurationMs, skipSuccessScreen, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: IdAndFaceValidationProps) => ReactElement;
+}
+export declare const IdAndFaceValidation: FC<IdAndFaceValidationProps>;

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

@@ -1,4 +1,4 @@
-import { ReactElement } from 'react';
+import { FC, PropsWithChildren } from 'react';
 import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
 import { AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
@@ -15,7 +15,7 @@ export type IdValidationVerbiage = IdCaptureWizardVerbiage & {
     signatureCapture?: SignatureCaptureVerbiage;
     videoSignatureCapture?: VideoSignatureVerbiage;
 };
-export type IdValidationProps = {
+export interface IdValidationProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
@@ -47,5 +47,5 @@ export type IdValidationProps = {
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     debugMode?: boolean;
-};
-export declare const IdValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, onBeforeSubmit, onComplete, onApproved, onDenied, assets, colors, verbiage, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdValidationProps) => ReactElement;
+}
+export declare const IdValidation: FC<IdValidationProps>;

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

@@ -1,8 +1,8 @@
-import { ReactElement } from 'react';
+import { FC, PropsWithChildren } from 'react';
 import { LangOption } from '../../lib/locales';
 import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
-export type SignatureKYCProps = {
+export interface SignatureKYCProps extends PropsWithChildren {
     lang?: LangOption;
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
@@ -15,5 +15,5 @@ export type SignatureKYCProps = {
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     debugMode?: boolean;
-};
-export declare const SignatureKYC: ({ submissionToken, submissionEnvironment, submissionUrl, onBeforeSubmit, onComplete, skipSuccessScreen, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: SignatureKYCProps) => ReactElement;
+}
+export declare const SignatureKYC: FC<SignatureKYCProps>;

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

@@ -0,0 +1,16 @@
+import { FC, PropsWithChildren } from 'react';
+import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { LangOption } from '../../lib/locales';
+export interface VideoIdValidationProps extends PropsWithChildren {
+    lang?: LangOption;
+    submissionToken: string;
+    submissionEnvironment?: SubmissionEnvironment;
+    submissionUrl?: string;
+    onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
+    onComplete?: (submissionResponse: SubmissionResponse) => void;
+    skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    geolocationEnabled?: boolean;
+    geolocationRequired?: boolean;
+    debugMode?: boolean;
+}
+export declare const VideoIdValidation: FC<VideoIdValidationProps>;

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

@@ -0,0 +1,6 @@
+import { ReactElement } from 'react';
+export type IdVideoCaptureProps = {
+    onFaceNotDetected?: () => void;
+    debugMode?: boolean;
+};
+export declare const IdVideoCapture: ({ onFaceNotDetected, debugMode, }: IdVideoCaptureProps) => ReactElement;

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

@@ -0,0 +1,7 @@
+import { ReactElement } from 'react';
+export type IdVideoCaptureGuidesProps = {
+    borderWidth?: number;
+    borderColor?: string;
+    guideImageUrl?: string;
+};
+export declare const IdVideoCaptureGuides: ({ borderWidth, borderColor, guideImageUrl, }: IdVideoCaptureGuidesProps) => ReactElement;

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

@@ -0,0 +1,23 @@
+import { ReactElement } from 'react';
+import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardProps, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
+import { FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
+export type VideoIdWizardAssets = {
+    idCapture?: IdCaptureWizardAssets;
+};
+export type VideoIdWizardColors = {
+    idCapture?: IdCaptureWizardColors;
+    faceLiveness?: FaceLivenessColors;
+};
+export type VideoIdWizardVerbiage = {
+    idCapture?: IdCaptureWizardVerbiage;
+    faceLiveness?: FaceLivenessVerbiage;
+};
+export type VideoIdWizardProps = {
+    idCaptureProps?: IdCaptureWizardProps;
+    skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    assets?: VideoIdWizardAssets;
+    colors?: VideoIdWizardColors;
+    verbiage?: VideoIdWizardVerbiage;
+    debugMode?: boolean;
+};
+export declare const VideoIdWizard: ({ idCaptureProps, assets, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;

package/dist/index.d.ts

@@ -1,21 +1,23 @@
 import { IdValidation, IdValidationProps } from './components/customer_flows/IdValidation';
 import { FaceValidation, FaceValidationProps } from './components/customer_flows/FaceValidation';
 import { IdAndFaceValidation, IdAndFaceValidationProps } from './components/customer_flows/IdAndFaceValidation';
-import { CustomerIdAndBiometricsEnrollment, CustomerEnrollmentProps } from './components/customer_flows/CustomerIdAndBiometricsEnrollment';
+import { CustomerEnrollmentProps, CustomerIdAndBiometricsEnrollment } from './components/customer_flows/CustomerIdAndBiometricsEnrollment';
 import { CustomerVerification, CustomerVerificationProps } from './components/customer_flows/CustomerVerification';
 import { CustomerIdentification, CustomerIdentificationProps } from './components/customer_flows/CustomerIdentification';
+import { SignatureKYC, SignatureKYCProps } from './components/customer_flows/SignatureKYC';
+import { VideoIdValidation, VideoIdValidationProps } from './components/customer_flows/VideoIdValidation';
 import { preloadModels } from './lib/models/preloadModels';
 import { CustomerBiometricsEnrollment } from './components/customer_flows/CustomerBiometricsEnrollment';
-import { SignatureKYC, SignatureKYCProps } from './components/customer_flows/SignatureKYC';
-type TargetElement = Element | DocumentFragment | string;
-export declare const renderIdValidation: (targetElement: TargetElement, options: IdValidationProps) => void;
-export declare const renderFaceValidation: (targetElement: TargetElement, options: FaceValidationProps) => void;
-export declare const renderIdAndFaceValidation: (targetElement: TargetElement, options: IdAndFaceValidationProps) => void;
-export declare const renderCustomerIdAndBiometricsEnrollment: (targetElement: TargetElement, options: CustomerEnrollmentProps) => void;
-export declare const renderCustomerBiometricsEnrollment: (targetElement: TargetElement, options: CustomerEnrollmentProps) => void;
-export declare const renderCustomerVerification: (targetElement: TargetElement, options: CustomerVerificationProps) => void;
-export declare const renderCustomerIdentification: (targetElement: TargetElement, options: CustomerIdentificationProps) => void;
-export declare const renderSignatureKYC: (targetElement: TargetElement, options: SignatureKYCProps) => void;
+type TargetElement = Element | DocumentFragment | string | undefined;
+export declare const renderIdValidation: (optionsOrTargetElement: TargetElement | IdValidationProps, options?: IdValidationProps) => HTMLDivElement;
+export declare const renderFaceValidation: (optionsOrTargetElement: TargetElement | FaceValidationProps, options?: FaceValidationProps) => HTMLDivElement;
+export declare const renderIdAndFaceValidation: (optionsOrTargetElement: TargetElement | IdAndFaceValidationProps, options?: IdAndFaceValidationProps) => HTMLDivElement;
+export declare const renderCustomerIdAndBiometricsEnrollment: (optionsOrTargetElement: TargetElement | CustomerEnrollmentProps, options?: CustomerEnrollmentProps) => HTMLDivElement;
+export declare const renderCustomerBiometricsEnrollment: (optionsOrTargetElement: TargetElement | CustomerEnrollmentProps, options?: CustomerEnrollmentProps) => HTMLDivElement;
+export declare const renderCustomerVerification: (optionsOrTargetElement: TargetElement | CustomerVerificationProps, options?: CustomerVerificationProps) => HTMLDivElement;
+export declare const renderCustomerIdentification: (optionsOrTargetElement: TargetElement | CustomerIdentificationProps, options?: CustomerIdentificationProps) => HTMLDivElement;
+export declare const renderSignatureKYC: (optionsOrTargetElement: TargetElement | SignatureKYCProps, options?: SignatureKYCProps) => HTMLDivElement;
+export declare const renderVideoIdValidation: (optionsOrTargetElement: TargetElement | VideoIdValidationProps, options?: VideoIdValidationProps) => HTMLDivElement;
 export type IDmissionSDK = {
     renderIdValidation: typeof renderIdValidation;
     renderFaceValidation: typeof renderFaceValidation;
@@ -25,6 +27,7 @@ export type IDmissionSDK = {
     renderCustomerVerification: typeof renderCustomerVerification;
     renderCustomerIdentification: typeof renderCustomerIdentification;
     renderSignatureKYC: typeof renderSignatureKYC;
+    renderVideoIdValidation: typeof renderVideoIdValidation;
     preloadModels: typeof preloadModels;
     version: string;
     ready: boolean;
@@ -32,4 +35,4 @@ export type IDmissionSDK = {
 declare global {
     var IDmissionSDK: IDmissionSDK;
 }
-export { preloadModels, IdValidation, FaceValidation, IdAndFaceValidation, CustomerIdAndBiometricsEnrollment, CustomerBiometricsEnrollment, CustomerVerification, CustomerIdentification, SignatureKYC, };
+export { preloadModels, IdValidation, FaceValidation, IdAndFaceValidation, CustomerIdAndBiometricsEnrollment, CustomerBiometricsEnrollment, CustomerVerification, CustomerIdentification, SignatureKYC, VideoIdValidation, };