idmission-web-sdk 1.0.397 → 1.0.398

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

@@ -44,6 +44,8 @@ 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. */

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

@@ -31,6 +31,8 @@ export interface IdValidationProps extends PropsWithChildren {
     lang?: LangOption;
     /** A session identifier generated with your IDmission credentials. */
     sessionId: string | (() => Promise<string>);
+    /** The ClientRequestID field is typically populated with the Form ID and is used to link records together - in this case an id validation record to the original form */
+    clientRequestID?: 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. */

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

@@ -10,6 +10,8 @@ export interface SignatureKYCProps extends PropsWithChildren {
     lang?: LangOption;
     /** A session identifier generated with your IDmission credentials. */
     sessionId: string | (() => Promise<string>);
+    /** The ClientRequestID field is typically populated with the Form ID and is used to link records together - in this case an id validation record to the original form */
+    clientRequestID?: 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. */
@@ -42,6 +44,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

@@ -32,6 +32,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
     lang?: LangOption;
     /** A session identifier generated with your IDmission credentials. */
     sessionId: string | (() => Promise<string>);
+    /** The ClientRequestID field is typically populated with the Form ID and is used to link records together - in this case an id validation record to the original form */
+    clientRequestID?: 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. */
@@ -138,6 +140,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;
     /** Boolean to disable face detection during audio capture after X seconds as defined by disableFaceDetectionWhileAudioCaptureMsDelay. Defaults to false. */

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

@@ -79,6 +79,7 @@ export type SubmissionProviderProps = {
     verifyIdWithExternalDatabases?: boolean;
     deduplicationEnabled?: boolean;
     deduplicationSynchronous?: boolean;
+    idCardForFaceMatch?: string;
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
     webhooksEnabled?: boolean;
@@ -100,5 +101,6 @@ export type SubmissionProviderProps = {
     onResponseReceived?: (res: SubmissionResponse, req: SubmissionRequest) => void;
     onRequestFailure?: (err: Error) => void;
     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, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, webhooksSendInputImages, webhooksSendProcessedImages, webhooksFireOnReview, precapturedDocuments, documentServiceUrl, sendBase64DocumentsInSwaggerProxy, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onBeforeDocumentUpload, onDocumentUploadProgress, onDocumentUploaded, onDocumentUploadFailed, 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, sendBase64DocumentsInSwaggerProxy, onSubmit, onBeforeSubmit, onBeforeLivenessCheck, onBeforeDocumentUpload, onDocumentUploadProgress, onDocumentUploaded, onDocumentUploadFailed, onResponseReceived, onRequestFailure, clientRequestID, }: SubmissionProviderProps) => ReactElement;

package/dist/contexts/SubmissionContext.d.ts

@@ -54,6 +54,7 @@ export type SubmissionRequest = {
     };
     additionalData: {
         uniqueRequestId: string;
+        clientRequestID?: string;
         clientTraceId?: string;
         manualReviewRequired: 'Y' | 'N';
         bypassAgeValidation: 'Y' | 'N';
@@ -132,12 +133,19 @@ export type LivenessCheckRequest = {
         merchantId: number;
     };
     customerData: {
+        additionalData?: {
+            uniqueRequestId?: string;
+        };
         biometricData: {
             selfie: string;
         };
+        idData?: {
+            idImageFront?: string;
+        };
     };
     additionalData: {
         uniqueRequestId: string;
+        clientRequestID?: string;
         stripSpecialCharacters: 'Y' | 'N';
         estimateAge: 'Y' | 'N';
         predictGender: 'Y' | 'N';
@@ -161,7 +169,7 @@ export type LiveCheckResponse = {
 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(): string;
+export declare function liveCheckEndpoint(hasDocumentToMatchFace?: boolean): string;
 export declare function apiHeaders(sessionId?: string, sendBase64DocumentsInSwaggerProxy?: boolean): HeadersInit;
 export declare function attachMetadataToRequest(request: SubmissionRequest | LivenessCheckRequest, { selfieCaptureAttempts, idFrontCaptureAttempts, idBackCaptureAttempts, geolocationResult, }: {
     selfieCaptureAttempts: CaptureAttemptMetadata[];

package/dist/sdk2.cjs.development.js

@@ -49,7 +49,7 @@ var LanguageDetector__default = /*#__PURE__*/_interopDefaultLegacy(LanguageDetec
 var i18n__default = /*#__PURE__*/_interopDefaultLegacy(i18n);
 var SignatureCanvas__default = /*#__PURE__*/_interopDefaultLegacy(SignatureCanvas);
 
-var webSdkVersion = '1.0.397';
+var webSdkVersion = '1.0.398';
 
 function getPlatform() {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -163,8 +163,11 @@ function determineSubmissionEndpoint(action, hasId, hasSelfie) {
       throw new Error("unrecognized SubmissionAction ".concat(action));
   }
 }
-function liveCheckEndpoint() {
-  return "/v4/customer/live-check";
+function liveCheckEndpoint(hasDocumentToMatchFace) {
+  if (hasDocumentToMatchFace === void 0) {
+    hasDocumentToMatchFace = false;
+  }
+  return hasDocumentToMatchFace ? "/v4/customer/match-id-face" : "/v4/customer/live-check";
 }
 function apiHeaders(sessionId, sendBase64DocumentsInSwaggerProxy) {
   if (sendBase64DocumentsInSwaggerProxy === void 0) {
@@ -941,6 +944,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
     deduplicationEnabled = _l === void 0 ? false : _l,
     _m = _a.deduplicationSynchronous,
     deduplicationSynchronous = _m === void 0 ? false : _m,
+    idCardForFaceMatch = _a.idCardForFaceMatch,
     _o = _a.geolocationEnabled,
     geolocationEnabled = _o === void 0 ? true : _o,
     _p = _a.geolocationRequired,
@@ -969,7 +973,8 @@ var SubmissionProvider = function SubmissionProvider(_a) {
     onDocumentUploaded = _a.onDocumentUploaded,
     onDocumentUploadFailed = _a.onDocumentUploadFailed,
     onResponseReceived = _a.onResponseReceived,
-    onRequestFailure = _a.onRequestFailure;
+    onRequestFailure = _a.onRequestFailure,
+    clientRequestID = _a.clientRequestID;
   var sessionId = useAuthContext()[0].sessionId;
   var _x = React.useState(SubmissionStatus.READY),
     submissionStatus = _x[0],
@@ -1242,6 +1247,9 @@ var SubmissionProvider = function SubmissionProvider(_a) {
                 idImageResolutionCheck: idImageResolutionCheck ? 'Y' : 'N'
               }
             };
+            if (clientRequestID) {
+              submissionRequest.additionalData.clientRequestID = clientRequestID;
+            }
             if (documents.idFrontImage) {
               submissionRequest.customerData.idData.idImageFront = documents.idFrontImage;
             }
@@ -1252,12 +1260,10 @@ var SubmissionProvider = function SubmissionProvider(_a) {
               submissionRequest.customerData.idData.idImageFront = documents.passportImage;
             }
             if (documents.selfieImage) {
-              if (action === SubmissionAction.IDENTIFY) {
-                // TODO: remove once API is fixed
-                submissionRequest.biometricData = {
-                  selfie: documents.selfieImage
-                };
-              }
+              // if (action === SubmissionAction.IDENTIFY) {
+              //   // TODO: remove once API is fixed
+              //   submissionRequest.biometricData = { selfie: documents.selfieImage }
+              // }
               submissionRequest.customerData.biometricData = {
                 selfie: documents.selfieImage
               };
@@ -1453,6 +1459,18 @@ var SubmissionProvider = function SubmissionProvider(_a) {
               estimateAge: 'N',
               predictGender: 'N'
             }, _a);
+            if (clientRequestID) {
+              request.additionalData.clientRequestID = clientRequestID;
+            }
+            if (idCardForFaceMatch) {
+              request.customerData.idData = {
+                idImageFront: idCardForFaceMatch
+              };
+              // TODO: remove when fixed
+              request.customerData.additionalData = {
+                uniqueRequestId: request.additionalData.uniqueRequestId
+              };
+            }
             attachMetadataToRequest(request, {
               selfieCaptureAttempts: selfieCaptureAttempts,
               idFrontCaptureAttempts: idFrontCaptureAttempts,
@@ -1468,7 +1486,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
             _d.label = 3;
           case 3:
             host = submissionUrl || determineSubmissionHost(environment);
-            endpoint = liveCheckEndpoint();
+            endpoint = liveCheckEndpoint(!!idCardForFaceMatch);
             return [4 /*yield*/, fetch(host + endpoint, {
               method: 'POST',
               headers: apiHeaders(sessionId, sendBase64DocumentsInSwaggerProxy),
@@ -1517,7 +1535,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
         }
       });
     });
-  }, [environment, geolocationResult, idBackCaptureAttempts, idFrontCaptureAttempts, onBeforeLivenessCheck, onRequestFailure, sessionId, selfieCaptureAttempts, submissionUrl, webhooksStripSpecialCharacters]);
+  }, [webhooksStripSpecialCharacters, idCardForFaceMatch, selfieCaptureAttempts, idFrontCaptureAttempts, idBackCaptureAttempts, geolocationResult, onBeforeLivenessCheck, submissionUrl, environment, sessionId, onRequestFailure]);
   var retryLocationAccess = React.useCallback(function () {
     setGeolocationAttempts(function (n) {
       return n + 1;
@@ -8233,7 +8251,7 @@ var reducer$2 = function reducer(state, action) {
             requestError: new Error("".concat(statusMessage, ": ").concat(errorData))
           });
         }
-        var faceLive = resultData.verificationResult === 'Live Face Detected';
+        var faceLive = ['Live Face Detected', 'Approved'].includes(resultData.verificationResult);
         var eyeCoveringDetected = resultData.eyeCovering === 'true';
         var maskDetected = resultData.faceMask === 'true';
         var headCoveringDetected = resultData.headCovering === 'true';
@@ -9805,31 +9823,53 @@ var VideoSignatureCapture = function VideoSignatureCapture(_a) {
     clearBtnText: 'Clear'
   });
   var outputCanvas = React.useRef(null);
+  var recordingLock = React.useRef(false);
   React.useEffect(function () {
-    // delay 100ms to make sure outputCanvas has rendered.
-    setTimeout(function () {
-      if (!isRecordingVideo && !videoUrl && !!outputCanvas.current) {
-        startRecordingVideo();
-        var stream = outputCanvas.current.captureStream(25 /* fps */);
-        signatureRecorder.current = new MediaRecorder(stream, {
-          videoBitsPerSecond: 270000
-        });
-        signatureRecorder.current.start();
-        signatureRecorder.current.ondataavailable = function (event) {
-          var _a;
-          recordedChunks.current.push(event.data);
-          if (((_a = signatureRecorder.current) === null || _a === void 0 ? void 0 : _a.state) === 'recording') {
-            signatureRecorder.current.stop();
+    if (recordingLock.current) return;
+    recordingLock.current = true;
+    (function () {
+      return tslib.__awaiter(void 0, void 0, void 0, function () {
+        var stream;
+        return tslib.__generator(this, function (_a) {
+          switch (_a.label) {
+            case 0:
+              if (!!outputCanvas.current) return [3 /*break*/, 2];
+              return [4 /*yield*/, new Promise(function (resolve) {
+                var interval = setInterval(function () {
+                  if (outputCanvas.current) {
+                    clearInterval(interval);
+                    resolve(null);
+                  }
+                }, 10);
+              })];
+            case 1:
+              _a.sent();
+              _a.label = 2;
+            case 2:
+              startRecordingVideo();
+              stream = outputCanvas.current.captureStream(24 /* fps */);
+              signatureRecorder.current = new MediaRecorder(stream, {
+                videoBitsPerSecond: 270000
+              });
+              signatureRecorder.current.start();
+              signatureRecorder.current.ondataavailable = function (event) {
+                var _a;
+                recordedChunks.current.push(event.data);
+                if (((_a = signatureRecorder.current) === null || _a === void 0 ? void 0 : _a.state) === 'recording') {
+                  signatureRecorder.current.stop();
+                }
+              };
+              signatureRecorder.current.onstop = function () {
+                var blob = new Blob(recordedChunks.current, {
+                  type: 'video/mp4'
+                });
+                setSignatureVideoData(blob);
+              };
+              return [2 /*return*/];
           }
-        };
-        signatureRecorder.current.onstop = function () {
-          var blob = new Blob(recordedChunks.current, {
-            type: 'video/mp4'
-          });
-          setSignatureVideoData(blob);
-        };
-      }
-    }, 100);
+        });
+      });
+    })();
   }, [isRecordingVideo, startRecordingVideo, videoUrl]);
   React.useEffect(function () {
     if (signatureVideoData && signatureData && signatureDataUrl) {
@@ -11635,6 +11675,7 @@ var IdValidation = function IdValidation(_a) {
   var _d = _a.lang,
     lang = _d === void 0 ? 'auto' : _d,
     sessionId = _a.sessionId,
+    clientRequestID = _a.clientRequestID,
     submissionUrl = _a.submissionUrl,
     authUrl = _a.authUrl,
     documentServiceUrl = _a.documentServiceUrl,
@@ -11790,6 +11831,7 @@ var IdValidation = function IdValidation(_a) {
   }, /*#__PURE__*/React__default['default'].createElement(SubmissionProvider, {
     action: SubmissionAction.VALIDATE,
     submissionUrl: submissionUrl,
+    clientRequestID: clientRequestID,
     documentServiceUrl: documentServiceUrl,
     companyId: companyId,
     needImmediateResponse: needImmediateResponse,
@@ -11855,6 +11897,7 @@ var FaceValidation = function FaceValidation(_a) {
     modelLoadTimeoutMs = _e === void 0 ? defaultSelfieCaptureModelLoadTimeoutMs : _e,
     _f = _a.skipSuccessScreen,
     skipSuccessScreen = _f === void 0 ? false : _f,
+    idCardForFaceMatch = _a.idCardForFaceMatch,
     onBeforeDocumentUpload = _a.onBeforeDocumentUpload,
     onDocumentUploadProgress = _a.onDocumentUploadProgress,
     onDocumentUploaded = _a.onDocumentUploaded,
@@ -11919,6 +11962,7 @@ var FaceValidation = function FaceValidation(_a) {
     webhooksSendInputImages: webhooksSendInputImages,
     webhooksSendProcessedImages: webhooksSendProcessedImages,
     sendBase64DocumentsInSwaggerProxy: sendBase64DocumentsInSwaggerProxy,
+    idCardForFaceMatch: idCardForFaceMatch,
     onBeforeDocumentUpload: onBeforeDocumentUpload,
     onDocumentUploadProgress: onDocumentUploadProgress,
     onDocumentUploaded: onDocumentUploaded,
@@ -13493,6 +13537,7 @@ var SignatureKYC = function SignatureKYC(_a) {
   var _b = _a.lang,
     lang = _b === void 0 ? 'auto' : _b,
     sessionId = _a.sessionId,
+    clientRequestID = _a.clientRequestID,
     authUrl = _a.authUrl,
     submissionUrl = _a.submissionUrl,
     documentServiceUrl = _a.documentServiceUrl,
@@ -13511,6 +13556,7 @@ var SignatureKYC = function SignatureKYC(_a) {
     loadingOverlayMode = _c === void 0 ? 'default' : _c,
     _d = _a.skipSuccessScreen,
     skipSuccessScreen = _d === void 0 ? false : _d,
+    idCardForFaceMatch = _a.idCardForFaceMatch,
     _e = _a.modelLoadTimeoutMs,
     modelLoadTimeoutMs = _e === void 0 ? defaultSelfieCaptureModelLoadTimeoutMs : _e,
     _f = _a.theme,
@@ -13532,7 +13578,9 @@ var SignatureKYC = function SignatureKYC(_a) {
   }, /*#__PURE__*/React__default['default'].createElement(SubmissionProvider, {
     action: SubmissionAction.NONE,
     submissionUrl: submissionUrl,
+    clientRequestID: clientRequestID,
     documentServiceUrl: documentServiceUrl,
+    idCardForFaceMatch: idCardForFaceMatch,
     sendBase64DocumentsInSwaggerProxy: sendBase64DocumentsInSwaggerProxy,
     onBeforeDocumentUpload: onBeforeDocumentUpload,
     onDocumentUploadProgress: onDocumentUploadProgress,
@@ -13571,6 +13619,7 @@ var VideoIdValidation = function VideoIdValidation(_a) {
   var _b = _a.lang,
     lang = _b === void 0 ? 'auto' : _b,
     sessionId = _a.sessionId,
+    clientRequestID = _a.clientRequestID,
     authUrl = _a.authUrl,
     submissionUrl = _a.submissionUrl,
     documentServiceUrl = _a.documentServiceUrl,
@@ -13637,6 +13686,7 @@ var VideoIdValidation = function VideoIdValidation(_a) {
     idCapturePortraitGuidesOnMobile = _s === void 0 ? false : _s,
     _t = _a.idCaptureRotateLoadingOverlayImageWhenPortrait,
     idCaptureRotateLoadingOverlayImageWhenPortrait = _t === void 0 ? true : _t,
+    idCardForFaceMatch = _a.idCardForFaceMatch,
     _u = _a.faceLivenessLoadingOverlayMode,
     faceLivenessLoadingOverlayMode = _u === void 0 ? 'default' : _u,
     _v = _a.disableFaceDetectionWhileAudioCapture,
@@ -13736,6 +13786,7 @@ var VideoIdValidation = function VideoIdValidation(_a) {
   }, /*#__PURE__*/React__default['default'].createElement(SubmissionProvider, {
     action: skipIdCapture ? SubmissionAction.NONE : SubmissionAction.VALIDATE,
     submissionUrl: submissionUrl,
+    clientRequestID: clientRequestID,
     documentServiceUrl: documentServiceUrl,
     companyId: companyId,
     needImmediateResponse: needImmediateResponse,
@@ -13753,6 +13804,7 @@ var VideoIdValidation = function VideoIdValidation(_a) {
     webhooksSendProcessedImages: webhooksSendProcessedImages,
     webhooksFireOnReview: webhooksFireOnReview,
     sendBase64DocumentsInSwaggerProxy: sendBase64DocumentsInSwaggerProxy,
+    idCardForFaceMatch: idCardForFaceMatch,
     onBeforeDocumentUpload: onBeforeDocumentUpload,
     onDocumentUploadProgress: onDocumentUploadProgress,
     onDocumentUploaded: onDocumentUploaded,