Face Validation

Render a fullscreen capture component that analyzes frames from the user’s front-facing camera to determine whether a live human face is present.

View Live Demos

Example

React


import { FaceValidation } from "idmission-web-sdk";
 
async function getSessionId() {
  const resp = await fetch("/api/get-session");
  return (await resp.json()).id;
}
 
export default function App() {
  return (
    <FaceValidation sessionId={getSessionId} />
  )
}

Props

sessionId
A session identifier generated with your IDmission credentials.

apiUrl
Portal API base URL. Supplies defaults for the three URLs below.

submissionUrl
URL used for submission requests.

authUrl
URL to validate the session against.

documentServiceUrl
URL to upload captured documents to via Tus.

loadingSpinner
React component rendered in place of the SDK’s own loading indicator, on every loading surface a flow shows: session validation, model loading, the stage-transition screen, and submission. It receives a stage saying which, and — for model-loading, the only determinate one — a progress percentage, because the built-in ring it replaces there is driven by real model-download progress. Rendering null falls back to the SDK’s indicator rather than showing nothing, so an unhandled stage cannot leave a loading screen bare.

clientRequestID

jobId

taskId

sendBase64DocumentsInSwaggerProxy

companyId

needImmediateResponse

useDocumentServiceForLivenessChecks

webhooksEnabled

webhooksURL

webhooksClientTraceId

webhooksStripSpecialCharacters

webhooksSendInputImages

webhooksSendProcessedImages

webhooksFireOnReview

webhooksFireOnReviewURL

onBeforeDocumentUpload

onDocumentUploadProgress

onDocumentUploaded

onDocumentUploadFailed

onAuthError

onLoadingStarted

onLoadingProgress

onLoadingCompleted

onLoadingFailed

enableTamperDetection
When true, integrity checks run and may block the camera.

mediaIntegrityToken
An opaque token created by captureMediaIntegrity() at boot time.

onUserCancel

onCameraAccessDenied

onCameraTamperingDetected

onExitAfterTamperSealPopped

lang

theme

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

remoteDiagnostics
Opt-in remote diagnostics: crash/breadcrumb capture and reporting.

faceDetector

faceLandmarkerRuntime

showFaceLandmarks

challengeResponse

estimateAge
Accepted for 2.x compatibility but has no effect.

predictGender
Accepted for 2.x compatibility but has no effect.

loadingOverlayMode

autoContinueAfterLoading

showIntroScreen

initialCaptureDelayMs

timeoutDurationMs

modelLoadTimeoutMs
Accepted for 2.x compatibility but has no effect.

runtime

skipSuccessScreen

idCardForFaceMatch

allowVirtualCameras

onBeforeSubmit
NOTE the 2.x argument type: on the face-only flow onBeforeSubmit receives the LIVENESS request, so it maps to the client’s onBeforeLivenessCheck rather than its onBeforeSubmit.

onComplete

onApproved

onDenied

onRequestFailure

onExitCapture

onExitAfterFailure

onModelError
Accepted for 2.x compatibility but has no effect.

assets

classNames

colors

verbiage

Class Names

container

finishingScreen.finishingScreen
Class name for the finishing screen’s content container.

finishingScreen.finishingThumb
Class name for the selfie thumbnail (or its fallback badge).

finishingScreen.finishingTitle
Class name for the title.

finishingScreen.finishingStageList
Class name for the stage list.

finishingScreen.finishingStage
Class name for each stage row.

successScreen.successScreen
Class name for the success screen’s content container.

successScreen.successCheck
Class name for the big check badge.

successScreen.successTitle
Class name for the title.

successScreen.successSubtitle
Class name for the subtitle block.

successScreen.successStatList
Class name for the stat chip row.

successScreen.successStat
Class name for each stat chip.

loadingOverlay.container
Class name for the outermost container of the SelfieCaptureLoadingOverlay.

loadingOverlay.inner
Class name for the inner container of the SelfieCaptureLoadingOverlay.

loadingOverlay.headingContainer
Class name for the heading container of the SelfieCaptureLoadingOverlay.

loadingOverlay.heading
Class name for the heading of the SelfieCaptureLoadingOverlay.

loadingOverlay.imageContainer
Class name for the image container of the SelfieCaptureLoadingOverlay.

loadingOverlay.image
Class name for the image of the SelfieCaptureLoadingOverlay.

loadingOverlay.buttonsRow
Class name for the buttons row of the SelfieCaptureLoadingOverlay.

loadingOverlay.continueBtnContainer
Class name for the continue button container of the SelfieCaptureLoadingOverlay.

loadingOverlay.continueBtn
Class name for the continue button of the SelfieCaptureLoadingOverlay.

loadingOverlay.cancelBtn
Class name for the cancel button of the SelfieCaptureLoadingOverlay.

loadingOverlay.cameraAccessDenied.container
Class name for the outermost container of the CameraAccessDeniedOverlay.

loadingOverlay.cameraAccessDenied.inner
Class name for the inner container of the CameraAccessDeniedOverlay.

loadingOverlay.cameraAccessDenied.imageContainer
Class name for the container of the image in the CameraAccessDeniedOverlay.

loadingOverlay.cameraAccessDenied.image
Class name for the image in the CameraAccessDeniedOverlay.

loadingOverlay.cameraAccessDenied.heading
Class name for the heading of the CameraAccessDeniedOverlay.

loadingOverlay.cameraAccessDenied.description
Class name for the description text of the CameraAccessDeniedOverlay.

loadingOverlay.cameraAccessDenied.retryBtn
Class name for the button that will retry camera access in the CameraAccessDeniedOverlay.

loadingOverlay.microphoneAccessDenied.container
Class name for the outermost container of the MicrophoneAccessDeniedOverlay.

loadingOverlay.microphoneAccessDenied.inner
Class name for the inner container of the MicrophoneAccessDeniedOverlay.

loadingOverlay.microphoneAccessDenied.imageContainer
Class name for the image container of the MicrophoneAccessDeniedOverlay.

loadingOverlay.microphoneAccessDenied.image
Class name for the image of the MicrophoneAccessDeniedOverlay.

loadingOverlay.microphoneAccessDenied.heading
Class name for the heading of the MicrophoneAccessDeniedOverlay.

loadingOverlay.microphoneAccessDenied.description
Class name for the description of the MicrophoneAccessDeniedOverlay.

loadingOverlay.microphoneAccessDenied.retryBtn
Class name for the retry button of the MicrophoneAccessDeniedOverlay.

loadingOverlay.progressContainer
Class name for the progress container of the SelfieCaptureLoadingOverlay.

loadingOverlay.progressBackground
Class name for the progress background of the SelfieCaptureLoadingOverlay.

loadingOverlay.progressBar
Class name for the progress bar of the SelfieCaptureLoadingOverlay.

loadingOverlay.progressIndicator
Class name for the progress indicator of the SelfieCaptureLoadingOverlay.

loadingOverlay.loadingListContainer
Class name for the loading list container of the SelfieCaptureLoadingOverlay.

loadingOverlay.loadingList
Class name for the loading list of the SelfieCaptureLoadingOverlay.

loadingOverlay.loadingListItem
Class name for the loading list items of the SelfieCaptureLoadingOverlay.

loadingOverlay.loadingListItemIndicator
Class name for the icons on the loading list items of the SelfieCaptureLoadingOverlay.

loadingOverlay.ring
Class name for the ring SVG in ring mode.

loadingOverlay.ringTrack
Class name for the ring’s track circle in ring mode.

loadingOverlay.ringFill
Class name for the ring’s progress circle in ring mode.

loadingOverlay.statusLine
Class name for the status line in ring mode.

loadingOverlay.subText
Class name for the reassurance subtext in ring mode.

loadingOverlay.introPage

loadingOverlay.introBadge

loadingOverlay.introTitle

loadingOverlay.introSubtitle

loadingOverlay.introSteps

loadingOverlay.introStep

loadingOverlay.introStepDot

loadingOverlay.introReassuranceChip

loadingOverlay.introStartBtn

loadingOverlay.introPrivacy

loadingOverlay.stageTransition
Class name for the ID→selfie handoff container in ring mode.

loadingOverlay.stageTransitionBadge
Class name for the handoff’s flipping badge.

loadingOverlay.stageTransitionTitle
Class name for the handoff’s title.

loadingOverlay.stageTransitionSubtitle
Class name for the handoff’s subtitle.

capture.container
Class name for the outermost container of the SelfieCapture screen.

capture.cameraFeed
Class name for the camera feed component of the SelfieCapture screen.

capture.guides.container
Class name for the outermost container of the FaceCaptureGuideOverlay.

capture.guides.oval
Class name for the oval of the FaceCaptureGuideOverlay.

capture.guidanceMessageContainer
Class name for the guidance message container of the SelfieCapture screen.

capture.guidanceMessage
Class name for the guidance message of the SelfieCapture screen.

capture.exitCaptureBtn
Class name for the exit capture button of the SelfieCapture screen.

capture.fallback.container
Class name for the outermost container of the SelfieCaptureFallback.

capture.fallback.inner
Class name for the inner container of the SelfieCaptureFallback.

capture.fallback.heading
Class name for the heading of the SelfieCaptureFallback.

capture.fallback.description
Class name for the description of the SelfieCaptureFallback.

capture.fallback.imageContainer
Class name for the container of the image in the SelfieCaptureFallback.

capture.fallback.image
Class name for the image in the SelfieCaptureFallback.

capture.fallback.buttonsRow
Class name for the buttons row in the SelfieCaptureFallback.

capture.fallback.captureBtn
Class name for the capture button in the SelfieCaptureFallback.

capture.fallback.doneBtn
Class name for the done button in the SelfieCaptureFallback.

capture.fallback.retryCaptureBtn
Class name for the retry capture button in the SelfieCaptureFallback.

capture.fallback.documentCaptureClassNames.container

capture.fallback.documentCaptureClassNames.cameraFeedWrapper

capture.fallback.documentCaptureClassNames.cameraFeed

capture.fallback.documentCaptureClassNames.previewImage

capture.fallback.documentCaptureClassNames.captureContainer

capture.fallback.documentCaptureClassNames.headingRow

capture.fallback.documentCaptureClassNames.heading

capture.fallback.documentCaptureClassNames.footerRow

capture.fallback.documentCaptureClassNames.instructions

capture.fallback.documentCaptureClassNames.buttonsRow

capture.fallback.documentCaptureClassNames.retryCameraAccessBtn

capture.fallback.documentCaptureClassNames.retryCaptureBtn

capture.fallback.documentCaptureClassNames.uploadBtn

capture.fallback.documentCaptureClassNames.uploadProgressBtn

capture.fallback.documentCaptureClassNames.captureBtn

capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.container

capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.inner

capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.heading

capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.message

capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.exitButton

capture.manualCaptureBtn
Class name for the manual capture button of the SelfieCapture screen.

capture.manualCaptureBtnContainer
Class name for the container of the manual capture button of the SelfieCapture screen.

capture.imagePreview.container
Class name for the outermost container of the SelfieProgressPreview.

capture.imagePreview.text
Class name for the text of the SelfieProgressPreview.

capture.imagePreview.spinner
Class name for the spinner of the SelfieProgressPreview.

capture.imagePreview.imageContainer
Class name for the image container of the SelfieProgressPreview.

capture.imagePreview.image
Class name for the image of the SelfieProgressPreview.

success.container
Class name for the outermost container of the FaceLivenessSuccess screen.

success.inner
Class name for the inner container of the FaceLivenessSuccess screen.

success.heading
Class name for the heading of the FaceLivenessSuccess screen.

success.imageContainer
Class name for the image container of the FaceLivenessSuccess screen.

success.image
Class name for the image of the FaceLivenessSuccess screen.

success.buttonsRow
Class name for the buttons row of the FaceLivenessSuccess screen.

success.retryBtn
Class name for the retry button of the FaceLivenessSuccess screen.

success.doneBtn
Class name for the done button of the FaceLivenessSuccess screen.

failure.container
Class name for the outermost container of the FaceLivenessFailure screen.

failure.inner
Class name for the inner container of the FaceLivenessFailure screen.

failure.heading
Class name for the heading of the FaceLivenessFailure screen.

failure.imageContainer
Class name for the image container of the FaceLivenessFailure screen.

failure.image
Class name for the image of the FaceLivenessFailure screen.

failure.buttonsRow
Class name for the buttons row of the FaceLivenessFailure screen.

failure.retryBtn
Class name for the retry button of the FaceLivenessFailure screen.

failure.exitBtn
Class name for the exit button of the FaceLivenessFailure screen.

cameraStoreProvider.cameraTamperSeal.container

cameraStoreProvider.cameraTamperSeal.inner

cameraStoreProvider.cameraTamperSeal.heading

cameraStoreProvider.cameraTamperSeal.message

cameraStoreProvider.cameraTamperSeal.exitButton

Assets

loadingOverlay.instructionImageUrl
URL to the instruction image on the loading overlay. Defaults to https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png .

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 .

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 .

loadingOverlay.introStep1Emoji

loadingOverlay.introStep2Emoji

loadingOverlay.transitionEmoji
Ring mode: emoji on the flipped badge of the ID→selfie handoff. Defaults to 🤳.

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

guidesUnsatisfiedColor
Color of the guides when they are not satisfied. Defaults to white.

guidesSatisfiedColor
Color of the guides when they are satisfied. Defaults to green.

guidanceMessagesSatisfiedBackgroundColor
Background color of the guidance messages when they are satisfied. Defaults to green.

guidanceMessagesUnsatisfiedBackgroundColor
Background color of the guidance messages when they are not satisfied. Defaults to red.

guidanceMessagesSatisfiedTextColor
Text color of the guidance messages when they are satisfied. Defaults to white.

guidanceMessagesUnsatisfiedTextColor
Text color of the guidance messages when they are not satisfied. Defaults to white.

loadingOverlay.continueBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.

loadingOverlay.continueBtn.borderColor
Border color of the button. Defaults to none.

loadingOverlay.continueBtn.textColor
Text color of the button. Defaults to white.

loadingOverlay.continueBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.

loadingOverlay.continueBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.

loadingOverlay.continueBtn.loadingTextColor
Text color of the button while loading. Defaults to white.

loadingOverlay.cameraAccessDenied.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.

loadingOverlay.cameraAccessDenied.retryBtn.borderColor
Border color of the button. Defaults to none.

loadingOverlay.cameraAccessDenied.retryBtn.textColor
Text color of the button. Defaults to white.

loadingOverlay.cameraAccessDenied.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.

loadingOverlay.cameraAccessDenied.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.

loadingOverlay.cameraAccessDenied.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.

loadingOverlay.microphoneAccessDenied.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.

loadingOverlay.microphoneAccessDenied.retryBtn.borderColor
Border color of the button. Defaults to none.

loadingOverlay.microphoneAccessDenied.retryBtn.textColor
Text color of the button. Defaults to white.

loadingOverlay.microphoneAccessDenied.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.

loadingOverlay.microphoneAccessDenied.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.

loadingOverlay.microphoneAccessDenied.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.

success.doneBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.

success.doneBtn.borderColor
Border color of the button. Defaults to none.

success.doneBtn.textColor
Text color of the button. Defaults to white.

success.doneBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.

success.doneBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.

success.doneBtn.loadingTextColor
Text color of the button while loading. Defaults to white.

success.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.

success.retryBtn.borderColor
Border color of the button. Defaults to none.

success.retryBtn.textColor
Text color of the button. Defaults to white.

success.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.

success.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.

success.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.

failure.retryBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.

failure.retryBtn.borderColor
Border color of the button. Defaults to none.

failure.retryBtn.textColor
Text color of the button. Defaults to white.

failure.retryBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.

failure.retryBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.

failure.retryBtn.loadingTextColor
Text color of the button while loading. Defaults to white.

failure.exitBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.

failure.exitBtn.borderColor
Border color of the button. Defaults to none.

failure.exitBtn.textColor
Text color of the button. Defaults to white.

failure.exitBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.

failure.exitBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.

failure.exitBtn.loadingTextColor
Text color of the button while loading. Defaults to white.

Verbiage

guidanceHoldStillText
Text to display on the guidance message when capture/verification is in progress. Defaults to “Hold still for a few seconds…“.

guidanceLookStraightText
Text to display on the guidance message when the user is not looking at the camera. Defaults to “Look straight into the camera…“.

guidanceMoveBackText
Text to display on the guidance message when the user is too close to the camera. Defaults to “Move back…“.

guidanceMoveForwardText
Text to display on the guidance message when the user is too far from the camera. Defaults to “Move forward…“.

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…“.

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…“.

guidanceVisibilityTooLowText
Text shown when the user needs better lighting. Defaults to “Improve lighting conditions…“.

guidanceNotStableText
Text to display on the guidance message when the user’s face is not stable. Defaults to “Please hold still…“.

guidanceManualCaptureText
Text to display on the guidance message when the user is allowed to manually capture. Defaults to “Position your face in the circle and click to capture.”.

manualCaptureBtnText
Text to display on the manual capture button. Defaults to “Capture”.

guidanceRemoveEyeCoveringsText
Text to display on the guidance message when the user is wearing dark sunglasses, eye patches, etc. Defaults to “Remove Sunglasses & Hat”.

guidanceRemoveHeadCoveringsText
Text to display on the guidance message when the user is wearing a hat. Defaults to “Remove Head Coverings”.

guidanceRemoveMaskText
Text to display on the guidance message when the user is wearing a mask. Defaults to “Remove Mask”.

progressPreviewText
Text to display on the progress preview of the FaceLivenessCapture screen. Defaults to “Processing…“.

guidanceValidatingText
Text to display on the guidance message when the selfie has been captured and is being validated. Defaults to “Photo captured, verifying…“.

guidanceLivenessCheckFailedText
Text to display on the guidance message when liveness check failed. Defaults to “Could not verify your face.”.

guidanceLivenessCheckErrorText
Text to display on the guidance message when liveness check failed. Defaults to “An error occurred while verifying your face.”.

challengeTurnLeftText
Text to display when the challenge asks the user to turn their head left. Defaults to “Turn your head left”.

challengeTurnRightText
Text to display when the challenge asks the user to turn their head right. Defaults to “Turn your head right”.

challengeBlinkText
Text to display when the challenge asks the user to blink. Defaults to “Blink”.

challengeBlinkTwiceText
Text to display when the challenge asks the user to blink twice (consecutive blinks). Defaults to “Blink twice”.

challengeReturnToCenterText
Text to display after a head-turn extreme is reached, asking the user to face forward again. Defaults to “Return to center”.

challengeTimeoutText
Text to display when a challenge wasn’t completed in time (distinct from a liveness failure). Defaults to “Let’s try that again — please follow the prompts.”.

loadingOverlay.headingText
Text to display on the heading of the SelfieCaptureLoadingOverlay. Defaults to “Use your device camera to capture your face”.

loadingOverlay.removeEyeCoveringsText
Text to display on the SelfieCaptureLoadingOverlay when the user is wearing dark sunglasses, eye patches, etc. Defaults to “Remove Sunglasses & Hat”.

loadingOverlay.avoidExcessiveBacklightingText
Text to display on the SelfieCaptureLoadingOverlay when the lighting in the background is too bright. Defaults to “Avoid Excessive Backlighting”.

loadingOverlay.continueText
Text to display on the continue button of the SelfieCaptureLoadingOverlay. Defaults to “Continue”.

loadingOverlay.pleaseWaitText
Text to display on the SelfieCaptureLoadingOverlay when the user is waiting. Defaults to “Please wait…“.

loadingOverlay.cameraInitializingText
Text to display on the SelfieCaptureLoadingOverlay when access to the camera is being requested. Defaults to “Camera initializing…“.

loadingOverlay.downloadingText
Text to display on the SelfieCaptureLoadingOverlay when the models are being downloaded. Defaults to “Downloading…“.

loadingOverlay.modelsWarmingUpText
Text to display on the SelfieCaptureLoadingOverlay when the models are warming up. Defaults to “Models warming up…“.

loadingOverlay.modelsReadyText
Text to display on the SelfieCaptureLoadingOverlay when the models are ready. Defaults to “Guided capture experience ready”.

loadingOverlay.cameraInitializedText
Text to display on the SelfieCaptureLoadingOverlay when the camera is ready. Defaults to “Camera ready”.

loadingOverlay.cameraAccessDenied.headingText
Text informing the user that camera access is denied. Defaults to “Your camera permission is disabled”.

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.”.

loadingOverlay.cameraAccessDenied.retryBtnText
Text for the button that will retry camera access. Defaults to “Retry”.

loadingOverlay.microphoneAccessDenied.headingText
Text to display on the heading of the MicrophoneAccessDeniedOverlay. Defaults to “Your microphone permission is disabled”.

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.”.

loadingOverlay.microphoneAccessDenied.retryBtnText
Text to display on the retry button of the MicrophoneAccessDeniedOverlay. Defaults to “Retry”.

loadingOverlay.sessionCheckingText
Text to display on the SelfieCaptureLoadingOverlay when the session is being checked. Defaults to “Authenticating…“.

loadingOverlay.ringCameraWarmingText
Ring mode: status line while the camera initializes. Defaults to “Getting your camera ready…“.

loadingOverlay.ringReadyText
Ring mode: status line when everything is ready. Defaults to “Ready!“.

loadingOverlay.ringOnlyHappensOnceText
Ring mode: reassurance subtext under the status line. Defaults to “One moment — this only happens once.”.

loadingOverlay.introTitleText

loadingOverlay.introSubtitleText

loadingOverlay.introStep1Text

loadingOverlay.introStep2Text

loadingOverlay.introReassuranceChipText

loadingOverlay.introEnableCameraText

loadingOverlay.introRequestingCameraText

loadingOverlay.introPrivacyText

loadingOverlay.transitionIdCapturedText
Ring mode: microcopy under the check badge during the ID→selfie handoff. Defaults to “ID captured”.

loadingOverlay.transitionTitleText
Ring mode: title after the handoff badge flips. Defaults to “Now, a quick selfie”.

loadingOverlay.transitionSubtitleText
Ring mode: subtitle after the handoff badge flips. Defaults to “Look at your front camera”.

success.headingText
Text to display on the heading of the FaceLivenessSuccess screen. Defaults to “Face liveness has been verified!“.

success.retryBtnText
Text to display on the retry button of the FaceLivenessSuccess screen. Defaults to “Retry”.

success.doneBtnText
Text to display on the done button of the FaceLivenessSuccess screen. Defaults to “Done”.

failure.headingText
Text to display on the heading of the FaceLivenessFailure screen. Defaults to “Live face not detected, please try again”.

failure.retryBtnText
Text to display on the retry button of the FaceLivenessFailure screen. Defaults to “Retry”.

failure.exitBtnText
Text to display on the exit button of the FaceLivenessFailure screen. Defaults to “Exit”.

cameraStoreProvider.cameraTamperSeal.headingText

cameraStoreProvider.cameraTamperSeal.messageText

cameraStoreProvider.cameraTamperSeal.exitButtonText

finishingScreen.finishingTitleText
Title of the ring finishing screen. Defaults to “All captured — finishing up…“.

finishingScreen.finishingStage1Text
First stage row. Defaults to “Uploading your selfie”. Empty string hides the row.

finishingScreen.finishingStage2Text
Second stage row. Defaults to “Checking your selfie”. Empty string hides the row.

finishingScreen.finishingStage3Text
Third stage row. Defaults to an empty string, which hides the row.

successScreen.successTitleText
Title of the ring success screen. Defaults to “Selfie verified! 🎉“.

successScreen.successSubtitleText
First subtitle line. Defaults to an empty string, which hides the line.

successScreen.successContinuingText
Second subtitle line. Defaults to “Continuing to your account…”. Empty string hides the line.

successScreen.successTimeCaptionText
Caption of the elapsed-time stat chip. Defaults to “total time”. Empty string hides the chip.

successScreen.successCapturesValueText
Bold value of the captures stat chip. Defaults to a derived count, e.g. “2 captures”. Empty string hides the chip.

successScreen.successCapturesCaptionText
Caption of the captures stat chip. Defaults to a derived list, e.g. “front + selfie”.

successScreen.successIssuerValueText
Bold value of the issuing-authority stat chip. Defaults to an empty string, which hides the chip.

successScreen.successIssuerCaptionText
Caption of the issuing-authority stat chip. Defaults to “data confirmed”.