idmission-web-sdk 1.0.310 → 1.0.312

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

@@ -1,4 +1,5 @@
 import { FC, PropsWithChildren, ReactNode } from 'react';
+import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
 import { CardData, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessClassNames, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureWizardAssets, IdCaptureWizardClassNames, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
@@ -40,10 +41,14 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     enrollmentId: string;
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */
@@ -92,9 +97,9 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     mrzDetectionScoreThreshold?: number;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
     passportAutoCaptureScoreThreshold?: number;
-    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. */
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. Defaults to 0.3. */
     idCardFocusScoreThreshold?: number;
-    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. */
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. Defaults to 0.3. */
     passportFocusScoreThreshold?: number;
     /** String indicating which face liveness loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
     faceLivenessLoadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
@@ -114,6 +119,14 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     idCaptureModelLoadTimeoutMs?: number;
     /** Number of milliseconds indicating the maximum amount of time that should be spent trying to load the guided capture experience before giving up and resorting to the stock camera instead. Defaults to 45000 (45 seconds). */
     selfieCaptureModelLoadTimeoutMs?: number;
+    /** 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. */
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    /** Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. */
+    onDocumentUploaded?: OnDocumentUploaded;
+    /** Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. */
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
     /** 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/customer_flows/CustomerIdentification.d.ts

@@ -1,4 +1,5 @@
 import { FC, PropsWithChildren } from 'react';
+import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
 import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { CustomerIdentificationAssets, CustomerIdentificationClassNames, CustomerIdentificationColors, CustomerIdentificationVerbiage } from '../customer_identification/CustomerIdentificationWizard';
 import { LangOption } from '../../lib/locales';
@@ -7,10 +8,14 @@ import { SelfieCaptureLoadingOverlayMode } from '../selfie_capture/SelfieCapture
 export interface CustomerIdentificationProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */
@@ -33,6 +38,14 @@ export interface CustomerIdentificationProps extends PropsWithChildren {
     modelLoadTimeoutMs?: 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>);
+    /** 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. */
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    /** Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. */
+    onDocumentUploaded?: OnDocumentUploaded;
+    /** Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. */
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
     /** 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/customer_flows/CustomerVerification.d.ts

@@ -1,4 +1,5 @@
 import { FC, PropsWithChildren } from 'react';
+import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
 import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { LangOption } from '../../lib/locales';
 import { CustomerVerificationAssets, CustomerVerificationClassNames, CustomerVerificationColors, CustomerVerificationVerbiage } from '../customer_verification/CustomerVerificationWizard';
@@ -9,10 +10,14 @@ export interface CustomerVerificationProps extends PropsWithChildren {
     enrollmentId: string;
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */
@@ -45,6 +50,14 @@ export interface CustomerVerificationProps extends PropsWithChildren {
     colors?: CustomerVerificationColors;
     /** Object containing any verbiage overrides. */
     verbiage?: CustomerVerificationVerbiage;
+    /** 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. */
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    /** Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. */
+    onDocumentUploaded?: OnDocumentUploaded;
+    /** Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. */
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
     /** 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/customer_flows/DocumentCapture.d.ts

@@ -1,24 +1,33 @@
 import { FC, PropsWithChildren, ReactNode } from 'react';
 import { ThemeInput } from '../../themes';
 import { LangOption } from '../../lib/locales';
+import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
 import { DocumentCaptureWizardClassNames, DocumentCaptureWizardVerbiage } from '../document_capture/DocumentCaptureWizard';
 import { CameraFeedMode } from '../../lib/camera/CameraFeedWrapper';
-import { CapturedDocument, OnAllDocumentsUploaded, OnDocumentUploaded } from '../document_capture/DocumentCaptureStateProvider';
+import { CapturedDocument, OnAllDocumentsUploaded } from '../document_capture/DocumentCaptureStateProvider';
 export type DocumentCaptureClassNames = DocumentCaptureWizardClassNames;
 export type DocumentCaptureVerbiage = DocumentCaptureWizardVerbiage;
 export interface DocumentCaptureProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api.idmission.com. */
+    authUrl?: string;
     /** URL to upload captured documents to via Tus. */
     documentServiceUrl?: string;
-    /** Callback function that fires when the user completes the DocumentCapture flow. Arguments: the document objects containing id, content and more. */
-    onComplete?: OnAllDocumentsUploaded;
-    /** Callback function that fires when each document is uploaded. Arguments: the document object containing id, content and more. */
+    /** 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. */
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    /** Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. */
     onDocumentUploaded?: OnDocumentUploaded;
+    /** Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. */
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
+    /** Callback function that fires when the user completes the DocumentCapture flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
+    onComplete?: OnAllDocumentsUploaded;
     /** Callback function that fires when the user clicks the exit button during ID or selfie capture. */
     onExitCapture?: () => void;
     /** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */

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

@@ -1,4 +1,5 @@
 import { FC, PropsWithChildren } from 'react';
+import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
 import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessClassNames, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { LangOption } from '../../lib/locales';
@@ -11,10 +12,14 @@ export type FaceValidationVerbiage = FaceLivenessVerbiage;
 export interface FaceValidationProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */
@@ -37,6 +42,16 @@ export interface FaceValidationProps extends PropsWithChildren {
     modelLoadTimeoutMs?: 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>);
+    /** String containing a base64 image or document service ID pointing to an ID card front image that should be used to match the user's face against. Leave blank to disable face matching. */
+    idCardForFaceMatch?: string;
+    /** 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. */
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    /** Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. */
+    onDocumentUploaded?: OnDocumentUploaded;
+    /** Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. */
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
     /** Callback function that fires immediately prior to liveness check, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The liveness check request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
     /** Callback function that fires when the user has completed the FaceValidation flow, regardless of whether they are approved or denied. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */

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

@@ -1,4 +1,5 @@
 import { FC, PropsWithChildren, ReactNode } from 'react';
+import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
 import { CardData, 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';
@@ -39,10 +40,14 @@ export type IdAndFaceValidationVerbiage = {
 export interface IdAndFaceValidationProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */
@@ -73,7 +78,7 @@ 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`.*/
+    /** Object to allow documents that have been previously captured to be submitted. Valid keys: `idCardFront`, `idCardBack`, `passport`. */
     precapturedDocuments?: CapturedDocuments & {
         selfie: CapturedDocument;
     };
@@ -89,9 +94,9 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     mrzDetectionScoreThreshold?: number;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
     passportAutoCaptureScoreThreshold?: number;
-    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. */
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. Defaults to 0.3. */
     idCardFocusScoreThreshold?: number;
-    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. */
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. Defaults to 0.3. */
     passportFocusScoreThreshold?: number;
     /** String indicating which face liveness loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
     faceLivenessLoadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
@@ -111,6 +116,14 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     idCaptureModelLoadTimeoutMs?: number;
     /** Number of milliseconds indicating the maximum amount of time that should be spent trying to load the guided capture experience before giving up and resorting to the stock camera instead. Defaults to 45000 (45 seconds). */
     selfieCaptureModelLoadTimeoutMs?: number;
+    /** 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. */
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    /** Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. */
+    onDocumentUploaded?: OnDocumentUploaded;
+    /** Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. */
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
     /** Callback function that fires immediately prior to liveness check, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The liveness check request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
     /** 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. */

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

@@ -1,4 +1,5 @@
 import { FC, PropsWithChildren, ReactNode } from 'react';
+import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
 import { CardData, PersonalData, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { IdCaptureWizardAssets, IdCaptureWizardClassNames, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
 import { AdditionalDocumentCaptureWizardClassNames, AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
@@ -28,10 +29,14 @@ export type IdValidationVerbiage = IdCaptureWizardVerbiage & {
 export interface IdValidationProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */
@@ -72,9 +77,9 @@ export interface IdValidationProps extends PropsWithChildren {
     idCardAutoCaptureScoreThreshold?: number;
     /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
     passportAutoCaptureScoreThreshold?: number;
-    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. */
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. Defaults to 0.3. */
     idCardFocusScoreThreshold?: number;
-    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. */
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. Defaults to 0.3. */
     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>);
@@ -88,8 +93,16 @@ export interface IdValidationProps extends PropsWithChildren {
     rotateLoadingOverlayImageWhenPortrait?: boolean;
     /** Number of milliseconds indicating the maximum amount of time that should be spent trying to load the guided capture experience before giving up and resorting to the stock camera instead. Defaults to 45000 (45 seconds). */
     modelLoadTimeoutMs?: number;
-    /** Object to allow documents that have been previously captured to be submitted. Valid keys: `idCardFront`, `idCardBack , `passport`.*/
+    /** 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 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. */
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    /** Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. */
+    onDocumentUploaded?: OnDocumentUploaded;
+    /** Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. */
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
     /** 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/customer_flows/SignatureKYC.d.ts

@@ -1,16 +1,29 @@
 import { FC, PropsWithChildren } from 'react';
 import { LangOption } from '../../lib/locales';
 import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
 import { VideoSignatureClassNames, VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 import { ThemeInput } from '../../themes';
 import { SelfieCaptureLoadingOverlayMode } from '../selfie_capture/SelfieCaptureLoadingOverlay';
 export interface SignatureKYCProps extends PropsWithChildren {
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
+    /** 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. */
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    /** Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. */
+    onDocumentUploaded?: OnDocumentUploaded;
+    /** Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. */
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
     /** 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! */
@@ -25,6 +38,8 @@ export interface SignatureKYCProps extends PropsWithChildren {
     loadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
     /** 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>);
+    /** String containing a base64 image or document service ID pointing to an ID card front image that should be used to match the user's face against. Leave blank to disable face matching. */
+    idCardForFaceMatch?: string;
     /** Number of milliseconds indicating the maximum amount of time that should be spent trying to load the guided capture experience before giving up and resorting to the stock camera instead. Defaults to 45000 (45 seconds). */
     modelLoadTimeoutMs?: number;
     /** Name of an included theme or object containing theme properties. **/

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

@@ -1,5 +1,6 @@
 import { FC, PropsWithChildren } from 'react';
 import { CardData, 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';
 import { IdCaptureWizardProps } from '../id_capture/IdCaptureWizard';
@@ -29,10 +30,14 @@ export type VideoIdValidationVerbiage = VideoIdWizardVerbiage & {
 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;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */
@@ -63,6 +68,14 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     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 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. */
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    /** Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. */
+    onDocumentUploaded?: OnDocumentUploaded;
+    /** Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. */
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
     /** 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! */
@@ -117,6 +130,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     idCapturePortraitGuidesOnMobile?: boolean;
     /** Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to `true`. */
     idCaptureRotateLoadingOverlayImageWhenPortrait?: boolean;
+    /** String containing a base64 image or document service ID pointing to an ID card front image that should be used to match the user's face against. Leave blank to disable face matching. */
+    idCardForFaceMatch?: string;
     /** String indicating which face liveness loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
     faceLivenessLoadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
     /** Name of an included theme or object containing theme properties. **/

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

@@ -32,7 +32,7 @@ export type DocumentCaptureState = {
     onAllDocumentsUploaded?: OnAllDocumentsUploaded;
 };
 export type DocumentCaptureStateWithActions = DocumentCaptureState & {
-    uploadCapturedDocument: (content: Blob) => Promise<void>;
+    uploadCapturedDocument: (content: Blob, filetype?: string) => Promise<void>;
 };
 export declare const documentCaptureInitialState: {
     documents: never[];

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

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const AuthUrlNotAllowedOverlay: () => React.JSX.Element;

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

@@ -5,7 +5,7 @@ export declare class SubmissionError extends Error {
 }
 export declare class NetworkError extends Error {
 }
-export declare class TokenPublicKeyError extends Error {
+export declare class SessionValidationFailedError extends Error {
     err: Error;
     host: string;
     constructor(err: Error, host: string);

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

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const SessionIdMissingOverlay: () => React.JSX.Element;

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

@@ -0,0 +1,6 @@
+import React from 'react';
+import { SessionValidationFailedError } from './Errors';
+export declare const SessionValidationErrorOverlay: ({ error, onRetry, }: {
+    error: SessionValidationFailedError | null;
+    onRetry?: (() => void) | undefined;
+}) => React.JSX.Element;

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

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const SessionValidationFailedOverlay: () => React.JSX.Element;

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

@@ -4,7 +4,22 @@ import { UploadedDocument } from '../additional_document_capture/AdditionalDocum
 import { SignatureData } from '../signature_capture/data';
 import { NetworkError, SubmissionError } from './Errors';
 import { CapturedDocuments } from '../id_capture/CapturedDocuments';
-export type TokenState = 'NOT_PARSED' | 'PARSING' | 'GOOD' | 'MISSING' | 'EXPIRED' | 'INVALID_FORMAT' | 'INVALID_SIGNATURE' | 'ISSUER_NOT_ALLOWED' | 'PUBLIC_KEY_LOAD_FAILED';
+export declare const defaultSubmissionUrl = "https://portal-api.idmission.com/swagger";
+export declare const defaultDocumentServiceUrl = "https://portal-api.idmission.com/files/";
+export type DocumentMetadata = {
+    filename?: string;
+    filetype?: string;
+};
+export type DocumentUploadProgressEvent = {
+    bytesUploaded: number;
+    bytesTotal: number;
+    percentage: string;
+    metadata?: DocumentMetadata;
+};
+export type OnBeforeDocumentUpload = (content: Blob, metadata?: DocumentMetadata) => Promise<void | false>;
+export type OnDocumentUploadProgress = (event: DocumentUploadProgressEvent) => void;
+export type OnDocumentUploaded = (documentId: string, metadata?: DocumentMetadata) => Promise<void>;
+export type OnDocumentUploadFailed = (error: Error, metadata?: DocumentMetadata) => void;
 export type SubmissionState = {
     submit: () => Promise<SubmissionResponse | null>;
     submissionStatus: SubmissionStatus;
@@ -32,7 +47,7 @@ export type SubmissionState = {
     setIdCaptureVideoIdFrontImage: (image: string) => void;
     setIdCaptureVideoIdBackImage: (image: string) => void;
     setAdditionalDocuments: (uploadedDocuments: UploadedDocument[]) => void;
-    uploadDocument: (blob: Blob) => Promise<string>;
+    uploadDocument: (blob: Blob, metadata?: DocumentMetadata) => Promise<string>;
     logIdFrontCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logIdBackCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
     logSelfieCaptureAttempt: (attempt: CaptureAttemptMetadata) => void;
@@ -44,8 +59,7 @@ export declare const SubmissionContext: React.Context<SubmissionState>;
 export type SubmissionProviderProps = {
     action: SubmissionAction;
     children: ReactElement;
-    token: string;
-    url?: string;
+    submissionUrl?: string;
     environment?: SubmissionEnvironment;
     companyId?: string;
     enrollmentId?: string;
@@ -60,6 +74,7 @@ export type SubmissionProviderProps = {
     verifyIdWithExternalDatabases?: boolean;
     deduplicationEnabled?: boolean;
     deduplicationSynchronous?: boolean;
+    idCardForFaceMatch?: string;
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     webhooksEnabled?: boolean;
@@ -73,7 +88,11 @@ export type SubmissionProviderProps = {
     onSubmit?: (payload: SubmissionRequest) => void;
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
     onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
+    onBeforeDocumentUpload?: OnBeforeDocumentUpload;
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    onDocumentUploaded?: OnDocumentUploaded;
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
     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, precapturedDocuments, documentServiceUrl, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;
+export declare const SubmissionProvider: ({ action, children, submissionUrl, environment, companyId, enrollmentId, personalData, cardData, bypassAgeValidation, bypassNameMatching, needImmediateResponse, manualReviewRequired, idBackImageRequired, idImageResolutionCheck, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, idCardForFaceMatch, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, webhooksSendInputImages, webhooksSendProcessedImages, webhooksFireOnReview, precapturedDocuments, documentServiceUrl, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onBeforeDocumentUpload, onDocumentUploadProgress, onDocumentUploaded, onDocumentUploadFailed, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;