idmission-web-sdk 2.0.5 → 2.0.6

package/{README.md → README.mdx}

@@ -66,6 +66,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 **Props**
 
 <table>
+<tbody>
 <tr><td><code>sessionId</code></td><td>a session id generated with your IDmission credentials, or an async function that resolves to one.</td></tr>
 <tr><td><code>authUrl</code> (optional)</td><td>URL to authenticate against. Default: https://portal-api.idmission.com</td></tr>
 <tr><td><code>submissionUrl</code> (optional)</td><td>URL to submit data to. Default: https://portal-api.idmission.com/swagger</td></tr>
@@ -122,11 +123,13 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Defaults to 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. Defaults to false.</td></tr>
 <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Defaults to false.</td></tr>
+</tbody>
 </table>
 
 **ID Capture Assets**
 
 <table>
+<tbody>
 <tr><td><code>documentDetectionModelUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/models/documentdetection448/model.json</td></tr>
 <tr><td><code>focusModelUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/models/focus/model.json</td></tr>
 <tr><td><code>loadingOverlay.instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/WebSDK-Instruction-DL-Capture-3-Portrait.png</td></tr>
@@ -141,10 +144,12 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <tr><td><code>flipIdPrompt.frontLandscapeGuidesImageUrl</code></td><td>Default: value of idCardFront.landscapeGuidesImageUrl</td></tr>
 <tr><td><code>flipIdPrompt.backPortraitGuidesImageUrl</code></td><td>Default: value of idCardBack.portraitGuidesImageUrl</td></tr>
 <tr><td><code>flipIdPrompt.backLandscapeGuidesImageUrl</code></td><td>Default: value of idCardBack.landscapeGuidesImageUrl</td></tr>
+</tbody>
 </table>
 
 **ID Capture Colors**
 <table>
+<tbody>
 <tr><td><code>loadingOverlay.continueBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
 <tr><td><code>loadingOverlay.continueBtn.textColor</code></td><td>Default: white</td></tr>
 <tr><td><code>loadingOverlay.continueBtn.loadingBackgroundColor</code></td><td>Default: gray</td></tr>
@@ -159,11 +164,13 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <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>
+</tbody>
 </table>
 
 **ID Capture Verbiage**
 
 <table>
+<tbody>
 <tr><td><code>loadingOverlay.headingText</code></td><td>Default: "Use your device camera to capture your ID"</td></tr>
 <tr><td><code>loadingOverlay.useContinuityCameraText</code></td><td>Default: "Use your iPhone as a webcam"</td></tr>
 <tr><td><code>loadingOverlay.modelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
@@ -202,6 +209,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <tr><td><code>success.retryText</code></td><td>Default: "Retry"</td></tr>
 <tr><td><code>success.submittingText</code></td><td>Default: "Submitting..."</td></tr>
 <tr><td><code>success.submitText</code></td><td>Default: "Submit"</td></tr>
+</tbody>
 </table>
 
 **Example**
@@ -225,6 +233,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 **Props**
 
 <table>
+<tbody>
 <tr><td><code>sessionId</code></td><td>a session id generated with your IDmission credentials, or an async function that resolves to one.</td></tr>
 <tr><td><code>authUrl</code> (optional)</td><td>URL to authenticate against. Default: https://portal-api.idmission.com</td></tr>
 <tr><td><code>submissionUrl</code> (optional)</td><td>URL to submit data to. Default: https://portal-api.idmission.com/swagger</td></tr>
@@ -260,19 +269,23 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Defaults to 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. Defaults to false.</td></tr>
 <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Defaults to false.</td></tr>
+</tbody>
 </table>
 
 **Face Liveness Assets**
 
 <table>
+<tbody>
 <tr><td><code>loadingOverlay.instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png</td></tr>
 <tr><td><code>loadingOverlay.cameraAccessDenied.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png</td></tr>
 <tr><td><code>failure.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/manual_capture.png</td></tr>
+</tbody>
 </table>
 
 **Face Liveness Colors**
 
 <table>
+<tbody>
 <tr><td><code>loadingOverlay.continueBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
 <tr><td><code>loadingOverlay.continueBtn.textColor</code></td><td>Default: white</td></tr>
 <tr><td><code>loadingOverlay.continueBtn.loadingBackgroundColor</code></td><td>Default: gray</td></tr>
@@ -293,11 +306,13 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>failure.retryBtn.textColor</code></td><td>Default: white</td></tr>
 <tr><td><code>failure.exitBtn.backgroundColor</code></td><td>Default: #666</td></tr>
 <tr><td><code>failure.exitBtn.textColor</code></td><td>Default: white</td></tr>
+</tbody>
 </table>
 
 **Face Liveness Verbiage**
 
 <table>
+<tbody>
 <tr><td><code>loadingOverlay.headingText</code></td><td>Default: "Use your device camera to capture your face"</td></tr>
 <tr><td><code>loadingOverlay.removeEyeCoveringsText</code></td><td>Default: "Remove Sunglasses & Hat"</td></tr>
 <tr><td><code>loadingOverlay.avoidExcessiveBacklightingText</code></td><td>Default: "Avoid Excessive Backlighting"</td></tr>
@@ -322,6 +337,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>failure.headingText</code></td><td>Default: "Live face not detected, please try again"</td></tr>
 <tr><td><code>failure.retryBtnText</code></td><td>Default: "Retry"</td></tr>
 <tr><td><code>failure.exitBtnText</code></td><td>Default: "Exit"</td></tr>
+</tbody>
 </table>
 
 **Example**
@@ -345,6 +361,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 **Props**
 
 <table>
+<tbody>
 <tr><td><code>sessionId</code></td><td>a session id generated with your IDmission credentials, or an async function that resolves to one.</td></tr>
 <tr><td><code>authUrl</code> (optional)</td><td>URL to authenticate against. Default: https://portal-api.idmission.com</td></tr>
 <tr><td><code>submissionUrl</code> (optional)</td><td>URL to submit data to. Default: https://portal-api.idmission.com/swagger</td></tr>
@@ -410,6 +427,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Defaults to 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. Defaults to false.</td></tr>
 <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Defaults to false.</td></tr>
+</tbody>
 </table>
 
 **Example**
@@ -433,6 +451,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 **Props**
 
 <table>
+<tbody>
 <tr><td><code>sessionId</code></td><td>a session id generated with your IDmission credentials, or an async function that resolves to one.</td></tr>
 <tr><td><code>authUrl</code> (optional)</td><td>URL to authenticate against. Default: https://portal-api.idmission.com</td></tr>
 <tr><td><code>submissionUrl</code> (optional)</td><td>URL to submit data to. Default: https://portal-api.idmission.com/swagger</td></tr>
@@ -472,7 +491,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>needImmediateResponse</code> (optional)</td><td>boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true.</td></tr>
 <tr><td><code>manualReviewRequired</code> (optional)</td><td>boolean flag to indicate whether responses should always be reviewed by a human. Defaults to false.</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>idImageResolutionCheck</code> (optional)</td><td>boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Default is false/td></tr>
+<tr><td><code>idImageResolutionCheck</code> (optional)</td><td>boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Default is false</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. Defaults to false.</td></tr>
 <tr><td><code>bypassAgeValidation</code> (optional)</td><td>boolean to indicate whether end-users under the age of 18 should be allowed through validation. Defaults to false.</td></tr>
 <tr><td><code>bypassNameMatching</code> (optional)</td><td>boolean to indicate if matching the name in the request against the name extracted from the ID should be bypassed. Defaults to true.</td></tr>
@@ -501,6 +520,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Defaults to 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. Defaults to false.</td></tr>
 <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Defaults to false.</td></tr>
+</tbody>
 </table>
 
 **Example**
@@ -519,6 +539,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 **Props**
 
 <table>
+<tbody>
 <tr><td><code>sessionId</code></td><td>a session id generated with your IDmission credentials, or an async function that resolves to one.</td></tr>
 <tr><td><code>authUrl</code> (optional)</td><td>URL to authenticate against. Default: https://portal-api.idmission.com</td></tr>
 <tr><td><code>submissionUrl</code> (optional)</td><td>URL to submit data to. Default: https://portal-api.idmission.com/swagger</td></tr>
@@ -564,6 +585,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 <tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Defaults to 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. Defaults to false.</td></tr>
 <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Defaults to false.</td></tr>
+</tbody>
 </table>
 
 **Example**
@@ -582,6 +604,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 **Props**
 
 <table>
+<tbody>
 <tr><td><code>sessionId</code></td><td>a session id generated with your IDmission credentials, or an async function that resolves to one.</td></tr>
 <tr><td><code>authUrl</code> (optional)</td><td>URL to authenticate against. Default: https://portal-api.idmission.com</td></tr>
 <tr><td><code>submissionUrl</code> (optional)</td><td>URL to submit data to. Default: https://portal-api.idmission.com/swagger</td></tr>
@@ -618,6 +641,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Defaults to 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. Defaults to false.</td></tr>
 <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Defaults to false.</td></tr>
+</tbody>
 </table>
 
 **Example**
@@ -636,6 +660,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 **Props**
 
 <table>
+<tbody>
 <tr><td><code>sessionId</code></td><td>a session id generated with your IDmission credentials, or an async function that resolves to one.</td></tr>
 <tr><td><code>authUrl</code> (optional)</td><td>URL to authenticate against. Default: https://portal-api.idmission.com</td></tr>
 <tr><td><code>submissionUrl</code> (optional)</td><td>URL to submit data to. Default: https://portal-api.idmission.com/swagger</td></tr>
@@ -671,19 +696,23 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Defaults to 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. Defaults to false.</td></tr>
 <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Defaults to false.</td></tr>
+</tbody>
 </table>
 
 **Customer Identification Assets**
 
 <table>
+<tbody>
 <tr><td><code>loadingOverlay.instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png</td></tr>
 <tr><td><code>loadingOverlay.cameraAccessDenied.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png</td></tr>
 <tr><td><code>failure.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/manual_capture.png</td></tr>
+</tbody>
 </table>
 
 **Customer Identification Colors**
 
 <table>
+<tbody>
 <tr><td><code>loadingOverlay.continueBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
 <tr><td><code>loadingOverlay.continueBtn.textColor</code></td><td>Default: white</td></tr>
 <tr><td><code>loadingOverlay.continueBtn.loadingBackgroundColor</code></td><td>Default: gray</td></tr>
@@ -704,11 +733,13 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>failure.retryBtn.textColor</code></td><td>Default: white</td></tr>
 <tr><td><code>failure.exitBtn.backgroundColor</code></td><td>Default: #666</td></tr>
 <tr><td><code>failure.exitBtn.textColor</code></td><td>Default: white</td></tr>
+</tbody>
 </table>
 
 **Customer Identification Verbiage**
 
 <table>
+<tbody>
 <tr><td><code>loadingOverlay.headingText</code></td><td>Default: "Use your device camera to capture your face"</td></tr>
 <tr><td><code>loadingOverlay.removeEyeCoveringsText</code></td><td>Default: "Remove Sunglasses & Hat"</td></tr>
 <tr><td><code>loadingOverlay.avoidExcessiveBacklightingText</code></td><td>Default: "Avoid Excessive Backlighting"</td></tr>
@@ -730,6 +761,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>failure.headingText</code></td><td>Default: "Customer not found"</td></tr>
 <tr><td><code>failure.retryBtnText</code></td><td>Default: "Retry"</td></tr>
 <tr><td><code>failure.exitBtnText</code></td><td>Default: "Exit"</td></tr>
+</tbody>
 </table>
 
 **Example**
@@ -745,6 +777,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 **Props**
 
 <table>
+<tbody>
 <tr><td><code>sessionId</code></td><td>a session id generated with your IDmission credentials, or an async function that resolves to one.</td></tr>
 <tr><td><code>authUrl</code> (optional)</td><td>URL to authenticate against. Default: https://portal-api.idmission.com</td></tr>
 <tr><td><code>submissionUrl</code> (optional)</td><td>URL to submit data to. Default: https://portal-api.idmission.com/swagger</td></tr>
@@ -807,20 +840,24 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Defaults to 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. Defaults to false.</td></tr>
 <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Defaults to false.</td></tr>
+</tbody>
 </table>
 
 **Video ID Validation Assets**
 
 <table>
+<tbody>
 <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>
+</tbody>
 </table>
 
 **Video ID Validation Colors**
 
 <table>
+<tbody>
 <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>
@@ -831,11 +868,13 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <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>
+</tbody>
 </table>
 
 **Video ID Validation Verbiage**
 
 <table>
+<tbody>
 <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>
@@ -846,6 +885,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <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>
+</tbody>
 </table>
 
 **Example**
@@ -951,6 +991,7 @@ Many customer flow documented above include a `captureAdditionalDocuments` prope
 **Additional Document Properties**
 
 <table>
+<tbody>
 <tr>
 <td><code>name</code></td><td>string indicating the name of document to be captured</td>
 </tr>
@@ -963,4 +1004,8 @@ Many customer flow documented above include a `captureAdditionalDocuments` prope
 <tr>
 <td><code>processAsPOA</code> (optional)</td><td>boolean indicating whether the document should be treated as a proof of address -- when true, the document will be processed and validated on the server.</td>
 </tr>
-</table>
+</tbody>
+</table>
+
+import Test from "./test.mdx";
+<Test />

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 = '2.0.5';
+var webSdkVersion = '2.0.6';
 
 function getPlatform() {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment