Customer FlowsCustomer Biometrics Enrollment

Customer Biometrics Enrollment

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.

Example

import React, { useState } from 'react'
import { CustomerBiometricsEnrollment } from 'idmission-web-sdk'
 
function getSessionId() {
  return fetch('/api/get-session').then(resp => resp.json()).then(resp => resp.id)
}
 
function MyComponent() {
  const [running, setRunning] = useState(false)
 
  return (
    <>
      <button onClick={() => setRunning(true)}>Start Customer Biometrics Enrollment</button>
 
      {running && (
        <CustomerBiometricsEnrollment
          sessionId={getSessionId}
          enrollmentId="some-guy"
        />
      )}
    </>
  )
}

Props

enrollmentId
The unique identifier to match from previously enrolled customers.
lang
Language code to use. Supported values: ‘auto’ (detect based on user’s OS), ‘en’ (English), ‘es’ (Spanish). Defaults to auto.
sessionId
A session identifier generated with your IDmission credentials.
submissionUrl
URL to hit with all API requests. Defaults to the value specified in your decoded submissionToken.
authUrl
URL to validate session against. Defaults to https://portal-api.idmission.com.
documentServiceUrl
URL to upload captured documents to via Tus.
companyId
Company identifier to include with submission.
jobId
The ID of the job to associate with the submission.
taskId
The ID of the task to associate with the submission.
needImmediateResponse
Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true.
deduplicationEnabled
Boolean flag indicating whether submissions from the same user should be de-duplicated.
deduplicationSynchronous
Boolean flag indicating whether to wait for de-duplication to complete before allowing the user to proceed.
webhooksEnabled
Boolean flag to indicate whether customer-configured webhooks should be invoked after submission.
webhooksURL
URL to use when invoking customer-configured webhooks.
webhooksClientTraceId
A customer provided trace id to use when invoking customer-configured webhooks.
webhooksStripSpecialCharacters
Boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked.
webhooksSendInputImages
Boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked.
webhooksSendProcessedImages
Boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked.
webhooksFireOnReview
Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review.
webhooksFireOnReviewURL
URL to use when invoking customer-configured webhooks when ID is marked for manual review.
sendBase64DocumentsInSwaggerProxy
Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false.
useDocumentServiceForLivenessChecks
Boolean flag to indicate whether the liveness check photos should be uploaded to the document service, rather than sent as base64. Defaults to false.
loadingOverlayMode
String indicating which loading overlay screen should be used. Supported values: ‘default’ and ‘legacy’. Defaults to ‘default’.
initialCaptureDelayMs
The duration of time in milliseconds to wait after the loading overlay is dismissed before starting the capture experience. This helps with the problem of the first few frames being of the user looking down at the bottom of the screen but the frame otherwise being good. Defaults to 1000 (1 second).
timeoutDurationMs
The duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds).
modelLoadTimeoutMs
Number of milliseconds indicating the maximum amount of time that should be spent trying to load the guided capture experience before giving up and resorting to the stock camera instead. Defaults to 45000 (45 seconds).
skipSuccessScreen
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.
onLoadingStarted
Callback function that fires when the loading overlay is shown.
onLoadingProgress
Callback function that fires when the loading overlay progress changes.
onLoadingCompleted
Callback function that fires when the loading overlay is dismissed.
onBeforeDocumentUpload
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.
onDocumentUploadProgress
Callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters.
onDocumentUploaded
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.
onDocumentUploadFailed
Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters.
onBeforeSubmit
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.
onSubmit
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!
onComplete
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.
onEnrolled
Callback function that fires when the user has completed the CustomerBiometricsEnrollment 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.
onDenied
Callback function that fires when the user has completed the CustomerBiometricsEnrollment 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.
onRequestFailure
Callback function that fires when an error occurs during the submission process. Arguments: the Error object is passed as an argument to the customer’s application for further handling.
onExitCapture
Callback function that fires when the user clicks the exit button during ID or selfie capture.
onExitAfterFailure
Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.
onUserCancel
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.
onModelError
Callback function that fires when the selfie capture models fail to load or fail during runtime.
onCameraAccessDenied
Callback function that fires when the camera access is denied.
onCameraTamperingDetected
Callback function that fires when the camera tampering is detected.
captureSignature
Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to false.
captureSignatureVideo
Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.
captureAdditionalDocuments
Array of additional documents to be captured. Each element includes a name and description.
theme
Name of an included theme or object containing theme properties. *
assets
Object containing any asset overrides.
classNames
Object containing any classNames for inner components. *
colors
Object containing any color overrides.
verbiage
Object containing any verbiage overrides.
geolocationEnabled
Boolean flag to indicate whether users should be prompted to share their location. Default is true.
geolocationRequired
Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is false.
debugMode
Boolean flag to enable on-screen prediction information output. Default is false.

Class Names

container
faceLiveness.loadingOverlay.container
Class name for the outermost container of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.inner
Class name for the inner container of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.headingContainer
Class name for the heading container of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.heading
Class name for the heading of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.imageContainer
Class name for the image container of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.image
Class name for the image of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.buttonsRow
Class name for the buttons row of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.continueBtnContainer
Class name for the continue button container of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.continueBtn
Class name for the continue button of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.cancelBtn
Class name for the cancel button of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.cameraAccessDenied.container
Class name for the outermost container of the CameraAccessDeniedOverlay.
faceLiveness.loadingOverlay.cameraAccessDenied.inner
Class name for the inner container of the CameraAccessDeniedOverlay.
faceLiveness.loadingOverlay.cameraAccessDenied.imageContainer
Class name for the container of the image in the CameraAccessDeniedOverlay.
faceLiveness.loadingOverlay.cameraAccessDenied.image
Class name for the image in the CameraAccessDeniedOverlay.
faceLiveness.loadingOverlay.cameraAccessDenied.heading
Class name for the heading of the CameraAccessDeniedOverlay.
faceLiveness.loadingOverlay.cameraAccessDenied.description
Class name for the description text of the CameraAccessDeniedOverlay.
faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn
Class name for the button that will retry camera access in the CameraAccessDeniedOverlay.
faceLiveness.loadingOverlay.microphoneAccessDenied.container
Class name for the outermost container of the MicrophoneAccessDeniedOverlay.
faceLiveness.loadingOverlay.microphoneAccessDenied.inner
Class name for the inner container of the MicrophoneAccessDeniedOverlay.
faceLiveness.loadingOverlay.microphoneAccessDenied.imageContainer
Class name for the image container of the MicrophoneAccessDeniedOverlay.
faceLiveness.loadingOverlay.microphoneAccessDenied.image
Class name for the image of the MicrophoneAccessDeniedOverlay.
faceLiveness.loadingOverlay.microphoneAccessDenied.heading
Class name for the heading of the MicrophoneAccessDeniedOverlay.
faceLiveness.loadingOverlay.microphoneAccessDenied.description
Class name for the description of the MicrophoneAccessDeniedOverlay.
faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn
Class name for the retry button of the MicrophoneAccessDeniedOverlay.
faceLiveness.loadingOverlay.progressContainer
Class name for the progress container of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.progressBackground
Class name for the progress background of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.progressBar
Class name for the progress bar of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.progressIndicator
Class name for the progress indicator of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.loadingListContainer
Class name for the loading list container of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.loadingList
Class name for the loading list of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.loadingListItem
Class name for the loading list items of the SelfieCaptureLoadingOverlay.
faceLiveness.loadingOverlay.loadingListItemIndicator
Class name for the icons on the loading list items of the SelfieCaptureLoadingOverlay.
faceLiveness.capture.container
Class name for the outermost container of the SelfieCapture screen.
faceLiveness.capture.cameraFeed
Class name for the camera feed component of the SelfieCapture screen.
faceLiveness.capture.guides.container
Class name for the outermost container of the FaceCaptureGuideOverlay.
faceLiveness.capture.guides.oval
Class name for the oval of the FaceCaptureGuideOverlay.
faceLiveness.capture.guidanceMessageContainer
Class name for the guidance message container of the SelfieCapture screen.
faceLiveness.capture.guidanceMessage
Class name for the guidance message of the SelfieCapture screen.
faceLiveness.capture.exitCaptureBtn
Class name for the exit capture button of the SelfieCapture screen.
faceLiveness.capture.fallback.container
Class name for the outermost container of the SelfieCaptureFallback.
faceLiveness.capture.fallback.inner
Class name for the inner container of the SelfieCaptureFallback.
faceLiveness.capture.fallback.heading
Class name for the heading of the SelfieCaptureFallback.
faceLiveness.capture.fallback.description
Class name for the description of the SelfieCaptureFallback.
faceLiveness.capture.fallback.imageContainer
Class name for the container of the image in the SelfieCaptureFallback.
faceLiveness.capture.fallback.image
Class name for the image in the SelfieCaptureFallback.
faceLiveness.capture.fallback.buttonsRow
Class name for the buttons row in the SelfieCaptureFallback.
faceLiveness.capture.fallback.captureBtn
Class name for the capture button in the SelfieCaptureFallback.
faceLiveness.capture.fallback.doneBtn
Class name for the done button in the SelfieCaptureFallback.
faceLiveness.capture.fallback.retryCaptureBtn
Class name for the retry capture button in the SelfieCaptureFallback.
faceLiveness.capture.fallback.documentCaptureClassNames.container
faceLiveness.capture.fallback.documentCaptureClassNames.cameraFeedWrapper
faceLiveness.capture.fallback.documentCaptureClassNames.cameraFeed
faceLiveness.capture.fallback.documentCaptureClassNames.previewImage
faceLiveness.capture.fallback.documentCaptureClassNames.captureContainer
faceLiveness.capture.fallback.documentCaptureClassNames.headingRow
faceLiveness.capture.fallback.documentCaptureClassNames.heading
faceLiveness.capture.fallback.documentCaptureClassNames.footerRow
faceLiveness.capture.fallback.documentCaptureClassNames.instructions
faceLiveness.capture.fallback.documentCaptureClassNames.buttonsRow
faceLiveness.capture.fallback.documentCaptureClassNames.retryCameraAccessBtn
faceLiveness.capture.fallback.documentCaptureClassNames.retryCaptureBtn
faceLiveness.capture.fallback.documentCaptureClassNames.uploadBtn
faceLiveness.capture.fallback.documentCaptureClassNames.uploadProgressBtn
faceLiveness.capture.fallback.documentCaptureClassNames.captureBtn
faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.container
faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.inner
faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.heading
faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.message
faceLiveness.capture.imagePreview.container
Class name for the outermost container of the SelfieProgressPreview.
faceLiveness.capture.imagePreview.text
Class name for the text of the SelfieProgressPreview.
faceLiveness.capture.imagePreview.spinner
Class name for the spinner of the SelfieProgressPreview.
faceLiveness.capture.imagePreview.imageContainer
Class name for the image container of the SelfieProgressPreview.
faceLiveness.capture.imagePreview.image
Class name for the image of the SelfieProgressPreview.
faceLiveness.success.container
Class name for the outermost container of the FaceLivenessSuccess screen.
faceLiveness.success.inner
Class name for the inner container of the FaceLivenessSuccess screen.
faceLiveness.success.heading
Class name for the heading of the FaceLivenessSuccess screen.
faceLiveness.success.imageContainer
Class name for the image container of the FaceLivenessSuccess screen.
faceLiveness.success.image
Class name for the image of the FaceLivenessSuccess screen.
faceLiveness.success.buttonsRow
Class name for the buttons row of the FaceLivenessSuccess screen.
faceLiveness.success.retryBtn
Class name for the retry button of the FaceLivenessSuccess screen.
faceLiveness.success.doneBtn
Class name for the done button of the FaceLivenessSuccess screen.
faceLiveness.failure.container
Class name for the outermost container of the FaceLivenessFailure screen.
faceLiveness.failure.inner
Class name for the inner container of the FaceLivenessFailure screen.
faceLiveness.failure.heading
Class name for the heading of the FaceLivenessFailure screen.
faceLiveness.failure.imageContainer
Class name for the image container of the FaceLivenessFailure screen.
faceLiveness.failure.image
Class name for the image of the FaceLivenessFailure screen.
faceLiveness.failure.buttonsRow
Class name for the buttons row of the FaceLivenessFailure screen.
faceLiveness.failure.retryBtn
Class name for the retry button of the FaceLivenessFailure screen.
faceLiveness.failure.exitBtn
Class name for the exit button of the FaceLivenessFailure screen.
faceLiveness.cameraStoreProvider.cameraTamperSeal.container
faceLiveness.cameraStoreProvider.cameraTamperSeal.inner
faceLiveness.cameraStoreProvider.cameraTamperSeal.heading
faceLiveness.cameraStoreProvider.cameraTamperSeal.message
additionalDocumentCapture.container
Class name for the outermost container of the AdditionalDocumentCapture.
additionalDocumentCapture.inner
Class name for the inner container of the AdditionalDocumentCapture.
additionalDocumentCapture.heading
Class name for the heading of the AdditionalDocumentCapture.
additionalDocumentCapture.description
Class name for the description of the AdditionalDocumentCapture.
additionalDocumentCapture.buttonsRow
Class name for the buttons row of the AdditionalDocumentCapture.
additionalDocumentCapture.captureBtn
Class name for the capture button of the AdditionalDocumentCapture.
additionalDocumentCapture.nextBtn
Class name for the next button of the AdditionalDocumentCapture.
signatureCapture.container
Class name for the outermost container of the SignatureCapture.
signatureCapture.inner
Class name for the inner container of the SignatureCapture.
signatureCapture.guidanceMessageContainer
Class name for the guidance message container of the SignatureCapture.
signatureCapture.guidanceMessage
Class name for the guidance message of the SignatureCapture.
signatureCapture.canvasContainer
Class name for the canvas container of the SignatureCapture.
signatureCapture.canvasInner
Class name for the canvas inner container of the SignatureCapture.
signatureCapture.canvas
Class name for the canvas of the SignatureCapture.
signatureCapture.buttonsRow
Class name for the buttons row of the SignatureCapture.
signatureCapture.clearBtn
Class name for the clear button of the SignatureCapture.
signatureCapture.acceptBtn
Class name for the accept button of the SignatureCapture.
signatureCapture.cancelBtn
Class name for the cancel button of the SignatureCapture.
videoSignatureCapture.container
Class name for the outermost container of the VideoSignatureCapture screen.
videoSignatureCapture.cameraFeed
Class name for the camera feed component of the VideoSignatureCapture screen.
videoSignatureCapture.guidanceMessageContainer
Class name for the guidance message container of the VideoSignatureCapture screen.
videoSignatureCapture.guidanceMessage
Class name for the guidance message of the VideoSignatureCapture screen.
videoSignatureCapture.exitCaptureBtn
Class name for the exit capture button of the VideoSignatureCapture screen.
videoSignatureCapture.guides.container
Class name for the outermost container of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.inner
Class name for the inner container of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.faceGuideContainer
Class name for the container of the face guide of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.faceGuide
Class name for the face guide of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.signaturePadContainer
Class name for the container of the signature pad of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.signatureCanvasContainer
Class name for the signature canvas container of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.signatureCanvasInner
Class name for the signature canvas inner container of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.signatureCanvas
Class name for the signature canvas of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.signatureButtonsRow
Class name for the container of the signature buttons of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.clearSignatureBtn
Class name for the clear signature button of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.acceptSignatureBtn
Class name for the accept signature button of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.emptyContentContainer
Class name for the container of the empty content of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.emptyContentInner
Class name for the inner container of the empty content of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.headTrackingUnsatisfiedContentContainer
Class name for the container of the head tracking unsatisfied content of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.headTrackingUnsatisfiedContentInner
Class name for the inner container of the head tracking unsatisfied content of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.faceLiveness.loadingOverlay.container
Class name for the outermost container of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.inner
Class name for the inner container of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.headingContainer
Class name for the heading container of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.heading
Class name for the heading of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.imageContainer
Class name for the image container of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.image
Class name for the image of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.buttonsRow
Class name for the buttons row of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.continueBtnContainer
Class name for the continue button container of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.continueBtn
Class name for the continue button of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.cancelBtn
Class name for the cancel button of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.container
Class name for the outermost container of the CameraAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.inner
Class name for the inner container of the CameraAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.imageContainer
Class name for the container of the image in the CameraAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.image
Class name for the image in the CameraAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.heading
Class name for the heading of the CameraAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.description
Class name for the description text of the CameraAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn
Class name for the button that will retry camera access in the CameraAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.container
Class name for the outermost container of the MicrophoneAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.inner
Class name for the inner container of the MicrophoneAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.imageContainer
Class name for the image container of the MicrophoneAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.image
Class name for the image of the MicrophoneAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.heading
Class name for the heading of the MicrophoneAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.description
Class name for the description of the MicrophoneAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn
Class name for the retry button of the MicrophoneAccessDeniedOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.progressContainer
Class name for the progress container of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.progressBackground
Class name for the progress background of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.progressBar
Class name for the progress bar of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.progressIndicator
Class name for the progress indicator of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.loadingListContainer
Class name for the loading list container of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.loadingList
Class name for the loading list of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.loadingListItem
Class name for the loading list items of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.loadingOverlay.loadingListItemIndicator
Class name for the icons on the loading list items of the SelfieCaptureLoadingOverlay.
videoSignatureCapture.faceLiveness.capture.container
Class name for the outermost container of the SelfieCapture screen.
videoSignatureCapture.faceLiveness.capture.cameraFeed
Class name for the camera feed component of the SelfieCapture screen.
videoSignatureCapture.faceLiveness.capture.guides.container
Class name for the outermost container of the FaceCaptureGuideOverlay.
videoSignatureCapture.faceLiveness.capture.guides.oval
Class name for the oval of the FaceCaptureGuideOverlay.
videoSignatureCapture.faceLiveness.capture.guidanceMessageContainer
Class name for the guidance message container of the SelfieCapture screen.
videoSignatureCapture.faceLiveness.capture.guidanceMessage
Class name for the guidance message of the SelfieCapture screen.
videoSignatureCapture.faceLiveness.capture.exitCaptureBtn
Class name for the exit capture button of the SelfieCapture screen.
videoSignatureCapture.faceLiveness.capture.fallback.container
Class name for the outermost container of the SelfieCaptureFallback.
videoSignatureCapture.faceLiveness.capture.fallback.inner
Class name for the inner container of the SelfieCaptureFallback.
videoSignatureCapture.faceLiveness.capture.fallback.heading
Class name for the heading of the SelfieCaptureFallback.
videoSignatureCapture.faceLiveness.capture.fallback.description
Class name for the description of the SelfieCaptureFallback.
videoSignatureCapture.faceLiveness.capture.fallback.imageContainer
Class name for the container of the image in the SelfieCaptureFallback.
videoSignatureCapture.faceLiveness.capture.fallback.image
Class name for the image in the SelfieCaptureFallback.
videoSignatureCapture.faceLiveness.capture.fallback.buttonsRow
Class name for the buttons row in the SelfieCaptureFallback.
videoSignatureCapture.faceLiveness.capture.fallback.captureBtn
Class name for the capture button in the SelfieCaptureFallback.
videoSignatureCapture.faceLiveness.capture.fallback.doneBtn
Class name for the done button in the SelfieCaptureFallback.
videoSignatureCapture.faceLiveness.capture.fallback.retryCaptureBtn
Class name for the retry capture button in the SelfieCaptureFallback.
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.container
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.cameraFeedWrapper
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.cameraFeed
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.previewImage
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.captureContainer
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.headingRow
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.heading
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.footerRow
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.instructions
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.buttonsRow
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.retryCameraAccessBtn
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.retryCaptureBtn
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.uploadBtn
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.uploadProgressBtn
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.captureBtn
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.container
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.inner
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.heading
videoSignatureCapture.faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.message
videoSignatureCapture.faceLiveness.capture.imagePreview.container
Class name for the outermost container of the SelfieProgressPreview.
videoSignatureCapture.faceLiveness.capture.imagePreview.text
Class name for the text of the SelfieProgressPreview.
videoSignatureCapture.faceLiveness.capture.imagePreview.spinner
Class name for the spinner of the SelfieProgressPreview.
videoSignatureCapture.faceLiveness.capture.imagePreview.imageContainer
Class name for the image container of the SelfieProgressPreview.
videoSignatureCapture.faceLiveness.capture.imagePreview.image
Class name for the image of the SelfieProgressPreview.
videoSignatureCapture.faceLiveness.success.container
Class name for the outermost container of the FaceLivenessSuccess screen.
videoSignatureCapture.faceLiveness.success.inner
Class name for the inner container of the FaceLivenessSuccess screen.
videoSignatureCapture.faceLiveness.success.heading
Class name for the heading of the FaceLivenessSuccess screen.
videoSignatureCapture.faceLiveness.success.imageContainer
Class name for the image container of the FaceLivenessSuccess screen.
videoSignatureCapture.faceLiveness.success.image
Class name for the image of the FaceLivenessSuccess screen.
videoSignatureCapture.faceLiveness.success.buttonsRow
Class name for the buttons row of the FaceLivenessSuccess screen.
videoSignatureCapture.faceLiveness.success.retryBtn
Class name for the retry button of the FaceLivenessSuccess screen.
videoSignatureCapture.faceLiveness.success.doneBtn
Class name for the done button of the FaceLivenessSuccess screen.
videoSignatureCapture.faceLiveness.failure.container
Class name for the outermost container of the FaceLivenessFailure screen.
videoSignatureCapture.faceLiveness.failure.inner
Class name for the inner container of the FaceLivenessFailure screen.
videoSignatureCapture.faceLiveness.failure.heading
Class name for the heading of the FaceLivenessFailure screen.
videoSignatureCapture.faceLiveness.failure.imageContainer
Class name for the image container of the FaceLivenessFailure screen.
videoSignatureCapture.faceLiveness.failure.image
Class name for the image of the FaceLivenessFailure screen.
videoSignatureCapture.faceLiveness.failure.buttonsRow
Class name for the buttons row of the FaceLivenessFailure screen.
videoSignatureCapture.faceLiveness.failure.retryBtn
Class name for the retry button of the FaceLivenessFailure screen.
videoSignatureCapture.faceLiveness.failure.exitBtn
Class name for the exit button of the FaceLivenessFailure screen.
videoSignatureCapture.faceLiveness.cameraStoreProvider.cameraTamperSeal.container
videoSignatureCapture.faceLiveness.cameraStoreProvider.cameraTamperSeal.inner
videoSignatureCapture.faceLiveness.cameraStoreProvider.cameraTamperSeal.heading
videoSignatureCapture.faceLiveness.cameraStoreProvider.cameraTamperSeal.message
videoSignatureCapture.success.container
Class name for the outermost container of the VideoSignatureSuccess screen.
videoSignatureCapture.success.inner
Class name for the inner container of the VideoSignatureSuccess screen.
videoSignatureCapture.success.heading
Class name for the heading of the VideoSignatureSuccess screen.
videoSignatureCapture.success.videoContainer
Class name for the video container of the VideoSignatureSuccess screen.
videoSignatureCapture.success.video
Class name for the video of the VideoSignatureSuccess screen.
videoSignatureCapture.success.buttonsRow
Class name for the buttons row of the VideoSignatureSuccess screen.
videoSignatureCapture.success.retryBtn
Class name for the retry button of the VideoSignatureSuccess screen.
videoSignatureCapture.success.doneBtn
Class name for the done button of the VideoSignatureSuccess screen.
videoSignatureCapture.cameraStoreProvider.cameraTamperSeal.container
videoSignatureCapture.cameraStoreProvider.cameraTamperSeal.inner
videoSignatureCapture.cameraStoreProvider.cameraTamperSeal.heading
videoSignatureCapture.cameraStoreProvider.cameraTamperSeal.message

Assets

faceLiveness.loadingOverlay.instructionImageUrl
URL to the instruction image on the loading overlay. Defaults to https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png.
faceLiveness.loadingOverlay.cameraAccessDenied.imageUrl
URL to the image to display when camera access is denied. Defaults to https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png.
faceLiveness.loadingOverlay.microphoneAccessDenied.imageUrl
URL to the image to display when microphone access is denied. Defaults to https://websdk-cdn-dev.idmission.com/assets/microphone-disable-icon.svg.
faceLiveness.failure.imageUrl
URL to the image to display on the FaceLivenessFailure screen. Defaults to https://websdk-cdn-dev.idmission.com/assets/Face_Not_Detected.svg.

Colors

faceLiveness.guidesUnsatisfiedColor
Color of the guides when they are not satisfied. Defaults to white.
faceLiveness.guidesSatisfiedColor
Color of the guides when they are satisfied. Defaults to green.
faceLiveness.guidanceMessagesSatisfiedBackgroundColor
Background color of the guidance messages when they are satisfied. Defaults to green.
faceLiveness.guidanceMessagesUnsatisfiedBackgroundColor
Background color of the guidance messages when they are not satisfied. Defaults to red.
faceLiveness.guidanceMessagesSatisfiedTextColor
Text color of the guidance messages when they are satisfied. Defaults to white.
faceLiveness.guidanceMessagesUnsatisfiedTextColor
Text color of the guidance messages when they are not satisfied. Defaults to white.
faceLiveness.loadingOverlay.continueBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
faceLiveness.loadingOverlay.continueBtn.borderColor
Border color of the button. Defaults to none.
faceLiveness.loadingOverlay.continueBtn.textColor
Text color of the button. Defaults to white.
faceLiveness.loadingOverlay.continueBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
faceLiveness.loadingOverlay.continueBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
faceLiveness.loadingOverlay.continueBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.borderColor
Border color of the button. Defaults to none.
faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.textColor
Text color of the button. Defaults to white.
faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.borderColor
Border color of the button. Defaults to none.
faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.textColor
Text color of the button. Defaults to white.
faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
faceLiveness.success.doneBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
faceLiveness.success.doneBtn.borderColor
Border color of the button. Defaults to none.
faceLiveness.success.doneBtn.textColor
Text color of the button. Defaults to white.
faceLiveness.success.doneBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
faceLiveness.success.doneBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
faceLiveness.success.doneBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
faceLiveness.success.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
faceLiveness.success.retryBtn.borderColor
Border color of the button. Defaults to none.
faceLiveness.success.retryBtn.textColor
Text color of the button. Defaults to white.
faceLiveness.success.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
faceLiveness.success.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
faceLiveness.success.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
faceLiveness.failure.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
faceLiveness.failure.retryBtn.borderColor
Border color of the button. Defaults to none.
faceLiveness.failure.retryBtn.textColor
Text color of the button. Defaults to white.
faceLiveness.failure.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
faceLiveness.failure.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
faceLiveness.failure.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
faceLiveness.failure.exitBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
faceLiveness.failure.exitBtn.borderColor
Border color of the button. Defaults to none.
faceLiveness.failure.exitBtn.textColor
Text color of the button. Defaults to white.
faceLiveness.failure.exitBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
faceLiveness.failure.exitBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
faceLiveness.failure.exitBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
videoSignatureCapture.guidanceMessageBackgroundColor
Background color of the guidance message. Defaults to #ccc.
videoSignatureCapture.guidanceMessageTextColor
Text color of the guidance message. Defaults to black.
videoSignatureCapture.faceLiveness.guidesUnsatisfiedColor
Color of the guides when they are not satisfied. Defaults to white.
videoSignatureCapture.faceLiveness.guidesSatisfiedColor
Color of the guides when they are satisfied. Defaults to green.
videoSignatureCapture.faceLiveness.guidanceMessagesSatisfiedBackgroundColor
Background color of the guidance messages when they are satisfied. Defaults to green.
videoSignatureCapture.faceLiveness.guidanceMessagesUnsatisfiedBackgroundColor
Background color of the guidance messages when they are not satisfied. Defaults to red.
videoSignatureCapture.faceLiveness.guidanceMessagesSatisfiedTextColor
Text color of the guidance messages when they are satisfied. Defaults to white.
videoSignatureCapture.faceLiveness.guidanceMessagesUnsatisfiedTextColor
Text color of the guidance messages when they are not satisfied. Defaults to white.
videoSignatureCapture.faceLiveness.loadingOverlay.continueBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
videoSignatureCapture.faceLiveness.loadingOverlay.continueBtn.borderColor
Border color of the button. Defaults to none.
videoSignatureCapture.faceLiveness.loadingOverlay.continueBtn.textColor
Text color of the button. Defaults to white.
videoSignatureCapture.faceLiveness.loadingOverlay.continueBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
videoSignatureCapture.faceLiveness.loadingOverlay.continueBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
videoSignatureCapture.faceLiveness.loadingOverlay.continueBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.borderColor
Border color of the button. Defaults to none.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.textColor
Text color of the button. Defaults to white.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.borderColor
Border color of the button. Defaults to none.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.textColor
Text color of the button. Defaults to white.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
videoSignatureCapture.faceLiveness.success.doneBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
videoSignatureCapture.faceLiveness.success.doneBtn.borderColor
Border color of the button. Defaults to none.
videoSignatureCapture.faceLiveness.success.doneBtn.textColor
Text color of the button. Defaults to white.
videoSignatureCapture.faceLiveness.success.doneBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
videoSignatureCapture.faceLiveness.success.doneBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
videoSignatureCapture.faceLiveness.success.doneBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
videoSignatureCapture.faceLiveness.success.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
videoSignatureCapture.faceLiveness.success.retryBtn.borderColor
Border color of the button. Defaults to none.
videoSignatureCapture.faceLiveness.success.retryBtn.textColor
Text color of the button. Defaults to white.
videoSignatureCapture.faceLiveness.success.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
videoSignatureCapture.faceLiveness.success.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
videoSignatureCapture.faceLiveness.success.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
videoSignatureCapture.faceLiveness.failure.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
videoSignatureCapture.faceLiveness.failure.retryBtn.borderColor
Border color of the button. Defaults to none.
videoSignatureCapture.faceLiveness.failure.retryBtn.textColor
Text color of the button. Defaults to white.
videoSignatureCapture.faceLiveness.failure.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
videoSignatureCapture.faceLiveness.failure.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
videoSignatureCapture.faceLiveness.failure.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
videoSignatureCapture.faceLiveness.failure.exitBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
videoSignatureCapture.faceLiveness.failure.exitBtn.borderColor
Border color of the button. Defaults to none.
videoSignatureCapture.faceLiveness.failure.exitBtn.textColor
Text color of the button. Defaults to white.
videoSignatureCapture.faceLiveness.failure.exitBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
videoSignatureCapture.faceLiveness.failure.exitBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
videoSignatureCapture.faceLiveness.failure.exitBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
videoSignatureCapture.success.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
videoSignatureCapture.success.retryBtn.borderColor
Border color of the button. Defaults to none.
videoSignatureCapture.success.retryBtn.textColor
Text color of the button. Defaults to white.
videoSignatureCapture.success.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
videoSignatureCapture.success.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
videoSignatureCapture.success.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.
videoSignatureCapture.success.doneBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.
videoSignatureCapture.success.doneBtn.borderColor
Border color of the button. Defaults to none.
videoSignatureCapture.success.doneBtn.textColor
Text color of the button. Defaults to white.
videoSignatureCapture.success.doneBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.
videoSignatureCapture.success.doneBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.
videoSignatureCapture.success.doneBtn.loadingTextColor
Text color of the button while loading. Defaults to white.

Verbiage

faceLiveness.guidanceHoldStillText
Text to display on the guidance message when capture/verification is in progress. Defaults to “Hold still for a few seconds…“.
faceLiveness.guidanceLookStraightText
Text to display on the guidance message when the user is not looking at the camera. Defaults to “Look straight into the camera…“.
faceLiveness.guidanceMoveBackText
Text to display on the guidance message when the user is too close to the camera. Defaults to “Move back…“.
faceLiveness.guidanceMoveForwardText
Text to display on the guidance message when the user is too far from the camera. Defaults to “Move forward…“.
faceLiveness.guidanceMoveToCenterText
Text to display on the guidance message when the user’s face is not centered in the frame. Defaults to “Move to the center…“.
faceLiveness.guidanceNoFaceDetectedText
Text to display on the guidance message when the user’s face is not detected in the frame. Defaults to “Waiting for face to be detected…“.
faceLiveness.guidanceNotStableText
Text to display on the guidance message when the user’s face is not stable. Defaults to “Please hold still…“.
faceLiveness.guidanceRemoveEyeCoveringsText
Text to display on the guidance message when the user is wearing dark sunglasses, eye patches, etc. Defaults to “Remove Sunglasses & Hat”.
faceLiveness.guidanceRemoveHeadCoveringsText
Text to display on the guidance message when the user is wearing a hat. Defaults to “Remove Head Coverings”.
faceLiveness.guidanceRemoveMaskText
Text to display on the guidance message when the user is wearing a mask. Defaults to “Remove Mask”.
faceLiveness.progressPreviewText
Text to display on the progress preview of the FaceLivenessCapture screen. Defaults to “Processing…“.
faceLiveness.guidanceLivenessCheckFailedText
Text to display on the guidance message when liveness check failed. Defaults to “Could not verify your face.”.
faceLiveness.guidanceLivenessCheckErrorText
Text to display on the guidance message when liveness check failed. Defaults to “An error occurred while verifying your face.”.
faceLiveness.loadingOverlay.headingText
Text to display on the heading of the SelfieCaptureLoadingOverlay. Defaults to “Use your device camera to capture your face”.
faceLiveness.loadingOverlay.removeEyeCoveringsText
Text to display on the SelfieCaptureLoadingOverlay when the user is wearing dark sunglasses, eye patches, etc. Defaults to “Remove Sunglasses & Hat”.
faceLiveness.loadingOverlay.avoidExcessiveBacklightingText
Text to display on the SelfieCaptureLoadingOverlay when the lighting in the background is too bright. Defaults to “Avoid Excessive Backlighting”.
faceLiveness.loadingOverlay.continueText
Text to display on the continue button of the SelfieCaptureLoadingOverlay. Defaults to “Continue”.
faceLiveness.loadingOverlay.pleaseWaitText
Text to display on the SelfieCaptureLoadingOverlay when the user is waiting. Defaults to “Please wait…“.
faceLiveness.loadingOverlay.cameraInitializingText
Text to display on the SelfieCaptureLoadingOverlay when access to the camera is being requested. Defaults to “Camera initializing…“.
faceLiveness.loadingOverlay.downloadingText
Text to display on the SelfieCaptureLoadingOverlay when the models are being downloaded. Defaults to “Downloading…“.
faceLiveness.loadingOverlay.modelsWarmingUpText
Text to display on the SelfieCaptureLoadingOverlay when the models are warming up. Defaults to “Models warming up…“.
faceLiveness.loadingOverlay.modelsReadyText
Text to display on the SelfieCaptureLoadingOverlay when the models are ready. Defaults to “Guided capture experience ready”.
faceLiveness.loadingOverlay.cameraInitializedText
Text to display on the SelfieCaptureLoadingOverlay when the camera is ready. Defaults to “Camera ready”.
faceLiveness.loadingOverlay.cameraAccessDenied.headingText
Text informing the user that camera access is denied. Defaults to “Your camera permission is disabled”.
faceLiveness.loadingOverlay.cameraAccessDenied.descriptionText
Text elaborating on the meaning of camera access being denied. Defaults to “This application requires access to your camera to continue. Please accept the permission once prompted by the browser. If the browser does not prompt for camera permissions, you must go to settings and provide camera access to the current browser.”.
faceLiveness.loadingOverlay.cameraAccessDenied.retryBtnText
Text for the button that will retry camera access. Defaults to “Retry”.
faceLiveness.loadingOverlay.microphoneAccessDenied.headingText
Text to display on the heading of the MicrophoneAccessDeniedOverlay. Defaults to “Your microphone permission is disabled”.
faceLiveness.loadingOverlay.microphoneAccessDenied.descriptionText
Text to display on the description of the MicrophoneAccessDeniedOverlay. Defaults to “This application requires access to your microphone to continue. Please accept the permission once prompted by the browser. If the browser does not prompt for microphone permissions, you must go to settings and provide microphone access to the current browser.”.
faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtnText
Text to display on the retry button of the MicrophoneAccessDeniedOverlay. Defaults to “Retry”.
faceLiveness.loadingOverlay.sessionCheckingText
Text to display on the SelfieCaptureLoadingOverlay when the session is being checked. Defaults to “Authenticating…“.
faceLiveness.success.headingText
Text to display on the heading of the FaceLivenessSuccess screen. Defaults to “Face liveness has been verified!“.
faceLiveness.success.retryBtnText
Text to display on the retry button of the FaceLivenessSuccess screen. Defaults to “Retry”.
faceLiveness.success.doneBtnText
Text to display on the done button of the FaceLivenessSuccess screen. Defaults to “Done”.
faceLiveness.failure.headingText
Text to display on the heading of the FaceLivenessFailure screen. Defaults to “Live face not detected, please try again”.
faceLiveness.failure.retryBtnText
Text to display on the retry button of the FaceLivenessFailure screen. Defaults to “Retry”.
faceLiveness.failure.exitBtnText
Text to display on the exit button of the FaceLivenessFailure screen. Defaults to “Exit”.
faceLiveness.cameraStoreProvider.cameraTamperSeal.headingText
faceLiveness.cameraStoreProvider.cameraTamperSeal.messageText
additionalDocumentCapture.headingText
Text to display on the heading of the AdditionalDocumentCapture screen. Defaults to “Additional document capture”.
additionalDocumentCapture.captureBtnText
Text to display on the capture button of the AdditionalDocumentCapture screen. Defaults to “Capture”.
additionalDocumentCapture.nextBtnText
Text to display on the next button of the AdditionalDocumentCapture screen. Defaults to “Next”.
signatureCapture.headingText
Text to display on the heading of the SignatureCapture screen. Defaults to “Please sign the box below”.
signatureCapture.acceptBtnText
Text to display on the accept button of the SignatureCapture screen. Defaults to “Accept”.
signatureCapture.clearBtnText
Text to display on the clear button of the SignatureCapture screen. Defaults to “Clear”.
videoSignatureCapture.guidanceMessageText
Text to display on the guidance message of the VideoSignatureCapture screen. Defaults to “Please sign the box below”.
videoSignatureCapture.guides.signaturePadEmptyText
Text to display on the signature pad empty content of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.headTrackingUnsatisfiedText
Text to display on the head tracking unsatisfied content of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.clearSignatureBtnText
Text to display on the clear signature button of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.guides.acceptSignatureBtnText
Text to display on the accept signature button of the SignatureVideoCaptureGuides screen.
videoSignatureCapture.faceLiveness.guidanceHoldStillText
Text to display on the guidance message when capture/verification is in progress. Defaults to “Hold still for a few seconds…“.
videoSignatureCapture.faceLiveness.guidanceLookStraightText
Text to display on the guidance message when the user is not looking at the camera. Defaults to “Look straight into the camera…“.
videoSignatureCapture.faceLiveness.guidanceMoveBackText
Text to display on the guidance message when the user is too close to the camera. Defaults to “Move back…“.
videoSignatureCapture.faceLiveness.guidanceMoveForwardText
Text to display on the guidance message when the user is too far from the camera. Defaults to “Move forward…“.
videoSignatureCapture.faceLiveness.guidanceMoveToCenterText
Text to display on the guidance message when the user’s face is not centered in the frame. Defaults to “Move to the center…“.
videoSignatureCapture.faceLiveness.guidanceNoFaceDetectedText
Text to display on the guidance message when the user’s face is not detected in the frame. Defaults to “Waiting for face to be detected…“.
videoSignatureCapture.faceLiveness.guidanceNotStableText
Text to display on the guidance message when the user’s face is not stable. Defaults to “Please hold still…“.
videoSignatureCapture.faceLiveness.guidanceRemoveEyeCoveringsText
Text to display on the guidance message when the user is wearing dark sunglasses, eye patches, etc. Defaults to “Remove Sunglasses & Hat”.
videoSignatureCapture.faceLiveness.guidanceRemoveHeadCoveringsText
Text to display on the guidance message when the user is wearing a hat. Defaults to “Remove Head Coverings”.
videoSignatureCapture.faceLiveness.guidanceRemoveMaskText
Text to display on the guidance message when the user is wearing a mask. Defaults to “Remove Mask”.
videoSignatureCapture.faceLiveness.progressPreviewText
Text to display on the progress preview of the FaceLivenessCapture screen. Defaults to “Processing…“.
videoSignatureCapture.faceLiveness.guidanceLivenessCheckFailedText
Text to display on the guidance message when liveness check failed. Defaults to “Could not verify your face.”.
videoSignatureCapture.faceLiveness.guidanceLivenessCheckErrorText
Text to display on the guidance message when liveness check failed. Defaults to “An error occurred while verifying your face.”.
videoSignatureCapture.faceLiveness.loadingOverlay.headingText
Text to display on the heading of the SelfieCaptureLoadingOverlay. Defaults to “Use your device camera to capture your face”.
videoSignatureCapture.faceLiveness.loadingOverlay.removeEyeCoveringsText
Text to display on the SelfieCaptureLoadingOverlay when the user is wearing dark sunglasses, eye patches, etc. Defaults to “Remove Sunglasses & Hat”.
videoSignatureCapture.faceLiveness.loadingOverlay.avoidExcessiveBacklightingText
Text to display on the SelfieCaptureLoadingOverlay when the lighting in the background is too bright. Defaults to “Avoid Excessive Backlighting”.
videoSignatureCapture.faceLiveness.loadingOverlay.continueText
Text to display on the continue button of the SelfieCaptureLoadingOverlay. Defaults to “Continue”.
videoSignatureCapture.faceLiveness.loadingOverlay.pleaseWaitText
Text to display on the SelfieCaptureLoadingOverlay when the user is waiting. Defaults to “Please wait…“.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraInitializingText
Text to display on the SelfieCaptureLoadingOverlay when access to the camera is being requested. Defaults to “Camera initializing…“.
videoSignatureCapture.faceLiveness.loadingOverlay.downloadingText
Text to display on the SelfieCaptureLoadingOverlay when the models are being downloaded. Defaults to “Downloading…“.
videoSignatureCapture.faceLiveness.loadingOverlay.modelsWarmingUpText
Text to display on the SelfieCaptureLoadingOverlay when the models are warming up. Defaults to “Models warming up…“.
videoSignatureCapture.faceLiveness.loadingOverlay.modelsReadyText
Text to display on the SelfieCaptureLoadingOverlay when the models are ready. Defaults to “Guided capture experience ready”.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraInitializedText
Text to display on the SelfieCaptureLoadingOverlay when the camera is ready. Defaults to “Camera ready”.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.headingText
Text informing the user that camera access is denied. Defaults to “Your camera permission is disabled”.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.descriptionText
Text elaborating on the meaning of camera access being denied. Defaults to “This application requires access to your camera to continue. Please accept the permission once prompted by the browser. If the browser does not prompt for camera permissions, you must go to settings and provide camera access to the current browser.”.
videoSignatureCapture.faceLiveness.loadingOverlay.cameraAccessDenied.retryBtnText
Text for the button that will retry camera access. Defaults to “Retry”.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.headingText
Text to display on the heading of the MicrophoneAccessDeniedOverlay. Defaults to “Your microphone permission is disabled”.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.descriptionText
Text to display on the description of the MicrophoneAccessDeniedOverlay. Defaults to “This application requires access to your microphone to continue. Please accept the permission once prompted by the browser. If the browser does not prompt for microphone permissions, you must go to settings and provide microphone access to the current browser.”.
videoSignatureCapture.faceLiveness.loadingOverlay.microphoneAccessDenied.retryBtnText
Text to display on the retry button of the MicrophoneAccessDeniedOverlay. Defaults to “Retry”.
videoSignatureCapture.faceLiveness.loadingOverlay.sessionCheckingText
Text to display on the SelfieCaptureLoadingOverlay when the session is being checked. Defaults to “Authenticating…“.
videoSignatureCapture.faceLiveness.success.headingText
Text to display on the heading of the FaceLivenessSuccess screen. Defaults to “Face liveness has been verified!“.
videoSignatureCapture.faceLiveness.success.retryBtnText
Text to display on the retry button of the FaceLivenessSuccess screen. Defaults to “Retry”.
videoSignatureCapture.faceLiveness.success.doneBtnText
Text to display on the done button of the FaceLivenessSuccess screen. Defaults to “Done”.
videoSignatureCapture.faceLiveness.failure.headingText
Text to display on the heading of the FaceLivenessFailure screen. Defaults to “Live face not detected, please try again”.
videoSignatureCapture.faceLiveness.failure.retryBtnText
Text to display on the retry button of the FaceLivenessFailure screen. Defaults to “Retry”.
videoSignatureCapture.faceLiveness.failure.exitBtnText
Text to display on the exit button of the FaceLivenessFailure screen. Defaults to “Exit”.
videoSignatureCapture.faceLiveness.cameraStoreProvider.cameraTamperSeal.headingText
videoSignatureCapture.faceLiveness.cameraStoreProvider.cameraTamperSeal.messageText
videoSignatureCapture.success.headingText
Text to display on the heading of the VideoSignatureSuccess screen. Defaults to “Video signature has been successfully captured!“.
videoSignatureCapture.success.retryBtnText
Text to display on the retry button of the VideoSignatureSuccess screen. Defaults to “Retry”.
videoSignatureCapture.success.doneBtnText
Text to display on the done button of the VideoSignatureSuccess screen. Defaults to “Done”.
videoSignatureCapture.cameraStoreProvider.cameraTamperSeal.headingText
videoSignatureCapture.cameraStoreProvider.cameraTamperSeal.messageText