idmission-web-sdk 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 MacKinley Smith <smithmackinley@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,398 @@
+# sdk2
+
+## Basic Usage in Typescript/React
+
+```jsx
+import React from 'react'
+import { render } from 'react-dom'
+import { IdValidation } from 'idmission-web-sdk-2'
+
+render(<IdValidation submissionToken={YOUR_TOKEN} />, document.getElementById('root'))
+```
+
+## Basic Usage in HTML
+
+Add the following script tag to your page's `<head>`:
+```html
+<script type="module" src="https://websdk-cdn-dev.idmission.com/assets/loader.js"></script>
+```
+
+Then you may call any render method below, for example `renderIdValidation`, like so:
+```html
+<script type="module">
+    IDmissionSDK.renderIdValidation('#target-element', { submissionToken: 'my-idmission-token' });
+</script>
+```
+
+## Customer Flows
+
+### IDValidation
+
+Render a fullscreen ID capture component that instructs the user to photograph both sides of their ID card, or full page of their passport.
+
+**Props**
+
+<table>
+<tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
+<tr><td><code>submissionUrl</code></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 completes the IDValidation flow. 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.</td></tr>
+<tr><td><code>onApproved</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow with a valid ID. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling.</td></tr>
+<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow with an invalid ID. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling.</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>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
+<tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
+<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
+<tr><td><code>documentDetectionNonMaxSuppressionEnabled</code> (optional)</td><td>boolean to indicate whether to remove document predictions below the max score.</td></tr>
+<tr><td><code>idAutoCaptureEnabled</code> (optional)</td><td>boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`.</td></tr>
+<tr><td><code>idCardAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards.</td></tr>
+<tr><td><code>passportAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for passports.</td></tr>
+<tr><td><code>idCardFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards.</td></tr>
+<tr><td><code>passportFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for passports.</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>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>
+
+**ID Capture Assets**
+
+<table>
+<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>loadingOverlayInstructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/WebSDK-Instruction-DL-Capture-3-Portrait.png</td></tr>
+<tr><td><code>idCardFrontPortraitGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Front-SVG-Portrait-2.svg</td></tr>
+<tr><td><code>idCardFrontLandscapeGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Landscape-SVG-Portrait-2.svg</td></tr>
+<tr><td><code>idCardBackPortraitGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Back-SVG-Portrait-2.svg</td></tr>
+<tr><td><code>idCardBackLandscapeGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Back-SVG-Landscape-2.svg</td></tr>
+<tr><td><code>passportPortraitGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-Passport-Front-SVG-Portrait-2.svg</td></tr>
+<tr><td><code>passportLandscapeGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-Passport-Front-SVG-Landscape-2.svg</td></tr>
+</table>
+
+**ID Capture Verbiage**
+
+<table>
+<tr><td><code>loadingOverlayHeadingText</code></td><td>Default: "Use your device camera to capture your ID"</td></tr>
+<tr><td><code>loadingOverlayUseContinuityCameraText</code></td><td>Default: "Use your iPhone as a webcam"</td></tr>
+<tr><td><code>loadingOverlayModelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
+<tr><td><code>loadingOverlayCameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
+<tr><td><code>loadingOverlayCameraAccessBlockedText</code></td><td>Default: "Camera access blocked"</td></tr>
+<tr><td><code>loadingOverlayContinueText</code></td><td>Default: "Continue"</td></tr>
+<tr><td><code>idCardFrontInstructionText</code></td><td>Default: "Scan the front of ID"</td></tr>
+<tr><td><code>idCardBackInstructionText</code></td><td>Default: "Scan the back of ID"</td></tr>
+<tr><td><code>passportInstructionText</code></td><td>Default: "Scan the ID page of passport"</td></tr>
+<tr><td><code>flipIdInstructionText</code></td><td>Default: "Please flip your ID card..."</td></tr>
+<tr><td><code>capturingText</code></td><td>Default: "Capturing..."</td></tr>
+<tr><td><code>captureFailedText</code></td><td>Default: "Capture failed!"</td></tr>
+<tr><td><code>signatureCaptureHeadingText</code></td><td>Default: "Please sign the box below"</td></tr>
+<tr><td><code>signatureCaptureAcceptBtnText</code></td><td>Default: "Accept"</td></tr>
+<tr><td><code>signatureCaptureClearBtnText</code></td><td>Default: "Clear"</td></tr>
+<tr><td><code>additionalDocumentsHeadingText</code></td><td>Default: "Additional document capture"</td></tr>
+<tr><td><code>additionalDocumentsNextBtnText</code></td><td>Default: "Next"</td></tr>
+<tr><td><code>successHeadingText</code></td><td>Default: "ID Capture Successful"</td></tr>
+<tr><td><code>successIdCardFrontText</code></td><td>Default: "ID Card Front"</td></tr>
+<tr><td><code>successIdCardBackText</code></td><td>Default: "ID Card Back"</td></tr>
+<tr><td><code>successPassportText</code></td><td>Default: "Passport"</td></tr>
+<tr><td><code>successInstructionText</code></td><td>Default: "Verify the entire ID was captured clearly with no glare."</td></tr>
+<tr><td><code>successRetryText</code></td><td>Default: "Retry"</td></tr>
+<tr><td><code>successSubmittingText</code></td><td>Default: "Submitting..."</td></tr>
+<tr><td><code>successSubmitText</code></td><td>Default: "Submit"</td></tr>
+</table>
+
+**Example**
+
+```js
+IDmissionSDK.renderIdValidation('#target-element', {
+    submissionToken: 'my-idmission-token',
+    onApproved: (submissionResponse) => {
+        alert('Your ID has been validated, proceed to the next checkpoint.')
+    },
+    onDenied: (submissionResponse) => {
+        alert('Your ID could not be validated, you shall not pass!')
+    },
+});
+```
+
+### FaceValidation
+
+Render a fullscreen capture component that analyzes frames from the user's front-facing camera to determine whether a live human face is present.
+
+**Props**
+
+<table>
+<tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
+<tr><td><code>submissionUrl</code></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 FaceValidation flow. 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.</td></tr>
+<tr><td><code>onApproved</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow and passes the realness check. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling.</td></tr>
+<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow and fails the realness check. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling.</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>timeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds).</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>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>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>
+
+**Face Liveness Assets**
+
+<table>
+<tr><td><code>instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png</td></tr>
+<tr><td><code>failureImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/manual_capture.png</td></tr>
+</table>
+
+**Face Liveness Verbiage**
+
+<table>
+<tr><td><code>loadingOverlayHeadingText</code></td><td>Default: "Use your device camera to capture your face"</td></tr>
+<tr><td><code>loadingOverlayRemoveEyeCoveringsText</code></td><td>Default: "Remove Sunglasses & Hat"</td></tr>
+<tr><td><code>loadingOverlayAvoidExcessiveBacklightingText</code></td><td>Default: "Avoid Excessive Backlighting"</td></tr>
+<tr><td><code>loadingOverlayContinueText</code></td><td>Default: "Continue"</td></tr>
+<tr><td><code>loadingOverlayCameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
+<tr><td><code>loadingOverlayModelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
+<tr><td><code>guidanceHoldStillText</code></td><td>Default: "Hold still for a few seconds..."</td></tr>
+<tr><td><code>guidanceLookStraightText</code></td><td>Default: "Look straight into the camera..."</td></tr>
+<tr><td><code>guidanceMoveBackText</code></td><td>Default: "Move back..."</td></tr>
+<tr><td><code>guidanceMoveForwardText</code></td><td>Default: "Move forward..."</td></tr>
+<tr><td><code>guidanceMoveToCenterText</code></td><td>Default: "Move to the center..."</td></tr>
+<tr><td><code>guidanceRemoveEyeCoveringsText</code></td><td>Default: "Please remove your eye coverings (sunglasses, eye patch, etc.)..."</td></tr>
+<tr><td><code>guidanceRemoveHeadCoveringsText</code></td><td>Default: "Please remove your head coverings (hat, scarf, etc.)..."</td></tr>
+<tr><td><code>guidanceRemoveMaskText</code></td><td>Default: "Please remove your mask..."</td></tr>
+<tr><td><code>successHeadingText</code></td><td>Default: "Face liveness has been verified!"</td></tr>
+<tr><td><code>successRetryBtnText</code></td><td>Default: "Retry"</td></tr>
+<tr><td><code>successDoneBtnText</code></td><td>Default: "Done"</td></tr>
+<tr><td><code>failureHeadingText</code></td><td>Default: "Live face not detected, please try again"</td></tr>
+<tr><td><code>failureRetryBtnText</code></td><td>Default: "Retry"</td></tr>
+<tr><td><code>failureExitBtnText</code></td><td>Default: "Exit"</td></tr>
+</table>
+
+**Example**
+
+```js
+IDmissionSDK.renderFaceValidation('#target-element', {
+    submissionToken: 'my-idmission-token',
+    onApproved: (submissionResponse) => {
+        alert('Your face is real, proceed to the next checkpoint.')
+    },
+    onDenied: (submissionResponse) => {
+        alert('Your face realness could not be validated, you shall not pass!')
+    },
+});
+```
+
+### IdAndFaceValidation
+
+Render a fullscreen capture component that performs IDValidation and FaceValidation sequentially.
+
+**Props**
+
+<table>
+<tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
+<tr><td><code>submissionUrl</code></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 both flows. 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.</td></tr>
+<tr><td><code>onApproved</code> (optional)</td><td>callback function that fires when the user completes both flows with a valid ID and passes the realness check. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling.</td></tr>
+<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user completes both flows with an invalid ID or fails the realness check. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling.</td></tr>
+<tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
+<tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
+<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</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>documentDetectionNonMaxSuppressionEnabled</code> (optional)</td><td>boolean to indicate whether to remove document predictions below the max score.</td></tr>
+<tr><td><code>idAutoCaptureEnabled</code> (optional)</td><td>boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`.</td></tr>
+<tr><td><code>idCardAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards.</td></tr>
+<tr><td><code>passportAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for passports.</td></tr>
+<tr><td><code>idCardFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards.</td></tr>
+<tr><td><code>passportFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for passports.</td></tr>
+<tr><td><code>faceLivenessTimeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds).</td></tr>
+<tr><td><code>idCaptureAssets</code> (optional)</td><td>object containing any asset overrides, for available options consult the ID Capture Assets table above.</td></tr>
+<tr><td><code>idCaptureVerbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the ID Capture Verbiage table above.</td></tr>
+<tr><td><code>faceLivenessAssets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
+<tr><td><code>faceLivenessVerbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</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>
+
+**Example**
+
+```js
+IDmissionSDK.renderIdAndFaceValidation('#target-element', {
+    submissionToken: 'my-idmission-token',
+    onApproved: (submissionResponse) => {
+        alert('Your ID has been validated and your face is real, proceed to the next checkpoint.')
+    },
+    onDenied: (submissionResponse) => {
+        alert('Your ID or face realness could not be validated, you shall not pass!')
+    },
+});
+```
+
+### CustomerIdAndBiometricsEnrollment
+
+Render a fullscreen capture component that performs IDValidation and FaceValidation sequentially, and then stores the results in IDmission's customer database using the supplied `enrollmentId` for later verification or 1:N matching.
+
+**Props**
+
+<table>
+<tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
+<tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>enrollmentId</code></td><td>the unique identifier to use for the customer to be enrolled.</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 CustomerIdAndBiometricsEnrollment flow. 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.</td></tr>
+<tr><td><code>onEnrolled</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow successfully. 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.</td></tr>
+<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow but could not be enrolled. 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.</td></tr>
+<tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
+<tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
+<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</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>documentDetectionNonMaxSuppressionEnabled</code> (optional)</td><td>boolean to indicate whether to remove document predictions below the max score.</td></tr>
+<tr><td><code>idAutoCaptureEnabled</code> (optional)</td><td>boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`.</td></tr>
+<tr><td><code>idCardAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards.</td></tr>
+<tr><td><code>passportAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for passports.</td></tr>
+<tr><td><code>idCardFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards.</td></tr>
+<tr><td><code>passportFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for passports.</td></tr>
+<tr><td><code>faceLivenessTimeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds).</td></tr>
+<tr><td><code>idCaptureAssets</code> (optional)</td><td>object containing any asset overrides, for available options consult the ID Capture Assets table above.</td></tr>
+<tr><td><code>idCaptureVerbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the ID Capture Verbiage table above.</td></tr>
+<tr><td><code>faceLivenessAssets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
+<tr><td><code>faceLivenessVerbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</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>
+
+**Example**
+
+```js
+IDmissionSDK.renderCustomerIdAndBiometricsEnrollment('#target-element', {
+    submissionToken: 'my-idmission-token',
+    enrollmentId: 'some-guy',
+});
+```
+
+### CustomerBiometricsEnrollment
+
+Render a fullscreen capture component that performs FaceValidation, and then stores the results in IDmission's customer database using the supplied `enrollmentId` for later verification or 1:N matching.
+
+**Props**
+
+<table>
+<tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
+<tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>enrollmentId</code></td><td>the unique identifier to use for the customer to be enrolled.</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 CustomerIdAndBiometricsEnrollment flow. 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.</td></tr>
+<tr><td><code>onEnrolled</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow successfully. 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.</td></tr>
+<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow but could not be enrolled. 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.</td></tr>
+<tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
+<tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
+<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</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>timeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds).</td></tr>
+<tr><td><code>assets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
+<tr><td><code>verbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</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>
+
+**Example**
+
+```js
+IDmissionSDK.renderCustomerBiometricsEnrollment('#target-element', {
+    submissionToken: 'my-idmission-token',
+    enrollmentId: 'some-guy',
+});
+```
+
+### CustomerVerification
+
+Render a fullscreen capture component that analyzes frames from the user's front-facing camera to determine whether the user matches a specified `enrollmentId` that they have previously registered in IDmission's customer database.
+
+**Props**
+
+<table>
+<tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
+<tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
+<tr><td><code>enrollmentId</code></td><td>the unique identifier to match from previously enrolled customers.</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 CustomerVerification flow. 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.</td></tr>
+<tr><td><code>onCustomerMatched</code> (optional)</td><td>callback function that fires when the user has completed the CustomerVerification flow and matches the specified customer <code>enrollmentId</code>. 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.</td></tr>
+<tr><td><code>onCustomerNotMatched</code> (optional)</td><td>callback function that fires when the user has completed the CustomerVerification flow but does not match the specified customer <code>enrollmentId</code>. 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.</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>timeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds).</td></tr>
+<tr><td><code>assets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
+<tr><td><code>verbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</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>
+
+**Example**
+
+```js
+IDmissionSDK.renderCustomerVerification('#target-element', {
+    submissionToken: 'my-idmission-token',
+    enrollmentId: 'some-guy',
+});
+```
+
+### CustomerIdentification
+
+Render a fullscreen capture component that analyzes frames from the user's front-facing camera to determine whether the user matches any previously registered customer in IDmission's customer database.
+
+**Props**
+
+<table>
+<tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
+<tr><td><code>submissionUrl</code></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 CustomerIdentification flow. 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.</td></tr>
+<tr><td><code>onCustomerMatched</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdentification flow and matches a pre-registered customer <code>enrollmentId</code> in IDmission's database. 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.</td></tr>
+<tr><td><code>onCustomerNotMatched</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdentification flow but does not match any registered customer. 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.</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>assets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Assets 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>
+
+**Customer Identification Assets**
+
+<table>
+<tr><td><code>instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png</td></tr>
+<tr><td><code>failureImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/manual_capture.png</td></tr>
+</table>
+
+**Customer Identification Verbiage**
+
+<table>
+<tr><td><code>loadingOverlayHeadingText</code></td><td>Default: "Use your device camera to capture your face"</td></tr>
+<tr><td><code>loadingOverlayRemoveEyeCoveringsText</code></td><td>Default: "Remove Sunglasses & Hat"</td></tr>
+<tr><td><code>loadingOverlayAvoidExcessiveBacklightingText</code></td><td>Default: "Avoid Excessive Backlighting"</td></tr>
+<tr><td><code>loadingOverlayContinueText</code></td><td>Default: "Continue"</td></tr>
+<tr><td><code>loadingOverlayCameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
+<tr><td><code>loadingOverlayModelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
+<tr><td><code>guidanceHoldStillText</code></td><td>Default: "Hold still for a few seconds..."</td></tr>
+<tr><td><code>guidanceLookStraightText</code></td><td>Default: "Look straight into the camera..."</td></tr>
+<tr><td><code>guidanceMoveBackText</code></td><td>Default: "Move back..."</td></tr>
+<tr><td><code>guidanceMoveForwardText</code></td><td>Default: "Move forward..."</td></tr>
+<tr><td><code>guidanceMoveToCenterText</code></td><td>Default: "Move to the center..."</td></tr>
+<tr><td><code>successHeadingText</code></td><td>Default: "Customer has been identified!"</td></tr>
+<tr><td><code>successRetryBtnText</code></td><td>Default: "Retry"</td></tr>
+<tr><td><code>successDoneBtnText</code></td><td>Default: "Done"</td></tr>
+<tr><td><code>failureHeadingText</code></td><td>Default: "Customer not found"</td></tr>
+<tr><td><code>failureRetryBtnText</code></td><td>Default: "Retry"</td></tr>
+<tr><td><code>failureExitBtnText</code></td><td>Default: "Exit"</td></tr>
+</table>
+
+**Example**
+
+```js
+IDmissionSDK.renderCustomerIdentification('#target-element', { submissionToken: 'my-idmission-token' });
+```

package/dist/components/CompositeWizard.d.ts

@@ -0,0 +1,27 @@
+import { ReactElement } from 'react';
+import { IdCaptureWizardProps } from './id_capture/IdCaptureWizard';
+import { FaceLivenessWizardProps } from './face_liveness/FaceLivenessWizard';
+import { SubmissionAction, SubmissionEnvironment, SubmissionResponse } from '../contexts/SubmissionContext';
+import { AdditionalDocumentCaptureWizardProps } from './additional_document_capture/AdditionalDocumentCaptureWizard';
+import { SignatureCaptureProps } from './signature_capture/SignatureCapture';
+import { SignatureKYCWizardProps } from './signature_kyc/SignatureKYCWizard';
+export type CompositeWizardCheck = 'IdCapture' | 'FaceLiveness' | 'SignatureCapture' | 'SignatureKYC' | 'AdditionalDocumentCapture';
+export type CompositeWizardComponentProps = {
+    checks: CompositeWizardCheck[];
+    idCaptureProps?: IdCaptureWizardProps;
+    faceLivenessProps?: FaceLivenessWizardProps;
+    signatureCaptureProps?: SignatureCaptureProps;
+    signatureKYCProps?: SignatureKYCWizardProps;
+    additionalDocumentCaptureProps?: AdditionalDocumentCaptureWizardProps;
+    captureSignature?: boolean | (() => Promise<boolean>);
+    captureSignatureVideo?: boolean | (() => Promise<boolean>);
+};
+export type CompositeWizardProps = CompositeWizardComponentProps & {
+    submissionToken: string;
+    submissionAction?: SubmissionAction;
+    submissionEnvironment?: SubmissionEnvironment;
+    submissionUrl?: string;
+    onComplete?: (submissionResponse: SubmissionResponse) => void;
+};
+export declare const CompositeWizard: (props: CompositeWizardProps) => ReactElement;
+export declare const CompositeWizardComponent: ({ checks: userChecks, idCaptureProps, faceLivenessProps, signatureCaptureProps, signatureKYCProps, additionalDocumentCaptureProps, captureSignature, captureSignatureVideo, }: CompositeWizardComponentProps) => ReactElement;

package/dist/components/Example.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function Example({}: {}): JSX.Element;

package/dist/components/GuideOrientationProvider.d.ts

@@ -0,0 +1,4 @@
+import { ReactElement } from 'react';
+export declare const GuideOrientationProvider: ({ children, }: {
+    children: ReactElement;
+}) => ReactElement;

package/dist/components/additional_document_capture/AdditionalDocumentCapture.d.ts

@@ -0,0 +1,17 @@
+import { ReactElement } from 'react';
+export type AdditionalDocument = {
+    name: string;
+    description?: string;
+    skip?: () => Promise<boolean>;
+};
+export type UploadedDocument = {
+    documentName: string;
+    additionalDocument: string | Record<string, string>;
+};
+export type AdditionalDocumentCaptureProps = {
+    document: AdditionalDocument;
+    onComplete?: (uploadedDocument: UploadedDocument) => void;
+    headingText?: string;
+    nextBtnText?: string;
+};
+export declare const AdditionalDocumentCapture: ({ document, onComplete, headingText, nextBtnText, }: AdditionalDocumentCaptureProps) => ReactElement;

package/dist/components/additional_document_capture/AdditionalDocumentCaptureWizard.d.ts

@@ -0,0 +1,16 @@
+import { ReactElement } from 'react';
+import { AdditionalDocument, UploadedDocument } from './AdditionalDocumentCapture';
+export type NamespacedAdditionalDocumentsVerbiage = {
+    additionalDocumentsHeadingText?: string;
+    additionalDocumentsNextBtnText?: string;
+};
+export type AdditionalDocumentCaptureVerbiage = {
+    headingText?: string;
+    nextBtnText?: string;
+};
+export type AdditionalDocumentCaptureWizardProps = {
+    documents: AdditionalDocument[];
+    onComplete?: (uploadedDocuments: UploadedDocument[]) => void;
+    verbiage?: AdditionalDocumentCaptureVerbiage;
+};
+export declare const AdditionalDocumentCaptureWizard: ({ documents, onComplete, verbiage, }: AdditionalDocumentCaptureWizardProps) => ReactElement;

package/dist/components/additional_document_capture/CapturedDocuments.d.ts

@@ -0,0 +1,8 @@
+export type CapturedDocument = {
+    imageData: string;
+    width: number;
+    height: number;
+};
+export type CapturedDocuments = {
+    [key: string]: CapturedDocument;
+};

package/dist/components/camera/CameraAccessDeniedOverlay.d.ts

@@ -0,0 +1,4 @@
+import { ReactElement } from 'react';
+export declare const CameraAccessDeniedOverlay: ({ accessBlockedImageUrl, }: {
+    accessBlockedImageUrl?: string | undefined;
+}) => ReactElement;

package/dist/components/camera/CameraProvider.d.ts

@@ -0,0 +1,9 @@
+import { ReactElement } from 'react';
+type CameraProviderProps = {
+    children: ReactElement;
+    preferFrontFacingCamera?: boolean;
+    preferContinuityCamera?: boolean;
+    requestMicrophoneAccess?: boolean;
+};
+export declare const CameraProvider: ({ children, preferFrontFacingCamera, preferContinuityCamera, requestMicrophoneAccess, }: CameraProviderProps) => ReactElement;
+export {};

package/dist/components/camera/CameraVideoTag.d.ts

@@ -0,0 +1,5 @@
+import React, { ReactElement } from 'react';
+export declare const CameraVideoTag: () => ReactElement;
+export declare const FullscreenVideoTag: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>, {
+    $isRearFacing?: boolean | undefined;
+}>>;

package/dist/components/common/Page.d.ts

@@ -0,0 +1,12 @@
+import React, { ReactNode } from 'react';
+export declare const PageContainerDiv: import("styled-components").IStyledComponent<"web", import("styled-components/dist/types").Substitute<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
+    $heightOffset?: number | undefined;
+}>>;
+export declare const PageContainer: React.ForwardRefExoticComponent<Pick<{
+    ref?: React.RefCallback<HTMLDivElement> | undefined;
+    children: ReactNode;
+    className?: string | undefined;
+    heightOffset?: number | undefined;
+    style?: React.CSSProperties | undefined;
+    onClick?: (() => void) | undefined;
+}, "className" | "style" | "children" | "onClick" | "heightOffset"> & React.RefAttributes<HTMLDivElement>>;

package/dist/components/common/cdn.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_CDN_URL = "https://websdk-cdn-dev.idmission.com/assets";