idmission-web-sdk 2.1.13 → 2.1.15

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

@@ -1,6 +1,5 @@
-/// <reference types="react" />
-export declare const Spinner: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").Substitute<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
-    $size?: number | undefined;
-    $thickness?: number | undefined;
-    $color?: string | undefined;
-}>>;
+export declare const Spinner: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
+    $size?: number;
+    $thickness?: number;
+    $color?: string;
+}>> & string;

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

@@ -1,6 +1,6 @@
 import { FC, PropsWithChildren, ReactNode } from 'react';
 import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
-import { CardData, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, CustomerDataMatchConfig, IdData, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessClassNames, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureWizardAssets, IdCaptureWizardClassNames, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
 import { AdditionalDocumentCaptureWizardClassNames, AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
@@ -70,6 +70,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     personalData?: PersonalData;
     /** Object of credit/debit card data to store with the submitted ID. Valid keys: `cardToken`, `cardLast4`, `cardExpDate`, `nameOnCard`. */
     cardData?: CardData;
+    /** Object of ID data to validate against the submitted ID. Valid keys: `issueDate`, `expDate`. */
+    idData?: IdData;
     /** Boolean flag indicating whether submissions from the same user should be de-duplicated. */
     deduplicationEnabled?: boolean;
     /** Boolean flag indicating whether to wait for de-duplication to complete before allowing the user to proceed. */
@@ -88,6 +90,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     webhooksFireOnReview?: boolean;
     /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
     sendBase64DocumentsInSwaggerProxy?: boolean;
+    /** Object of configuration flags to send for data matching on the server against the data extracted from the ID. */
+    customerDataMatchConfig?: CustomerDataMatchConfig;
     /** String indicating which ID capture loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
     idCaptureLoadingOverlayMode?: IdCaptureLoadingOverlayMode;
     /** String to indicate which types of ID documents should be captured. Valid values: `idCard`, `passport`, `idCardOrPassport`, `idCardAndPassport`. Default is `idCardOrPassport`. */
@@ -104,7 +108,7 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     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`. */
+    /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `true`. */
     idCapturePortraitGuidesOnMobile?: boolean;
     /** Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to `true`. */
     idCaptureRotateLoadingOverlayImageWhenPortrait?: boolean;

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

@@ -1,6 +1,6 @@
 import { FC, PropsWithChildren, ReactNode } from 'react';
 import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
-import { CardData, LivenessCheckRequest, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, CustomerDataMatchConfig, IdData, LivenessCheckRequest, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessClassNames, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureWizardAssets, IdCaptureWizardClassNames, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
 import { AdditionalDocumentCaptureWizardClassNames, AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
@@ -67,6 +67,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     personalData?: PersonalData;
     /** Object of credit/debit card data to store with the submitted ID. Valid keys: `cardToken`, `cardLast4`, `cardExpDate`, `nameOnCard`. */
     cardData?: CardData;
+    /** Object of ID data to validate against the submitted ID. Valid keys: `issueDate`, `expDate`. */
+    idData?: IdData;
     /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
     /** A customer provided trace id to use when invoking customer-configured webhooks. */
@@ -81,6 +83,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     webhooksFireOnReview?: boolean;
     /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
     sendBase64DocumentsInSwaggerProxy?: boolean;
+    /** Object of configuration flags to send for data matching on the server against the data extracted from the ID. */
+    customerDataMatchConfig?: CustomerDataMatchConfig;
     /** Object to allow documents that have been previously captured to be submitted. Valid keys: `idCardFront`, `idCardBack`, `passport`. */
     precapturedDocuments?: CapturedDocuments & {
         selfie: CapturedDocument;
@@ -101,7 +105,7 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     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`. */
+    /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `true`. */
     idCapturePortraitGuidesOnMobile?: boolean;
     /** Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to `true`. */
     idCaptureRotateLoadingOverlayImageWhenPortrait?: boolean;

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

@@ -1,6 +1,6 @@
 import { FC, PropsWithChildren, ReactNode } from 'react';
 import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
-import { CardData, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, CustomerDataMatchConfig, IdData, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { IdCaptureWizardAssets, IdCaptureWizardClassNames, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
 import { AdditionalDocumentCaptureWizardClassNames, AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
 import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
@@ -58,6 +58,8 @@ export interface IdValidationProps extends PropsWithChildren {
     personalData?: PersonalData;
     /** Object of credit/debit card data to store with the submitted ID. Valid keys: `cardToken`, `cardLast4`, `cardExpDate`, `nameOnCard`. */
     cardData?: CardData;
+    /** Object of ID data to validate against the submitted ID. Valid keys: `issueDate`, `expDate`. */
+    idData?: IdData;
     /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
     /** A customer provided trace id to use when invoking customer-configured webhooks. */
@@ -72,6 +74,8 @@ export interface IdValidationProps extends PropsWithChildren {
     webhooksFireOnReview?: boolean;
     /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
     sendBase64DocumentsInSwaggerProxy?: boolean;
+    /** Object of configuration flags to send for data matching on the server against the data extracted from the ID. */
+    customerDataMatchConfig?: CustomerDataMatchConfig;
     /** String indicating which ID capture loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
     loadingOverlayMode?: IdCaptureLoadingOverlayMode;
     /** String to indicate which types of documents should be captured. Valid values: `idCard`, `passport`, `idCardOrPassport`, `idCardAndPassport`. Default is `idCardOrPassport`. */
@@ -86,7 +90,7 @@ 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`. */
+    /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `true`. */
     portraitGuidesOnMobile?: boolean;
     /** Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to `true`. */
     rotateLoadingOverlayImageWhenPortrait?: boolean;

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

@@ -1,5 +1,5 @@
 import { FC, PropsWithChildren } from 'react';
-import { CardData, LivenessCheckRequest, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, CustomerDataMatchConfig, IdData, LivenessCheckRequest, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
 import { CustomerSuppliedVerbiage, LangOption } from '../../lib/locales';
 import { VideoIdWizardAssets, VideoIdWizardClassNames, VideoIdWizardColors, VideoIdWizardVerbiage } from '../video_id/IdVideoCaptureWizard';
@@ -59,6 +59,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     personalData?: PersonalData;
     /** Object of credit/debit card data to store with the submitted ID. Valid keys: `cardToken`, `cardLast4`, `cardExpDate`, `nameOnCard`. */
     cardData?: CardData;
+    /** Object of ID data to validate against the submitted ID. Valid keys: `issueDate`, `expDate`. */
+    idData?: IdData;
     /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
     /** A customer provided trace id to use when invoking customer-configured webhooks. */
@@ -73,6 +75,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     webhooksFireOnReview?: boolean;
     /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
     sendBase64DocumentsInSwaggerProxy?: boolean;
+    /** Object of configuration flags to send for data matching on the server against the data extracted from the ID. */
+    customerDataMatchConfig?: CustomerDataMatchConfig;
     /** Callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. */
     onBeforeDocumentUpload?: OnBeforeDocumentUpload;
     /** Callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. */
@@ -127,7 +131,7 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     idCaptureLoadingOverlayMode?: IdCaptureLoadingOverlayMode;
     /** 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`. */
+    /** Boolean to indicate whether guide images should be rotated on mobile. Defaults to `true`. */
     idCapturePortraitGuidesOnMobile?: boolean;
     /** Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to `true`. */
     idCaptureRotateLoadingOverlayImageWhenPortrait?: boolean;

package/dist/components/document_capture/DocumentCaptureStateProvider.d.ts

@@ -96,17 +96,14 @@ export type DocumentCaptureDispatch = Dispatch<DocumentCaptureAction>;
 export declare const DocumentCaptureDispatchContext: React.Context<DocumentCaptureDispatch>;
 export declare const documentCaptureStateReducer: (state: DocumentCaptureState, action: DocumentCaptureAction) => DocumentCaptureState;
 export declare const DocumentCaptureStateProvider: ({ documents, aspectRatio, cameraFeedMode, instructions, onDocumentCaptured, onDocumentUploaded, onAllDocumentsUploaded, children, }: {
-    documents?: CapturedDocument[] | undefined;
-    aspectRatio?: number | undefined;
-    cameraFeedMode?: CameraFeedMode | undefined;
+    documents?: CapturedDocument[];
+    aspectRatio?: number;
+    cameraFeedMode?: CameraFeedMode;
     instructions?: ReactNode;
-    onDocumentCaptured?: OnDocumentCaptured | undefined;
-    onDocumentUploaded?: OnDocumentUploaded | undefined;
-    onAllDocumentsUploaded?: OnAllDocumentsUploaded | undefined;
+    onDocumentCaptured?: OnDocumentCaptured;
+    onDocumentUploaded?: OnDocumentUploaded;
+    onAllDocumentsUploaded?: OnAllDocumentsUploaded;
     children: ReactNode;
 }) => React.JSX.Element;
-export declare const useDocumentCaptureState: () => [
-    DocumentCaptureStateWithActions,
-    DocumentCaptureDispatch
-];
+export declare const useDocumentCaptureState: () => [DocumentCaptureStateWithActions, DocumentCaptureDispatch];
 export {};