idmission-web-sdk 1.0.313 → 1.0.314

package/README.md

@@ -6,21 +6,16 @@ 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.
+Before using the IDmission WebSDK, you will need to obtain an API key. New customers receive their API 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'
+curl -s -H "Content-Type: application/json" \
+  -d '{"api_key_id": "your-api-key-id", "api_key_secret": "your-api-secret"}' \
+  https://portal-api.idmission.com/portal.sessions.v1.SessionsService/CreateSession
 ```
 
-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.
+Prior to initializing the WebSDK on the client, you should generate a session on your server using these credentials. Be careful not to leak them on the client side! The generated session id is safe to pass to the client, but the secrets used to generate them are not. If you have inadvertently leaked your credentials, react out to support@idmission.com to rotate them.
 
 If you are using NodeJS, check out our [auth client for server-side JavaScript](https://www.npmjs.com/package/idmission-auth-client).
 
@@ -35,7 +30,7 @@ import React from 'react'
 import { render } from 'react-dom'
 import { IdValidation } from 'idmission-web-sdk'
 
-render(<IdValidation submissionToken={YOUR_TOKEN} />, document.getElementById('root'))
+render(<IdValidation sessionId={YOUR_SESSION_ID} />, document.getElementById('root'))
 ```
 
 ## Basic Usage in HTML
@@ -58,7 +53,7 @@ You may subscribe to the `idmission-web-sdk.ready` event to be notified when loa
 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' });
+    IDmissionSDK.renderIdValidation('#target-element', { sessionId: 'my-idmission-session-id' });
 </script>
 ```
 
@@ -71,8 +66,14 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 **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>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>
+<tr><td><code>documentServiceUrl</code> (optional)</td><td>URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/</td></tr>
+<tr><td><code>onBeforeDocumentUpload</code> (optional)</td><td>callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded.</td></tr>
+<tr><td><code>onDocumentUploadProgress</code> (optional)</td><td>callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploaded</code> (optional)</td><td>callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploadFailed</code> (optional)</td><td>callback function that fires when a document failed to upload. The error and metadata are passed in as parameters.</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. 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>onApproved</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow with a valid ID. Arguments: same as onComplete.</td></tr>
@@ -83,14 +84,19 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <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>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</td></tr>
+<tr><td><code>loadingOverlayMode</code> (optional)</td><td>string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</td></tr>
 <tr><td><code>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</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. Defaults to 0.8.</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. Defaults to 0.75.</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>idCardFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. Defaults to 0.3.</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. Defaults to 0.3.</td></tr>
 <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>instructions</code> (optional)</td><td>React element or string to render on the instructions screen.</td></tr>
+<tr><td><code>guideType</code> (optional)</td><td>string to indicate what type of guides to use during capture. Using fit is highly recommended in order to capture the best quality image. Valid values: fit, overlay. Defaults to fit.</td></tr>
+<tr><td><code>portraitGuidesOnMobile</code> (optional)</td><td>boolean to indicate whether guide images should be rotated on mobile. Defaults to false.</td></tr>
+<tr><td><code>rotateLoadingOverlayImageWhenPortrait</code> (optional)</td><td>boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to true.</td></tr>
+<tr><td><code>precapturedDocuments</code> (optional)</td><td>object to allow documents that have been previously captured to be submitted. Valid keys: idCardFront, idCardBack, passport.</td></tr>
 <tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
 <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>
@@ -109,6 +115,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <tr><td><code>webhooksFireOnReview</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. 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 color overrides, for available options consult the Colors table below.</td></tr>
+<tr><td><code>theme</code> (optional)</td><td>name of an included theme or object containing theme properties.</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. 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>
@@ -199,7 +206,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 
 ```js
 IDmissionSDK.renderIdValidation('#target-element', {
-    submissionToken: 'my-idmission-token',
+    sessionId: 'my-idmission-session-id',
     onApproved: (submissionResponse) => {
         alert('Your ID has been validated, proceed to the next checkpoint.')
     },
@@ -216,8 +223,14 @@ Render a fullscreen capture component that analyzes frames from the user's front
 **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>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>
+<tr><td><code>documentServiceUrl</code> (optional)</td><td>URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/</td></tr>
+<tr><td><code>onBeforeDocumentUpload</code> (optional)</td><td>callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded.</td></tr>
+<tr><td><code>onDocumentUploadProgress</code> (optional)</td><td>callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploaded</code> (optional)</td><td>callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploadFailed</code> (optional)</td><td>callback function that fires when a document failed to upload. The error and metadata are passed in as parameters.</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, regardless of whether they are approved or denied. 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>onApproved</code> (optional)</td><td>callback function that fires when the user completes the FaceValidation flow and passes the realness check. Arguments: same as onComplete.</td></tr>
@@ -226,6 +239,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the FaceValidation flow and failing the realness check.</td></tr>
 <tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</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>loadingOverlayMode</code> (optional)</td><td>string indicating which loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</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>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>
@@ -237,11 +251,10 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>webhooksSendProcessedImages</code> (optional)</td><td>boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. 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 color overrides, for available options consult the Colors table below.</td></tr>
+<tr><td><code>theme</code> (optional)</td><td>name of an included theme or object containing theme properties.</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. 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>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>
 </table>
 
@@ -311,7 +324,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 
 ```js
 IDmissionSDK.renderFaceValidation('#target-element', {
-    submissionToken: 'my-idmission-token',
+    sessionId: 'my-idmission-session-id',
     onApproved: (submissionResponse) => {
         alert('Your face is real, proceed to the next checkpoint.')
     },
@@ -328,8 +341,14 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 **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>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>
+<tr><td><code>documentServiceUrl</code> (optional)</td><td>URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/</td></tr>
+<tr><td><code>onBeforeDocumentUpload</code> (optional)</td><td>callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded.</td></tr>
+<tr><td><code>onDocumentUploadProgress</code> (optional)</td><td>callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploaded</code> (optional)</td><td>callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploadFailed</code> (optional)</td><td>callback function that fires when a document failed to upload. The error and metadata are passed in as parameters.</td></tr>
 <tr><td><code>onBeforeLivenessCheck</code> (optional)</td><td>callback function that fires immediately prior to liveness check, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The liveness check request is passed in as a parameter and a promise resolving to the updated request should be returned.</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. 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>
@@ -342,15 +361,21 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <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>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</td></tr>
+<tr><td><code>precapturedDocuments</code> (optional)</td><td>object to allow documents that have been previously captured to be submitted. Valid keys: idCardFront, idCardBack, passport.</td></tr>
+<tr><td><code>idCaptureLoadingOverlayMode</code> (optional)</td><td>string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</td></tr>
 <tr><td><code>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</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. Defaults to 0.8.</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. Defaults to 0.75.</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>idCardFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. Defaults to 0.3.</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. Defaults to 0.3.</td></tr>
+<tr><td><code>faceLivenessLoadingOverlayMode</code> (optional)</td><td>string indicating which face liveness loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</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>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>idCaptureInstructions</code> (optional)</td><td>React element or string to render on the instructions screen.</td></tr>
+<tr><td><code>idCaptureGuideType</code> (optional)</td><td>string to indicate what type of guides to use during capture. Using fit is highly recommended in order to capture the best quality image. Valid values: fit, overlay. Defaults to fit.</td></tr>
+<tr><td><code>idCapturePortraitGuidesOnMobile</code> (optional)</td><td>boolean to indicate whether guide images should be rotated on mobile. Defaults to false.</td></tr>
+<tr><td><code>idCaptureRotateLoadingOverlayImageWhenPortrait</code> (optional)</td><td>boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to true.</td></tr>
 <tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
 <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>
@@ -367,6 +392,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>webhooksSendInputImages</code> (optional)</td><td>boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksSendProcessedImages</code> (optional)</td><td>boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksFireOnReview</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. Defaults to false.</td></tr>
+<tr><td><code>theme</code> (optional)</td><td>name of an included theme or object containing theme properties.</td></tr>
 <tr><td><code>assets.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>assets.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>colors.idCapture</code> (optional)</td><td>object containing any color overrides, for available options consult the ID Capture Colors table above.</td></tr>
@@ -384,7 +410,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 
 ```js
 IDmissionSDK.renderIdAndFaceValidation('#target-element', {
-    submissionToken: 'my-idmission-token',
+    sessionId: 'my-idmission-session-id',
     onApproved: (submissionResponse) => {
         alert('Your ID has been validated and your face is real, proceed to the next checkpoint.')
     },
@@ -401,8 +427,14 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 **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>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>
+<tr><td><code>documentServiceUrl</code> (optional)</td><td>URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/</td></tr>
+<tr><td><code>onBeforeDocumentUpload</code> (optional)</td><td>callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded.</td></tr>
+<tr><td><code>onDocumentUploadProgress</code> (optional)</td><td>callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploaded</code> (optional)</td><td>callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploadFailed</code> (optional)</td><td>callback function that fires when a document failed to upload. The error and metadata are passed in as parameters.</td></tr>
 <tr><td><code>enrollmentId</code></td><td>the unique identifier to use for the customer to be enrolled. Overrides <code>personalData.uniqueNumber</code> if both are specified.</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. 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>
@@ -415,14 +447,20 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <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>idCaptureLoadingOverlayMode</code> (optional)</td><td>string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</td></tr>
 <tr><td><code>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</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. Defaults to 0.8.</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. Defaults to 0.75.</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>idCardFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. Defaults to 0.3.</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. Defaults to 0.3.</td></tr>
+<tr><td><code>faceLivenessLoadingOverlayMode</code> (optional)</td><td>string indicating which face liveness loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</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>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>idCaptureInstructions</code> (optional)</td><td>React element or string to render on the instructions screen.</td></tr>
+<tr><td><code>idCaptureGuideType</code> (optional)</td><td>string to indicate what type of guides to use during capture. Using fit is highly recommended in order to capture the best quality image. Valid values: fit, overlay. Defaults to fit.</td></tr>
+<tr><td><code>idCapturePortraitGuidesOnMobile</code> (optional)</td><td>boolean to indicate whether guide images should be rotated on mobile. Defaults to false.</td></tr>
+<tr><td><code>idCaptureRotateLoadingOverlayImageWhenPortrait</code> (optional)</td><td>boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to true.</td></tr>
 <tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
 <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>
@@ -441,6 +479,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>webhooksSendInputImages</code> (optional)</td><td>boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksSendProcessedImages</code> (optional)</td><td>boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksFireOnReview</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. Defaults to false.</td></tr>
+<tr><td><code>theme</code> (optional)</td><td>name of an included theme or object containing theme properties.</td></tr>
 <tr><td><code>assets.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>assets.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>colors.idCapture</code> (optional)</td><td>object containing any color overrides, for available options consult the ID Capture Colors table above.</td></tr>
@@ -460,7 +499,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 
 ```js
 IDmissionSDK.renderCustomerIdAndBiometricsEnrollment('#target-element', {
-    submissionToken: 'my-idmission-token',
+    sessionId: 'my-idmission-session-id',
     enrollmentId: 'some-guy',
 });
 ```
@@ -472,8 +511,14 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 **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>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>
+<tr><td><code>documentServiceUrl</code> (optional)</td><td>URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/</td></tr>
+<tr><td><code>onBeforeDocumentUpload</code> (optional)</td><td>callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded.</td></tr>
+<tr><td><code>onDocumentUploadProgress</code> (optional)</td><td>callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploaded</code> (optional)</td><td>callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploadFailed</code> (optional)</td><td>callback function that fires when a document failed to upload. The error and metadata are passed in as parameters.</td></tr>
 <tr><td><code>enrollmentId</code></td><td>the unique identifier to use for the customer to be enrolled. Overrides <code>personalData.uniqueNumber</code> if both are specified.</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 CustomerBiometricsEnrollment 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>
@@ -486,6 +531,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 <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>loadingOverlayMode</code> (optional)</td><td>string indicating which loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</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>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>
@@ -497,6 +543,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 <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. Defaults to true.</td></tr>
 <tr><td><code>webhooksSendInputImages</code> (optional)</td><td>boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksSendProcessedImages</code> (optional)</td><td>boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
+<tr><td><code>theme</code> (optional)</td><td>name of an included theme or object containing theme properties.</td></tr>
 <tr><td><code>assets.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>colors.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>colors.videoSignatureCapture</code> (optional)</td><td>object containing any color overrides, for available options consult the videoSignatureCapture fields in the ID Capture Colors table above.</td></tr>
@@ -513,7 +560,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 
 ```js
 IDmissionSDK.renderCustomerBiometricsEnrollment('#target-element', {
-    submissionToken: 'my-idmission-token',
+    sessionId: 'my-idmission-session-id',
     enrollmentId: 'some-guy',
 });
 ```
@@ -525,8 +572,14 @@ Render a fullscreen capture component that analyzes frames from the user's front
 **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>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>
+<tr><td><code>documentServiceUrl</code> (optional)</td><td>URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/</td></tr>
+<tr><td><code>onBeforeDocumentUpload</code> (optional)</td><td>callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded.</td></tr>
+<tr><td><code>onDocumentUploadProgress</code> (optional)</td><td>callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploaded</code> (optional)</td><td>callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploadFailed</code> (optional)</td><td>callback function that fires when a document failed to upload. The error and metadata are passed in as parameters.</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. 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>
@@ -536,6 +589,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <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>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</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>loadingOverlayMode</code> (optional)</td><td>string indicating which loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</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>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>
@@ -545,6 +599,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <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. Defaults to true.</td></tr>
 <tr><td><code>webhooksSendInputImages</code> (optional)</td><td>boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksSendProcessedImages</code> (optional)</td><td>boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
+<tr><td><code>theme</code> (optional)</td><td>name of an included theme or object containing theme properties.</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>colors</code> (optional)</td><td>object containing any color overrides, for available options consult the Face Liveness Colors 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>
@@ -557,7 +612,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 
 ```js
 IDmissionSDK.renderCustomerVerification('#target-element', {
-    submissionToken: 'my-idmission-token',
+    sessionId: 'my-idmission-session-id',
     enrollmentId: 'some-guy',
 });
 ```
@@ -569,8 +624,14 @@ Render a fullscreen capture component that analyzes frames from the user's front
 **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>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>
+<tr><td><code>documentServiceUrl</code> (optional)</td><td>URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/</td></tr>
+<tr><td><code>onBeforeDocumentUpload</code> (optional)</td><td>callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded.</td></tr>
+<tr><td><code>onDocumentUploadProgress</code> (optional)</td><td>callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploaded</code> (optional)</td><td>callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploadFailed</code> (optional)</td><td>callback function that fires when a document failed to upload. The error and metadata are passed in as parameters.</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. 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>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>
@@ -578,6 +639,8 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</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>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
+<tr><td><code>loadingOverlayMode</code> (optional)</td><td>string indicating which loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</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>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>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>
@@ -587,6 +650,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 <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. Defaults to true.</td></tr>
 <tr><td><code>webhooksSendInputImages</code> (optional)</td><td>boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
 <tr><td><code>webhooksSendProcessedImages</code> (optional)</td><td>boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false.</td></tr>
+<tr><td><code>theme</code> (optional)</td><td>name of an included theme or object containing theme properties.</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>
@@ -657,7 +721,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
 **Example**
 
 ```js
-IDmissionSDK.renderCustomerIdentification('#target-element', { submissionToken: 'my-idmission-token' });
+IDmissionSDK.renderCustomerIdentification('#target-element', { sessionId: 'my-idmission-session-id' });
 ```
 
 ### VideoIdValidation
@@ -667,8 +731,14 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 **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>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>
+<tr><td><code>documentServiceUrl</code> (optional)</td><td>URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/</td></tr>
+<tr><td><code>onBeforeDocumentUpload</code> (optional)</td><td>callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded.</td></tr>
+<tr><td><code>onDocumentUploadProgress</code> (optional)</td><td>callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploaded</code> (optional)</td><td>callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters.</td></tr>
+<tr><td><code>onDocumentUploadFailed</code> (optional)</td><td>callback function that fires when a document failed to upload. The error and metadata are passed in as parameters.</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>onSubmit</code> (optional)</td><td>callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk!</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>
@@ -706,6 +776,12 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <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>skipIdCapture</code> (optional)</td><td>boolean to indicate whether to skip the initial ID capture flow. Note that when this flag is set, submission to IDmission's servers will not be attempted; it should be used in tandem with onSubmit. Defaults to false.</td></tr>
 <tr><td><code>skipShowIdCardBack</code> (optional)</td><td>boolean or async function to indicate whether to instruct the user to show the back of their ID card during video capture. If an async function is supplied returning a boolean, it will be evaluated at the time of ID front video capture completion. Defaults to false.</td></tr>
+<tr><td><code>idCaptureLoadingOverlayMode</code> (optional)</td><td>string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</td></tr>
+<tr><td><code>idCaptureGuideType</code> (optional)</td><td>string to indicate what type of guides to use during capture. Using fit is highly recommended in order to capture the best quality image. Valid values: fit, overlay. Defaults to fit.</td></tr>
+<tr><td><code>idCapturePortraitGuidesOnMobile</code> (optional)</td><td>boolean to indicate whether guide images should be rotated on mobile. Defaults to false.</td></tr>
+<tr><td><code>idCaptureRotateLoadingOverlayImageWhenPortrait</code> (optional)</td><td>boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to true.</td></tr>
+<tr><td><code>faceLivenessLoadingOverlayMode</code> (optional)</td><td>string indicating which face liveness loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</td></tr>
+<tr><td><code>theme</code> (optional)</td><td>name of an included theme or object containing theme properties.</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>
@@ -756,7 +832,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 **Example**
 
 ```js
-IDmissionSDK.renderVideoIdValidation('#target-element', { submissionToken: 'my-idmission-token' });
+IDmissionSDK.renderVideoIdValidation('#target-element', { sessionId: 'my-idmission-session-id' });
 ```
 
 ## Other Functionality

package/dist/components/CompositeWizard.d.ts

@@ -1,7 +1,7 @@
 import { ReactElement } from 'react';
 import { IdCaptureWizardProps } from './id_capture/IdCaptureWizard';
 import { FaceLivenessWizardProps } from './face_liveness/FaceLivenessWizard';
-import { SubmissionAction, SubmissionEnvironment, SubmissionResponse } from '../contexts/SubmissionContext';
+import { SubmissionAction, SubmissionResponse } from '../contexts/SubmissionContext';
 import { AdditionalDocumentCaptureWizardProps } from './additional_document_capture/AdditionalDocumentCaptureWizard';
 import { SignatureCaptureProps } from './signature_capture/SignatureCapture';
 import { VideoSignatureWizardProps } from './video_signature_capture/VideoSignatureWizard';
@@ -20,10 +20,10 @@ export type CompositeWizardComponentProps = {
     debugMode?: boolean;
 };
 export type CompositeWizardProps = CompositeWizardComponentProps & {
-    submissionToken: string;
+    sessionId: string;
     submissionAction?: SubmissionAction;
-    submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
+    authUrl?: string;
     onComplete?: (submissionResponse: SubmissionResponse) => void;
 };
 export declare const CompositeWizard: (props: CompositeWizardProps) => ReactElement;

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

@@ -1,4 +1,5 @@
 import { FC, PropsWithChildren } from 'react';
+import { OnBeforeDocumentUpload, OnDocumentUploaded, OnDocumentUploadFailed, OnDocumentUploadProgress } from '../submission/SubmissionProvider';
 import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessClassNames, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { AdditionalDocumentCaptureWizardClassNames, AdditionalDocumentCaptureWizardVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
@@ -32,10 +33,14 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
     enrollmentId: string;
     /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
-    /** A token generated with your IDmission credentials. */
-    submissionToken: string;
+    /** A session identifier generated with your IDmission credentials. */
+    sessionId: string | (() => Promise<string>);
     /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** URL to validate session against. Defaults to https://portal-api.idmission.com. */
+    authUrl?: string;
+    /** URL to upload captured documents to via Tus. */
+    documentServiceUrl?: string;
     /** Company identifier to include with submission. */
     companyId?: string;
     /** Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. */
@@ -62,6 +67,14 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
     modelLoadTimeoutMs?: number;
     /** Boolean or async function to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to `false`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. */
+    onBeforeDocumentUpload?: OnBeforeDocumentUpload;
+    /** Callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. */
+    onDocumentUploadProgress?: OnDocumentUploadProgress;
+    /** Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. */
+    onDocumentUploaded?: OnDocumentUploaded;
+    /** Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. */
+    onDocumentUploadFailed?: OnDocumentUploadFailed;
     /** 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. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
     /** Callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, `onComplete` will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! */