idmission-web-sdk 1.0.350 → 1.0.352

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

@@ -59,6 +59,8 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
     webhooksSendInputImages?: boolean;
     /** Boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. */
     webhooksSendProcessedImages?: boolean;
+    /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
+    sendBase64DocumentsInSwaggerProxy?: boolean;
     /** String indicating which loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
     loadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
     /** The duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds). */

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

@@ -85,6 +85,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     webhooksSendProcessedImages?: boolean;
     /** Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. */
     webhooksFireOnReview?: boolean;
+    /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
+    sendBase64DocumentsInSwaggerProxy?: boolean;
     /** 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`. */

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

@@ -30,6 +30,8 @@ export interface CustomerIdentificationProps extends PropsWithChildren {
     webhooksSendInputImages?: boolean;
     /** Boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. */
     webhooksSendProcessedImages?: boolean;
+    /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
+    sendBase64DocumentsInSwaggerProxy?: boolean;
     /** String indicating which loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
     loadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
     /** The duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds). */

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

@@ -32,6 +32,8 @@ export interface CustomerVerificationProps extends PropsWithChildren {
     webhooksSendInputImages?: boolean;
     /** Boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. */
     webhooksSendProcessedImages?: boolean;
+    /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
+    sendBase64DocumentsInSwaggerProxy?: boolean;
     /** String indicating which loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
     loadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
     /** The duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds). */

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

@@ -18,6 +18,8 @@ export interface DocumentCaptureProps extends PropsWithChildren {
     authUrl?: string;
     /** URL to upload captured documents to via Tus. */
     documentServiceUrl?: string;
+    /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
+    sendBase64DocumentsInSwaggerProxy?: 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. */

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

@@ -34,6 +34,8 @@ export interface FaceValidationProps extends PropsWithChildren {
     webhooksSendInputImages?: boolean;
     /** Boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. */
     webhooksSendProcessedImages?: boolean;
+    /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
+    sendBase64DocumentsInSwaggerProxy?: boolean;
     /** String indicating which loading overlay screen should be used. Supported values: 'default' and 'legacy'. Defaults to 'default'. */
     loadingOverlayMode?: SelfieCaptureLoadingOverlayMode;
     /** The duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds). */

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

@@ -78,6 +78,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     webhooksSendProcessedImages?: boolean;
     /** Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. */
     webhooksFireOnReview?: boolean;
+    /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
+    sendBase64DocumentsInSwaggerProxy?: boolean;
     /** Object to allow documents that have been previously captured to be submitted. Valid keys: `idCardFront`, `idCardBack`, `passport`. */
     precapturedDocuments?: CapturedDocuments & {
         selfie: CapturedDocument;

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

@@ -69,6 +69,8 @@ export interface IdValidationProps extends PropsWithChildren {
     webhooksSendProcessedImages?: boolean;
     /** Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. */
     webhooksFireOnReview?: boolean;
+    /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
+    sendBase64DocumentsInSwaggerProxy?: boolean;
     /** 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`. */

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

@@ -18,6 +18,8 @@ export interface SignatureKYCProps extends PropsWithChildren {
     authUrl?: string;
     /** URL to upload captured documents to via Tus. */
     documentServiceUrl?: string;
+    /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
+    sendBase64DocumentsInSwaggerProxy?: 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. */

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

@@ -70,6 +70,8 @@ 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;
+    /** Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. */
+    sendBase64DocumentsInSwaggerProxy?: 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. */

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

@@ -90,6 +90,7 @@ export type SubmissionProviderProps = {
     webhooksFireOnReview?: boolean;
     precapturedDocuments?: CapturedDocuments;
     documentServiceUrl?: string;
+    sendBase64DocumentsInSwaggerProxy?: boolean;
     onSubmit?: (payload: SubmissionRequest) => void;
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
     onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
@@ -102,4 +103,4 @@ export type SubmissionProviderProps = {
     readTextPrompt?: string;
     clientRequestID?: string;
 };
-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, clientRequestID, }: 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, sendBase64DocumentsInSwaggerProxy, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onBeforeDocumentUpload, onDocumentUploadProgress, onDocumentUploaded, onDocumentUploadFailed, onResponseReceived, onRequestFailure, clientRequestID, }: SubmissionProviderProps) => ReactElement;

package/dist/contexts/SubmissionContext.d.ts

@@ -169,7 +169,7 @@ export declare function parseJwt(token: string): Record<string, unknown>;
 export declare function determineSubmissionHost(environment: SubmissionEnvironment, token?: string): string;
 export declare function determineSubmissionEndpoint(action: SubmissionAction, hasId: boolean, hasSelfie: boolean): string;
 export declare function liveCheckEndpoint(hasDocumentToMatchFace?: boolean): string;
-export declare function apiHeaders(sessionId?: string): HeadersInit;
+export declare function apiHeaders(sessionId?: string, sendBase64DocumentsInSwaggerProxy?: boolean): HeadersInit;
 export declare function attachMetadataToRequest(request: SubmissionRequest | LivenessCheckRequest, { selfieCaptureAttempts, idFrontCaptureAttempts, idBackCaptureAttempts, geolocationResult, }: {
     selfieCaptureAttempts: CaptureAttemptMetadata[];
     idFrontCaptureAttempts: CaptureAttemptMetadata[];

package/dist/lib/camera/Camera.d.ts

@@ -39,6 +39,7 @@ export type CaptureDevice = {
     videoDevice: MediaDeviceInfo | null;
     videoLoaded: boolean;
     setVideoLoaded: (value: boolean) => void;
+    onVideoUnmounted: (videoElement: HTMLVideoElement) => void;
     cameraRef: MutableRefObject<Camera | null>;
     cameraReady: boolean;
     cameraAccessDenied: boolean;