idmission-web-sdk 1.0.85 → 1.0.87

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

@@ -9,6 +9,7 @@ import { SignatureCaptureClassNames, SignatureCaptureVerbiage } from '../signatu
 import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 import { ThemeInput } from '../../themes';
 import { IdCaptureRequirementOption } from '../id_capture/IdCaptureRequirementOption';
+import { CapturedDocument, CapturedDocuments } from '../id_capture/CapturedDocuments';
 export type IdAndFaceValidationAssets = {
     idCapture?: IdCaptureWizardAssets;
     faceLiveness?: FaceLivenessAssets;
@@ -69,6 +70,10 @@ 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;
+    /** Object to allow documents that have been previously captured to be submitted. Valid keys: `idCardFront`, `idCardBack , `passport`.*/
+    precapturedDocuments?: CapturedDocuments & {
+        selfie: CapturedDocument;
+    };
     /** 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`. */

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

@@ -8,6 +8,7 @@ import { SignatureCaptureClassNames, SignatureCaptureVerbiage } from '../signatu
 import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 import { ThemeInput } from '../../themes';
 import { IdCaptureRequirementOption } from '../id_capture/IdCaptureRequirementOption';
+import { CapturedDocuments } from '../id_capture/CapturedDocuments';
 export type IdValidationAssets = IdCaptureWizardAssets;
 export type IdValidationClassNames = IdCaptureWizardClassNames & {
     additionalDocumentCapture?: AdditionalDocumentCaptureWizardClassNames;
@@ -73,6 +74,8 @@ export interface IdValidationProps extends PropsWithChildren {
     passportFocusScoreThreshold?: number;
     /** Boolean or async function to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to `false`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Object to allow documents that have been previously captured to be submitted. Valid keys: `idCardFront`, `idCardBack , `passport`.*/
+    precapturedDocuments?: CapturedDocuments;
     /** 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! */

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

@@ -0,0 +1,10 @@
+export type CapturedDocument = {
+    imageData: string;
+    width: number;
+    height: number;
+};
+export declare const CapturedDocumentTypeValues: readonly ["idCardFront", "idCardBack", "passport", "selfie"];
+export type CapturedDocumentType = (typeof CapturedDocumentTypeValues)[number];
+export type CapturedDocuments = {
+    [k in CapturedDocumentType]?: CapturedDocument;
+};

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

@@ -1,11 +1,11 @@
 import React from 'react';
 import { DocumentCaptureGuideOverlayClassNames } from './DocumentCaptureGuideOverlay';
-import { DocumentType } from '../../lib/models/DocumentDetection';
 import { PDF417DetectionResult } from '../../lib/barcode/Native';
 import { CaptureAttemptMetadata } from '../../contexts/SubmissionContext';
 import { IdCapturePrediction } from './IdCaptureModelsProvider';
 import { IdCaptureImagePreviewClassNames } from '../common/SelfieProgressPreview';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';
+import { CapturedDocumentType } from './CapturedDocuments';
 export type IdCaptureAssets = {
     portraitGuidesImageUrl?: string;
     landscapeGuidesImageUrl?: string;
@@ -37,7 +37,7 @@ export type IdCaptureVerbiage = {
     guidanceNotDetectedText?: CustomerSuppliedVerbiage;
 };
 export type IdCaptureProps = {
-    requiredDocumentType?: DocumentType;
+    requiredDocumentType?: CapturedDocumentType;
     autoCaptureEnabled?: boolean;
     autoCaptureScoreThreshold?: number;
     autoCaptureGoodFramesRequired?: number;

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

@@ -1 +1,6 @@
+import { CapturedDocumentType } from './CapturedDocuments';
 export type IdCaptureRequirementOption = 'idCard' | 'passport' | 'idCardOrPassport' | 'idCardAndPassport';
+export declare const requiredDocumentsForOption: {
+    [key in IdCaptureRequirementOption]: Array<CapturedDocumentType>;
+};
+export declare function requiredImageCountForOption(idCaptureRequirement: IdCaptureRequirementOption): number;

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

@@ -1,5 +1,5 @@
 import React, { ReactElement } from 'react';
-import { CapturedDocuments } from '../additional_document_capture/CapturedDocuments';
+import { CapturedDocuments } from './CapturedDocuments';
 import { PDF417DetectionResult } from '../../lib/barcode/Native';
 import { LoaderButtonColors } from '../common/LoaderButton';
 import { CustomerSuppliedVerbiage } from '../../lib/locales';

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

@@ -2,6 +2,7 @@ import { ReactElement } from 'react';
 import { IdCaptureAssets, IdCaptureClassNames, IdCaptureColors, IdCaptureVerbiage } from './IdCapture';
 import { IdCaptureLoadingOverlayAssets, IdCaptureLoadingOverlayClassNames, IdCaptureLoadingOverlayColors, IdCaptureLoadingOverlayVerbiage } from './IdCaptureLoadingOverlay';
 import { FlipIdPromptAssets, FlipIdPromptClassNames, FlipIdPromptVerbiage } from './FlipIdPrompt';
+import { CapturedDocuments } from './CapturedDocuments';
 import { IdCaptureSuccessClassNames, IdCaptureSuccessColors, IdCaptureSuccessVerbiage } from './IdCaptureSuccess';
 import { IdCaptureFallbackClassNames, IdCaptureFallbackColors, IdCaptureFallbackVerbiage } from '../fallback_flows/IdCapture';
 import { IdCaptureRequirementOption } from './IdCaptureRequirementOption';
@@ -38,13 +39,14 @@ export type IdCaptureWizardVerbiage = {
     fallback?: IdCaptureFallbackVerbiage;
 };
 export type IdCaptureSubmission = {
-    idFrontImage: string | null;
-    idBackImage: string | null;
-    passportImage: string | null;
+    idFrontImage?: string;
+    idBackImage?: string;
+    passportImage?: string;
 };
 export type IdCaptureWizardProps = {
     onSuccess?: (submission: IdCaptureSubmission) => void;
     onExitCapture?: () => void;
+    precapturedDocuments?: CapturedDocuments;
     captureRequirement?: IdCaptureRequirementOption;
     autoCaptureEnabled?: boolean;
     autoCaptureGoodFramesRequired?: number;
@@ -63,4 +65,4 @@ export type IdCaptureWizardProps = {
     verbiage?: IdCaptureWizardVerbiage;
     debugMode?: boolean;
 };
-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;
+export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, precapturedDocuments, captureRequirement, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, releaseCameraAccessOnExit, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;

package/dist/components/submission/SubmissionProvider.d.ts

@@ -3,6 +3,7 @@ import { CaptureAttemptMetadata, CardData, LiveCheckResponse, LivenessCheckReque
 import { UploadedDocument } from '../additional_document_capture/AdditionalDocumentCapture';
 import { SignatureData } from '../signature_capture/data';
 import { NetworkError, SubmissionError } from './Errors';
+import { CapturedDocuments } from '../id_capture/CapturedDocuments';
 export type TokenState = 'NOT_PARSED' | 'PARSING' | 'GOOD' | 'EXPIRED' | 'INVALID_FORMAT' | 'INVALID_SIGNATURE' | 'MISSING' | 'PUBLIC_KEY_LOAD_FAILED';
 export type SubmissionState = {
     submit: () => Promise<SubmissionResponse | null>;
@@ -66,10 +67,11 @@ export type SubmissionProviderProps = {
     webhooksSendInputImages?: boolean;
     webhooksSendProcessedImages?: boolean;
     webhooksFireOnReview?: boolean;
+    precapturedDocuments?: CapturedDocuments;
     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, webhooksFireOnReview, 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, precapturedDocuments, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;

package/dist/lib/models/DocumentDetection.d.ts

@@ -1,11 +1,5 @@
 import * as tf from '@tensorflow/tfjs';
-export declare enum DocumentType {
-    NONE = "NONE",
-    ID_CARD = "ID_CARD",
-    ID_CARD_FRONT = "ID_CARD_FRONT",
-    ID_CARD_BACK = "ID_CARD_BACK",
-    PASSPORT = "PASSPORT"
-}
+export type DocumentType = 'none' | 'idCard' | 'passport';
 export declare let documentDetectionModel: tf.GraphModel | null;
 export declare function loadDocumentDetectionModel(url: string): Promise<tf.GraphModel>;
 export declare function unloadDocumentDetectionModel(): void;