idmission-web-sdk 1.0.52 → 1.0.54

package/README.md

@@ -4,6 +4,26 @@ Demo: https://websdk2demo.idmission.com
 
 Storybook: https://websdk2test.idmission.com
 
+## Getting Started
+
+Before using the IDmission WebSDK, you should make sure you can fetch a token. New customers receive their token generation credentials via email. If you haven't received them, reach out to support@idmission.com.
+
+To test that your credentials are valid:
+```bash
+curl --location --request POST 'https://auth.idmission.com/auth/realms/identity/protocol/openid-connect/token' \
+    --header 'Content-Type: application/x-www-form-urlencoded' \
+    --data-urlencode 'grant_type=password' \
+    --data-urlencode 'client_id=' \
+    --data-urlencode 'client_secret=' \
+    --data-urlencode 'username=' \
+    --data-urlencode 'password=' \
+    --data-urlencode 'scope=api_access'
+```
+
+Prior to initializing the WebSDK on the client, you should generate a token on your server using these credentials. Be careful not to leak them on the client side! The generated token is safe to pass to the client, but the secrets used to generate them are not. If you have inadvertently leaked your client secret, react out to support@idmission.com to rotate your credentials.
+
+If you are using NodeJS, check out our [auth client for server-side JavaScript](https://www.npmjs.com/package/idmission-auth-client).
+
 ## Basic Usage in Typescript/React
 
 ```bash
@@ -22,7 +42,7 @@ render(<IdValidation submissionToken={YOUR_TOKEN} />, document.getElementById('r
 
 Add the following script tag to your page's `<head>`:
 ```html
-<script type=“module” src="https://websdk-cdn-dev.idmission.com/websdk/prod/loader.js"></script>
+<script type="module" src="https://websdk-cdn-dev.idmission.com/websdk/prod/loader.js"></script>
 ```
 
 You may subscribe to the `idmission-web-sdk.ready` event to be notified when loading has completed.
@@ -586,6 +606,90 @@ Render a fullscreen capture component that analyzes frames from the user's front
 IDmissionSDK.renderCustomerIdentification('#target-element', { submissionToken: 'my-idmission-token' });
 ```
 
+### VideoIdValidation
+
+Render a fullscreen capture component that performs IDValidation and FaceValidation sequentially, then captures a video of the user holding their ID, and optionally speaking a prompt aloud.
+
+**Props**
+
+<table>
+<tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
+<tr><td><code>submissionUrl</code> (optional)</td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>onBeforeSubmit</code> (optional)</td><td>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.</td></tr>
+<tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed the VideoIdValidation 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.</td></tr>
+<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after failing the realness check.</td></tr>
+<tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</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 the back of the ID card image will be considered in processing decisions. 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>
+<tr><td><code>webhooksEnabled</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked after submission.</td></tr>
+<tr><td><code>webhooksClientTraceId</code> (optional)</td><td>a customer provided trace id to use when invoking customer-configured webhooks.</td></tr>
+<tr><td><code>webhooksStripSpecialCharacters</code> (optional)</td><td>boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked.</td></tr>
+<tr><td><code>idCaptureProps</code> (optional)</td><td>object containing any overrides for IDValidation.</td></tr>
+<tr><td><code>faceLivenessProps</code> (optional)</td><td>object containing any overrides for IDValidation.</td></tr>
+<tr><td><code>idCardFrontDetectionThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for the ID card front during video capture. Defaults to 0.48.</td></tr>
+<tr><td><code>idCardFrontFocusThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for the ID card front during video capture. Defaults to 0.15.</td></tr>
+<tr><td><code>goodIdCardFrontFramesThreshold</code> (optional)</td><td>number of good frames of the ID card front that must be captured before moving on during video capture. Defaults to 3.</td></tr>
+<tr><td><code>showIdCardBackDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user is instructed to show the back of their ID card during video capture. Defaults to 5000ms.</td></tr>
+<tr><td><code>readTextPrompt</code> (optional)</td><td>an optional text prompt to display on screen for the user to read during video capture after the ID card has been shown. Leave blank to skip the read text screen.</td></tr>
+<tr><td><code>readTextTimeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user is allowed to spend reading the <code>readTextPrompt</code>. Defaults to 15000ms.</td></tr>
+<tr><td><code>skipSuccessScreen</code> (optional)</td><td>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.</td></tr>
+<tr><td><code>assets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Assets table below.</td></tr>
+<tr><td><code>colors</code> (optional)</td><td>object containing any asset overrides, for available options consult the Colors table below.</td></tr>
+<tr><td><code>verbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Verbiage table below.</td></tr>
+<tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Default is `true`.</td></tr>
+<tr><td><code>geolocationRequired</code> (optional)</td><td>boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`.</td></tr>
+<tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Default is `false`.</td></tr>
+</table>
+
+**Video ID Validation Assets**
+
+<table>
+<tr><td><code>idCapture</code> (optional)</td><td>object containing any asset overrides, for available options consult the ID Capture Assets table above.</td></tr>
+<tr><td><code>faceLiveness</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
+<tr><td><code>videoIdCapture.guides.frontImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Front-SVG-Landscape-2.svg</td></tr>
+<tr><td><code>videoIdCapture.guides.backImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Back-SVG-Landscape-2.svg</td></tr>
+</table>
+
+**Video ID Validation Colors**
+
+<table>
+<tr><td><code>idCapture</code> (optional)</td><td>object containing any color overrides, for available options consult the ID Capture Colors table above.</td></tr>
+<tr><td><code>faceLiveness</code> (optional)</td><td>object containing any color overrides, for available options consult the Face Liveness Colors table above.</td></tr>
+<tr><td><code>idVideoCapture.guidesSatisfiedColor</code></td><td>Default: green</td></tr>
+<tr><td><code>idVideoCapture.guidesUnsatisfiedColor</code></td><td>Default: white</td></tr>
+<tr><td><code>idVideoCapture.readTextDoneBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
+<tr><td><code>idVideoCapture.readTextDoneBtn.textColor</code></td><td>Default: white</td></tr>
+<tr><td><code>success.doneBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
+<tr><td><code>success.doneBtn.textColor</code></td><td>Default: white</td></tr>
+<tr><td><code>success.retryBtn.backgroundColor</code></td><td>Default: #ea8557</td></tr>
+<tr><td><code>success.retryBtn.textColor</code></td><td>Default: white</td></tr>
+</table>
+
+**Video ID Validation Verbiage**
+
+<table>
+<tr><td><code>idCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the ID Capture Verbiage table above.</td></tr>
+<tr><td><code>faceLiveness</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</td></tr>
+<tr><td><code>idVideoCapture.guides.idFrontInstructionText</code></td><td>Default: "Display the front of your ID card..."</td></tr>
+<tr><td><code>idVideoCapture.guides.idBackInstructionText</code></td><td>Default: "Display the back of your ID card..."</td></tr>
+<tr><td><code>idVideoCapture.guides.flipIdInstructionText</code></td><td>Default: "Please flip your ID card..."</td></tr>
+<tr><td><code>idVideoCapture.readTextHeading</code></td><td>Default: "Please read the following text aloud"</td></tr>
+<tr><td><code>idVideoCapture.readTextDoneBtnText</code></td><td>Default: "Done"</td></tr>
+<tr><td><code>success.headingText</code></td><td>Default: "Video ID has been successfully captured!"</td></tr>
+<tr><td><code>success.retryBtnText</code></td><td>Default: "Retry"</td></tr>
+<tr><td><code>success.doneBtnText</code></td><td>Default: "Done"</td></tr>
+</table>
+
+**Example**
+
+```js
+IDmissionSDK.renderVideoIdValidation('#target-element', { submissionToken: 'my-idmission-token' });
+```
+
 ## Other Functionality
 
 ### Detecting the current version of the IDmission Web SDK

package/dist/sdk2.cjs.development.js

@@ -48,7 +48,7 @@ var LanguageDetector__default = /*#__PURE__*/_interopDefaultLegacy(LanguageDetec
 var i18n__default = /*#__PURE__*/_interopDefaultLegacy(i18n);
 var SignatureCanvas__default = /*#__PURE__*/_interopDefaultLegacy(SignatureCanvas);
 
-var webSdkVersion = '1.0.52';
+var webSdkVersion = '1.0.54';
 
 function getPlatform() {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -14907,18 +14907,23 @@ var VideoIdValidation = function VideoIdValidation(_a) {
     onExitAfterFailure = _a.onExitAfterFailure,
     idCaptureProps = _a.idCaptureProps,
     faceLivenessProps = _a.faceLivenessProps,
-    idCardFrontDetectionThreshold = _a.idCardFrontDetectionThreshold,
-    idCardFrontFocusThreshold = _a.idCardFrontFocusThreshold,
-    goodIdCardFrontFramesThreshold = _a.goodIdCardFrontFramesThreshold,
-    showIdCardBackDurationMs = _a.showIdCardBackDurationMs,
+    _c = _a.idCardFrontDetectionThreshold,
+    idCardFrontDetectionThreshold = _c === void 0 ? 0.48 : _c,
+    _d = _a.idCardFrontFocusThreshold,
+    idCardFrontFocusThreshold = _d === void 0 ? 0.15 : _d,
+    _e = _a.goodIdCardFrontFramesThreshold,
+    goodIdCardFrontFramesThreshold = _e === void 0 ? 3 : _e,
+    _f = _a.showIdCardBackDurationMs,
+    showIdCardBackDurationMs = _f === void 0 ? 5000 : _f,
     readTextPrompt = _a.readTextPrompt,
-    readTextTimeoutDurationMs = _a.readTextTimeoutDurationMs,
-    _c = _a.skipSuccessScreen,
-    skipSuccessScreen = _c === void 0 ? false : _c,
+    _g = _a.readTextTimeoutDurationMs,
+    readTextTimeoutDurationMs = _g === void 0 ? 15000 : _g,
+    _h = _a.skipSuccessScreen,
+    skipSuccessScreen = _h === void 0 ? false : _h,
     geolocationEnabled = _a.geolocationEnabled,
     geolocationRequired = _a.geolocationRequired,
-    _d = _a.debugMode,
-    debugMode = _d === void 0 ? false : _d;
+    _j = _a.debugMode,
+    debugMode = _j === void 0 ? false : _j;
   useLanguage(lang);
   return /*#__PURE__*/React__default['default'].createElement(SubmissionProvider, {
     action: SubmissionAction.VALIDATE,