Skip to Content
Customer FlowsFace Validation

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.

Example

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
The ClientRequestID field is typically populated with the Form ID and is used to link records together - in this case an id validation record to the original form
jobId
The ID of the job to associate with the submission.
taskId
The ID of the task to associate with the submission.
sendBase64DocumentsInSwaggerProxy
Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false.
companyId
Company identifier to include with submission.
needImmediateResponse
Boolean flag sent with the submission request as its needImmediateResponse field (Y/N). Defaults to false.
sendDecisionDetailsInPost
Include decision details in post data. 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.
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.
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.
onAuthError
Callback function that fires when the session creation or validation fails.
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.
onLoadingFailed
Callback function that fires when the loading sequence fails.
enableTamperDetection
When true, integrity checks run and may block the camera.
mediaIntegrityToken
An opaque token created by captureMediaIntegrity() at boot time.
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.
onCameraAccessDenied
Callback function that fires when the camera cannot be used. reason is 'permissionDenied' when the user or browser refused camera permission, or 'unavailable' when the camera could not be started (in use by another app, blocked by the operating system, or no usable camera found). In VideoIdValidation it fires during ID capture only, not during the video recording.
onCameraTamperingDetected
Callback function that fires when the camera tampering is detected.
onExitAfterTamperSealPopped
Callback function that fires when the user clicks the exit button on the tamper detection screen. Only renders the button when bound.
lang
Language code to use. Supported values: ‘auto’ (detect based on user’s OS), ‘en’ (English), ‘es’ (Spanish). Defaults to auto.
theme
Name of an included theme or object containing theme properties. *
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.
remoteDiagnostics
Opt-in remote diagnostics: crash/breadcrumb capture and reporting.
captureProgress
Optional capture-progress task, created with createCaptureProgress({ sessionId, authUrl }).task(context). Reports capture progress to Portal where Portal enables it; capture never depends on it.
faceDetector
Which face-detection model to use. Defaults to 'face-landmarker' (478-point face mesh; also enables challenge-response). Set to 'docdetect' to use plain BlazeFace bounding-box detection.
faceLandmarkerRuntime
Which inference runtime backs the face landmarker. Defaults to 'litert' (runs a raw .tflite via @litertjs/core). Set to 'mediapipe' to use the .task bundle. Only applies when faceDetector is 'face-landmarker'.
showFaceLandmarks
Boolean flag to show face landmark dots during face tracking. Defaults to false.
handOverFaceCheck
Opt-in: before a selfie is auto-captured, checks that frame for a hand over the face, and if one covers it, holds the capture and asks the user to remove their hand. Fetches two extra models (~4 MB) after the face models load.
requireEyesOpen
Hold the selfie auto-capture while either of the user’s eyes is closed, and ask them to keep their eyes open. Each eye is judged against its own open-eye shape, calibrated while the user looks at the camera. A wink is caught too, except in the fallback used when the iris model fails to load, which only registers both eyes closed. That iris model is downloaded only when this is on, so leaving it off costs nothing. Needs the face-landmarker detector (the default); ignored under docdetect. Defaults to false.
challengeResponse
estimateAge
Accepted for 2.x compatibility but has no effect.
predictGender
Accepted for 2.x compatibility but has no effect.
loadingOverlayMode
String indicating which loading overlay screen should be used. Supported values: ‘default’, ‘legacy’, and ‘ring’. Defaults to ‘default’.
autoContinueAfterLoading
When true, the loading overlay hides its “Let’s Go!” continue button and the flow enters the camera automatically ~400ms after all dependencies (session check, models, camera) are ready. In composite flows this applies to every loading overlay in the flow. Defaults to false.
showIntroScreen
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
Accepted for 2.x compatibility but has no effect.
runtime
Unified inference runtime override. Set to ‘litert’ to route all models to LiteRT; overridden by per-model runtime props.
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, or true while the ring intro screen is active — the intro’s single-tap promise also skips capture review screens.
idCardForFaceMatch
String containing a base64 image or document service ID pointing to an ID card front image that should be used to match the user’s face against. Leave blank to disable face matching.
allowVirtualCameras
onBeforeSubmit
Fires immediately before the liveness check is sent. Receives the liveness request and must resolve to the request to send, changed or not.
onComplete
Callback function that fires when the user has completed the FaceValidation flow, regardless of whether they are approved or denied. Arguments: the SubmissionResponse from IDmission’s API is passed as an argument to the customer’s application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission’s API, which contains the images submitted by the user.
onApproved
Callback function that fires when the user completes the FaceValidation flow and passes the realness check. Arguments: same as onComplete.
onDenied
Callback function that fires when the user completes the FaceValidation flow and fails the realness check. Arguments: same as onComplete.
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 FaceValidation flow and failing the realness check.
onModelError
Accepted for 2.x compatibility but has no effect.
assets
Object containing any asset overrides.
classNames
Class names for the component’s inner elements, keyed as in 2.x (FaceValidationClassNames). Keys marked deprecated have no effect in 3.0.
colors
Object containing any color overrides.
verbiage
Object containing any verbiage overrides.

Class Names

container
finishingScreen.finishingScreen No effect in 3.0
Class name for the finishing screen’s content container.
Not supported on this component yet.
finishingScreen.finishingThumb No effect in 3.0
Class name for the selfie thumbnail (or its fallback badge).
Not supported on this component yet.
finishingScreen.finishingTitle No effect in 3.0
Class name for the title.
Not supported on this component yet.
finishingScreen.finishingStageList No effect in 3.0
Class name for the stage list.
Not supported on this component yet.
finishingScreen.finishingStage No effect in 3.0
Class name for each stage row.
Not supported on this component yet.
successScreen.successScreen No effect in 3.0
Class name for the success screen’s content container.
Not supported on this component yet.
successScreen.successCheck No effect in 3.0
Class name for the big check badge.
Not supported on this component yet.
successScreen.successTitle No effect in 3.0
Class name for the title.
Not supported on this component yet.
successScreen.successSubtitle No effect in 3.0
Class name for the subtitle block.
Not supported on this component yet.
successScreen.successStatList No effect in 3.0
Class name for the stat chip row.
Not supported on this component yet.
successScreen.successStat No effect in 3.0
Class name for each stat chip.
Not supported on this component yet.
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 No effect in 3.0
Class name for the outermost container of the MicrophoneAccessDeniedOverlay.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.inner No effect in 3.0
Class name for the inner container of the MicrophoneAccessDeniedOverlay.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.imageContainer No effect in 3.0
Class name for the image container of the MicrophoneAccessDeniedOverlay.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.image No effect in 3.0
Class name for the image of the MicrophoneAccessDeniedOverlay.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.heading No effect in 3.0
Class name for the heading of the MicrophoneAccessDeniedOverlay.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.description No effect in 3.0
Class name for the description of the MicrophoneAccessDeniedOverlay.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.retryBtn No effect in 3.0
Class name for the retry button of the MicrophoneAccessDeniedOverlay.
3.0 renders no element for this.
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 No effect in 3.0
Class name for the outermost container of the SelfieCaptureFallback.
3.0 renders no element for this.
capture.fallback.inner No effect in 3.0
Class name for the inner container of the SelfieCaptureFallback.
3.0 renders no element for this.
capture.fallback.heading No effect in 3.0
Class name for the heading of the SelfieCaptureFallback.
3.0 renders no element for this.
capture.fallback.description No effect in 3.0
Class name for the description of the SelfieCaptureFallback.
3.0 renders no element for this.
capture.fallback.imageContainer No effect in 3.0
Class name for the container of the image in the SelfieCaptureFallback.
3.0 renders no element for this.
capture.fallback.image No effect in 3.0
Class name for the image in the SelfieCaptureFallback.
3.0 renders no element for this.
capture.fallback.buttonsRow No effect in 3.0
Class name for the buttons row in the SelfieCaptureFallback.
3.0 renders no element for this.
capture.fallback.captureBtn No effect in 3.0
Class name for the capture button in the SelfieCaptureFallback.
3.0 renders no element for this.
capture.fallback.doneBtn No effect in 3.0
Class name for the done button in the SelfieCaptureFallback.
3.0 renders no element for this.
capture.fallback.retryCaptureBtn No effect in 3.0
Class name for the retry capture button in the SelfieCaptureFallback.
3.0 renders no element for this.
capture.fallback.documentCaptureClassNames.container No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.cameraFeedWrapper No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.cameraFeed No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.previewImage No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.captureContainer No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.headingRow No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.heading No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.footerRow No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.instructions No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.buttonsRow No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.retryCameraAccessBtn No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.retryCaptureBtn No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.uploadBtn No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.uploadProgressBtn No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.captureBtn No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.container No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.inner No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.heading No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.message No effect in 3.0
3.0 no longer renders this element.
capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.exitButton No effect in 3.0
3.0 no longer renders this element.
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 No effect in 3.0
Class name for the outermost container of the SelfieProgressPreview.
3.0 no longer renders this element.
capture.imagePreview.text No effect in 3.0
Class name for the text of the SelfieProgressPreview.
3.0 no longer renders this element.
capture.imagePreview.spinner No effect in 3.0
Class name for the spinner of the SelfieProgressPreview.
3.0 no longer renders this element.
capture.imagePreview.imageContainer No effect in 3.0
Class name for the image container of the SelfieProgressPreview.
3.0 no longer renders this element.
capture.imagePreview.image No effect in 3.0
Class name for the image of the SelfieProgressPreview.
3.0 no longer renders this element.
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 No effect in 3.0
URL to the image to display when microphone access is denied. Defaults to https://websdk-cdn-dev.idmission.com/assets/microphone-disable-icon.svg .
Not supported on this component yet.
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 No effect in 3.0
Background color of the button. Defaults to #0d6efd.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.retryBtn.borderColor No effect in 3.0
Border color of the button. Defaults to none.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.retryBtn.textColor No effect in 3.0
Text color of the button. Defaults to white.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.retryBtn.loadingBackgroundColor No effect in 3.0
Background color of the button while loading. Defaults to none.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.retryBtn.loadingBorderColor No effect in 3.0
Border color of the button while loading. Defaults to secondary-500.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.retryBtn.loadingTextColor No effect in 3.0
Text color of the button while loading. Defaults to white.
3.0 renders no element for this.
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 No effect in 3.0
Text to display on the progress preview of the FaceLivenessCapture screen. Defaults to “Processing…“.
3.0 no longer renders this element.
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 No effect in 3.0
Text to display on the heading of the MicrophoneAccessDeniedOverlay. Defaults to “Your microphone permission is disabled”.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.descriptionText No effect in 3.0
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.”.
3.0 renders no element for this.
loadingOverlay.microphoneAccessDenied.retryBtnText No effect in 3.0
Text to display on the retry button of the MicrophoneAccessDeniedOverlay. Defaults to “Retry”.
3.0 renders no element for this.
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 No effect in 3.0
Title of the ring finishing screen. Defaults to “All captured — finishing up…”.
Not supported on this component yet.
finishingScreen.finishingStage1Text No effect in 3.0
First stage row. Defaults to “Uploading your selfie”. Empty string hides the row.
Not supported on this component yet.
finishingScreen.finishingStage2Text No effect in 3.0
Second stage row. Defaults to “Checking your selfie”. Empty string hides the row.
Not supported on this component yet.
finishingScreen.finishingStage3Text No effect in 3.0
Third stage row. Defaults to an empty string, which hides the row.
Not supported on this component yet.
successScreen.successTitleText No effect in 3.0
Title of the ring success screen. Defaults to “Selfie verified! 🎉”.
Not supported on this component yet.
successScreen.successSubtitleText No effect in 3.0
First subtitle line. Defaults to an empty string, which hides the line.
Not supported on this component yet.
successScreen.successContinuingText No effect in 3.0
Second subtitle line. Defaults to “Continuing to your account…”. Empty string hides the line.
Not supported on this component yet.
successScreen.successTimeCaptionText No effect in 3.0
Caption of the elapsed-time stat chip. Defaults to “total time”. Empty string hides the chip.
Not supported on this component yet.
successScreen.successCapturesValueText No effect in 3.0
Bold value of the captures stat chip. Defaults to a derived count, e.g. “2 captures”. Empty string hides the chip.
Not supported on this component yet.
successScreen.successCapturesCaptionText No effect in 3.0
Caption of the captures stat chip. Defaults to a derived list, e.g. “front + selfie”.
Not supported on this component yet.
successScreen.successIssuerValueText No effect in 3.0
Bold value of the issuing-authority stat chip. Defaults to an empty string, which hides the chip.
Not supported on this component yet.
successScreen.successIssuerCaptionText No effect in 3.0
Caption of the issuing-authority stat chip. Defaults to “data confirmed”.
Not supported on this component yet.
Last updated on