idmission-web-sdk 1.0.45 → 1.0.47

package/README.md

@@ -69,6 +69,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean 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.</td></tr>
 <tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
 <tr><td><code>manualReviewRequired</code> (optional)</td><td>boolean flag to indicate whether responses should always be reviewed by a human.</td></tr>
+<tr><td><code>idBackImageRequired</code> (optional)</td><td>boolean flag to indicate whether ID card back image should be processed on the server. Default is `true`.</td></tr>
 <tr><td><code>verifyIdWithExternalDatabases</code> (optional)</td><td>boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc.</td></tr>
 <tr><td><code>personalData</code> (optional)</td><td>object of personal data to store with the submitted ID. Valid keys: uniqueNumber, name, phone, phoneCountryCode, email, dob, gender, addressLine1, addressLine2, city, district, postalCode, country.</td></tr>
 <tr><td><code>cardData</code> (optional)</td><td>object of credit/debit card data to store with the submitted ID. Valid keys: cardToken, cardLast4, cardExpDate, nameOnCard.</td></tr>
@@ -310,6 +311,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean 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.</td></tr>
 <tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
 <tr><td><code>manualReviewRequired</code> (optional)</td><td>boolean flag to indicate whether responses should always be reviewed by a human.</td></tr>
+<tr><td><code>idBackImageRequired</code> (optional)</td><td>boolean flag to indicate whether ID card back image should be processed on the server. Default is `true</td></tr>
 <tr><td><code>verifyIdWithExternalDatabases</code> (optional)</td><td>boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc.</td></tr>
 <tr><td><code>personalData</code> (optional)</td><td>object of personal data to store with the submitted ID. Valid keys: uniqueNumber, name, phone, phoneCountryCode, email, dob, gender, addressLine1, addressLine2, city, district, postalCode, country.</td></tr>
 <tr><td><code>cardData</code> (optional)</td><td>object of credit/debit card data to store with the submitted ID. Valid keys: cardToken, cardLast4, cardExpDate, nameOnCard.</td></tr>
@@ -371,6 +373,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean 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.</td></tr>
 <tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
 <tr><td><code>manualReviewRequired</code> (optional)</td><td>boolean flag to indicate whether responses should always be reviewed by a human.</td></tr>
+<tr><td><code>idBackImageRequired</code> (optional)</td><td>boolean flag to indicate whether ID card back image should be processed on the server. Default is `true</td></tr>
 <tr><td><code>verifyIdWithExternalDatabases</code> (optional)</td><td>boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc.</td></tr>
 <tr><td><code>personalData</code> (optional)</td><td>object of personal data to store with the submitted ID. Valid keys: uniqueNumber, name, phone, phoneCountryCode, email, dob, gender, addressLine1, addressLine2, city, district, postalCode, country.</td></tr>
 <tr><td><code>cardData</code> (optional)</td><td>object of credit/debit card data to store with the submitted ID. Valid keys: cardToken, cardLast4, cardExpDate, nameOnCard.</td></tr>

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

@@ -31,6 +31,7 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
     submissionUrl?: string;
     companyId?: string;
     manualReviewRequired?: boolean;
+    idBackImageRequired?: boolean;
     verifyIdWithExternalDatabases?: boolean;
     personalData?: PersonalData;
     cardData?: CardData;

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

@@ -30,6 +30,7 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
     submissionUrl?: string;
     companyId?: string;
     manualReviewRequired?: boolean;
+    idBackImageRequired?: boolean;
     verifyIdWithExternalDatabases?: boolean;
     personalData?: PersonalData;
     cardData?: CardData;

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

@@ -22,6 +22,7 @@ export interface IdValidationProps extends PropsWithChildren {
     submissionUrl?: string;
     companyId?: string;
     manualReviewRequired?: boolean;
+    idBackImageRequired?: boolean;
     verifyIdWithExternalDatabases?: boolean;
     personalData?: PersonalData;
     cardData?: CardData;

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

@@ -11,6 +11,7 @@ export type SubmissionProviderProps = {
     personalData?: PersonalData;
     cardData?: CardData;
     manualReviewRequired?: boolean;
+    idBackImageRequired?: boolean;
     verifyIdWithExternalDatabases?: boolean;
     deduplicationEnabled?: boolean;
     deduplicationSynchronous?: boolean;
@@ -23,4 +24,4 @@ export type SubmissionProviderProps = {
     onResponseReceived?: (response: SubmissionResponse) => void;
     onRequestFailure?: (err: Error) => void;
 };
-export declare const SubmissionProvider: ({ action, children, url, environment, token, companyId, enrollmentId, personalData, cardData, manualReviewRequired, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, onBeforeSubmit, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;
+export declare const SubmissionProvider: ({ action, children, url, environment, token, companyId, enrollmentId, personalData, cardData, manualReviewRequired, idBackImageRequired, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, onBeforeSubmit, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;

package/dist/sdk2.cjs.development.js

@@ -48,7 +48,7 @@ var tf__namespace = /*#__PURE__*/_interopNamespace(tf);
 var useResizeObserver__default = /*#__PURE__*/_interopDefaultLegacy(useResizeObserver);
 var SignatureCanvas__default = /*#__PURE__*/_interopDefaultLegacy(SignatureCanvas);
 
-var webSdkVersion = '1.0.45';
+var webSdkVersion = '1.0.47';
 
 function getPlatform() {
   return window.platform;
@@ -494,81 +494,83 @@ var SubmissionProvider = function SubmissionProvider(_a) {
     cardData = _a.cardData,
     _c = _a.manualReviewRequired,
     manualReviewRequired = _c === void 0 ? false : _c,
-    _d = _a.verifyIdWithExternalDatabases,
-    verifyIdWithExternalDatabases = _d === void 0 ? false : _d,
-    _e = _a.deduplicationEnabled,
-    deduplicationEnabled = _e === void 0 ? false : _e,
-    _f = _a.deduplicationSynchronous,
-    deduplicationSynchronous = _f === void 0 ? false : _f,
-    _g = _a.geolocationEnabled,
-    geolocationEnabled = _g === void 0 ? true : _g,
-    _h = _a.geolocationRequired,
-    geolocationRequired = _h === void 0 ? false : _h,
-    _j = _a.webhooksEnabled,
-    webhooksEnabled = _j === void 0 ? false : _j,
+    _d = _a.idBackImageRequired,
+    idBackImageRequired = _d === void 0 ? true : _d,
+    _e = _a.verifyIdWithExternalDatabases,
+    verifyIdWithExternalDatabases = _e === void 0 ? false : _e,
+    _f = _a.deduplicationEnabled,
+    deduplicationEnabled = _f === void 0 ? false : _f,
+    _g = _a.deduplicationSynchronous,
+    deduplicationSynchronous = _g === void 0 ? false : _g,
+    _h = _a.geolocationEnabled,
+    geolocationEnabled = _h === void 0 ? true : _h,
+    _j = _a.geolocationRequired,
+    geolocationRequired = _j === void 0 ? false : _j,
+    _k = _a.webhooksEnabled,
+    webhooksEnabled = _k === void 0 ? false : _k,
     webhooksClientTraceId = _a.webhooksClientTraceId,
-    _k = _a.webhooksStripSpecialCharacters,
-    webhooksStripSpecialCharacters = _k === void 0 ? true : _k,
+    _l = _a.webhooksStripSpecialCharacters,
+    webhooksStripSpecialCharacters = _l === void 0 ? true : _l,
     onBeforeSubmit = _a.onBeforeSubmit,
     onResponseReceived = _a.onResponseReceived,
     onRequestFailure = _a.onRequestFailure;
-  var _l = React.useState(SubmissionStatus.READY),
-    submissionStatus = _l[0],
-    setSubmissionStatus = _l[1];
-  var _m = React.useState(null),
-    submissionRequest = _m[0],
-    setSubmissionRequest = _m[1];
+  var _m = React.useState(SubmissionStatus.READY),
+    submissionStatus = _m[0],
+    setSubmissionStatus = _m[1];
   var _o = React.useState(null),
-    submissionResponse = _o[0],
-    setSubmissionResponse = _o[1];
+    submissionRequest = _o[0],
+    setSubmissionRequest = _o[1];
   var _p = React.useState(null),
-    submissionError = _p[0],
-    setSubmissionError = _p[1];
+    submissionResponse = _p[0],
+    setSubmissionResponse = _p[1];
   var _q = React.useState(null),
-    retrySubmission = _q[0],
-    setRetrySubmission = _q[1];
+    submissionError = _q[0],
+    setSubmissionError = _q[1];
   var _r = React.useState(null),
-    idFrontImage = _r[0],
-    setIdFrontImage = _r[1];
+    retrySubmission = _r[0],
+    setRetrySubmission = _r[1];
   var _s = React.useState(null),
-    idBackImage = _s[0],
-    setIdBackImage = _s[1];
+    idFrontImage = _s[0],
+    setIdFrontImage = _s[1];
   var _t = React.useState(null),
-    passportImage = _t[0],
-    setPassportImage = _t[1];
+    idBackImage = _t[0],
+    setIdBackImage = _t[1];
   var _u = React.useState(null),
-    selfieImage = _u[0],
-    setSelfieImage = _u[1];
+    passportImage = _u[0],
+    setPassportImage = _u[1];
   var _v = React.useState(null),
-    signatureData = _v[0],
-    setSignatureData = _v[1];
+    selfieImage = _v[0],
+    setSelfieImage = _v[1];
   var _w = React.useState(null),
-    signatureVideoUrl = _w[0],
-    setSignatureVideoUrl = _w[1];
+    signatureData = _w[0],
+    setSignatureData = _w[1];
   var _x = React.useState(null),
-    idCaptureVideoUrl = _x[0],
-    setIdCaptureVideoUrl = _x[1];
+    signatureVideoUrl = _x[0],
+    setSignatureVideoUrl = _x[1];
   var _y = React.useState(null),
-    additionalDocuments = _y[0],
-    setAdditionalDocuments = _y[1];
+    idCaptureVideoUrl = _y[0],
+    setIdCaptureVideoUrl = _y[1];
   var _z = React.useState(null),
-    geolocationResult = _z[0],
-    setGeolocationResult = _z[1];
-  var _0 = React.useState(0),
-    geolocationAttempts = _0[0],
-    setGeolocationAttempts = _0[1];
-  var _1 = React.useState(false),
-    geolocationBlocked = _1[0],
-    setGeolocationBlocked = _1[1];
-  var _2 = React.useState([]),
-    idFrontCaptureAttempts = _2[0],
-    setIdFrontCaptureAttempts = _2[1];
+    additionalDocuments = _z[0],
+    setAdditionalDocuments = _z[1];
+  var _0 = React.useState(null),
+    geolocationResult = _0[0],
+    setGeolocationResult = _0[1];
+  var _1 = React.useState(0),
+    geolocationAttempts = _1[0],
+    setGeolocationAttempts = _1[1];
+  var _2 = React.useState(false),
+    geolocationBlocked = _2[0],
+    setGeolocationBlocked = _2[1];
   var _3 = React.useState([]),
-    idBackCaptureAttempts = _3[0],
-    setIdBackCaptureAttempts = _3[1];
+    idFrontCaptureAttempts = _3[0],
+    setIdFrontCaptureAttempts = _3[1];
   var _4 = React.useState([]),
-    selfieCaptureAttempts = _4[0],
-    setSelfieCaptureAttempts = _4[1];
+    idBackCaptureAttempts = _4[0],
+    setIdBackCaptureAttempts = _4[1];
+  var _5 = React.useState([]),
+    selfieCaptureAttempts = _5[0],
+    setSelfieCaptureAttempts = _5[1];
   var logIdFrontCaptureAttempt = React.useCallback(function (attempt) {
     setIdFrontCaptureAttempts(function (attempts) {
       return tslib.__spreadArray(tslib.__spreadArray([], attempts, true), [attempt], false);
@@ -632,7 +634,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
                 needImmediateResponse: 'N',
                 deduplicationSynchronous: deduplicationSynchronous ? 'Y' : 'N',
                 verifyDataWithHost: verifyIdWithExternalDatabases ? 'Y' : 'N',
-                idBackImageRequired: 'N',
+                idBackImageRequired: idBackImageRequired ? 'Y' : 'N',
                 stripSpecialCharacters: webhooksStripSpecialCharacters ? 'Y' : 'N',
                 idImageResolutionCheck: 'Y'
               }
@@ -762,7 +764,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
         }
       });
     });
-  }, [action, additionalDocuments, cardData, companyId, deduplicationEnabled, deduplicationSynchronous, enrollmentId, environment, geolocationResult, idBackCaptureAttempts, idBackImage, idFrontCaptureAttempts, idFrontImage, idCaptureVideoUrl, manualReviewRequired, onBeforeSubmit, onRequestFailure, onResponseReceived, passportImage, personalData, selfieCaptureAttempts, selfieImage, signatureData, signatureVideoUrl, token, url, verifyIdWithExternalDatabases, webhooksClientTraceId, webhooksEnabled, webhooksStripSpecialCharacters]);
+  }, [action, manualReviewRequired, deduplicationEnabled, webhooksEnabled, deduplicationSynchronous, verifyIdWithExternalDatabases, idBackImageRequired, webhooksStripSpecialCharacters, idFrontImage, idBackImage, passportImage, selfieImage, companyId, personalData, cardData, enrollmentId, webhooksClientTraceId, signatureData, additionalDocuments, idCaptureVideoUrl, signatureVideoUrl, selfieCaptureAttempts, idFrontCaptureAttempts, idBackCaptureAttempts, geolocationResult, onBeforeSubmit, url, environment, token, onResponseReceived, onRequestFailure]);
   var checkLiveness = React.useCallback(function (imageDataUrl) {
     return tslib.__awaiter(void 0, void 0, void 0, function () {
       var request, host, endpoint, response, statusMessage, submissionResponse_3, e_2, err;
@@ -784,7 +786,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
           case 1:
             request = (_a.customerData = (_b.biometricData = (_c.selfie = _d.sent(), _c), _b), _a.additionalData = {
               uniqueRequestId: new Date().getTime().toString(),
-              stripSpecialCharacters: 'Y',
+              stripSpecialCharacters: webhooksStripSpecialCharacters ? 'Y' : 'N',
               estimateAge: 'N',
               predictGender: 'N'
             }, _a);
@@ -843,7 +845,7 @@ var SubmissionProvider = function SubmissionProvider(_a) {
         }
       });
     });
-  }, [environment, geolocationResult, idBackCaptureAttempts, idFrontCaptureAttempts, onRequestFailure, selfieCaptureAttempts, token, url]);
+  }, [environment, geolocationResult, idBackCaptureAttempts, idFrontCaptureAttempts, onRequestFailure, selfieCaptureAttempts, token, url, webhooksStripSpecialCharacters]);
   var retryLocationAccess = React.useCallback(function () {
     setGeolocationAttempts(function (n) {
       return n + 1;
@@ -12657,6 +12659,7 @@ var IdValidation = function IdValidation(_a) {
     submissionUrl = _a.submissionUrl,
     companyId = _a.companyId,
     manualReviewRequired = _a.manualReviewRequired,
+    idBackImageRequired = _a.idBackImageRequired,
     verifyIdWithExternalDatabases = _a.verifyIdWithExternalDatabases,
     personalData = _a.personalData,
     cardData = _a.cardData,
@@ -12748,6 +12751,7 @@ var IdValidation = function IdValidation(_a) {
     token: submissionToken,
     companyId: companyId,
     manualReviewRequired: manualReviewRequired,
+    idBackImageRequired: idBackImageRequired,
     verifyIdWithExternalDatabases: verifyIdWithExternalDatabases,
     personalData: personalData,
     cardData: cardData,
@@ -12846,6 +12850,7 @@ var IdAndFaceValidation = function IdAndFaceValidation(_a) {
     submissionUrl = _a.submissionUrl,
     companyId = _a.companyId,
     manualReviewRequired = _a.manualReviewRequired,
+    idBackImageRequired = _a.idBackImageRequired,
     verifyIdWithExternalDatabases = _a.verifyIdWithExternalDatabases,
     personalData = _a.personalData,
     cardData = _a.cardData,
@@ -12953,6 +12958,7 @@ var IdAndFaceValidation = function IdAndFaceValidation(_a) {
     token: submissionToken,
     companyId: companyId,
     manualReviewRequired: manualReviewRequired,
+    idBackImageRequired: idBackImageRequired,
     verifyIdWithExternalDatabases: verifyIdWithExternalDatabases,
     personalData: personalData,
     cardData: cardData,
@@ -12988,6 +12994,7 @@ var CustomerIdAndBiometricsEnrollment = function CustomerIdAndBiometricsEnrollme
     submissionUrl = _a.submissionUrl,
     companyId = _a.companyId,
     manualReviewRequired = _a.manualReviewRequired,
+    idBackImageRequired = _a.idBackImageRequired,
     verifyIdWithExternalDatabases = _a.verifyIdWithExternalDatabases,
     personalData = _a.personalData,
     cardData = _a.cardData,
@@ -13097,6 +13104,7 @@ var CustomerIdAndBiometricsEnrollment = function CustomerIdAndBiometricsEnrollme
     companyId: companyId,
     enrollmentId: enrollmentId,
     manualReviewRequired: manualReviewRequired,
+    idBackImageRequired: idBackImageRequired,
     verifyIdWithExternalDatabases: verifyIdWithExternalDatabases,
     personalData: personalData,
     cardData: cardData,