ID Validation

Render a fullscreen ID capture component that instructs the user to photograph both sides of their ID card, or the full page of their passport.

View Live Demos

Example

React


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

sendDecisionDetailsInPost
Include decision details in post data. Defaults to false.

useDocumentServiceForLivenessChecks

manualReviewRequired

idBackImageRequired
Server-side validation only. Capture of the ID back is controlled independently by idBackCaptureRequired; collapsing the two changes what gets captured.

verifyIdWithExternalDatabases

bypassAgeValidation

bypassNameMatching

customerDataMatchConfig

personalData

cardData

idData

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.

documentDetectorRuntime

focusRuntime

barcodeReadabilityRuntime

runtime

idCaptureRequirement

idBackCaptureRequired
Independent of idBackImageRequired — this one controls CAPTURE.

allowSinglePageIdCapture

allowIdCardBackToFrontCapture

requireFullPassportBooklet

idCaptureThresholds

separateIdCardCaptureSequence

documentEdgeDistancePct

enableOverrideWrongDocumentTypeDialog

allowOverrideWrongDocumentTypeAfterMs

enableFingerOcclusionGuidance

fingerOcclusionThresholds

enableGlareOcclusionGuidance

enableHologramOcclusionGuidance

captureSignature
Mutually exclusive with captureSignatureVideo; supplying both throws, as in 2.x.

captureSignatureVideo

onSignatureCaptureAtRisk

customOverlayContent

onLoadingOverlayDismissed

forceServerSideBarcodeDecode

captureOnly

loadingOverlayMode

autoContinueAfterLoading

showIntroScreen

skipSuccessScreen

instructions

guideType

guideBoxFollowsMask
Fit guides only. When true, the ID-capture guide box is drawn on the same rectangle the dimming mask is cut from, so the border always sits exactly on the dimmed edge at any viewport, and the mask is shown over a fullscreen camera feed. Defaults to false.

guideBoxBorderRadius
Fit guides only. Corner radius of the ID-capture guide box and of the hole cut in the dimming mask, in CSS pixels. Defaults to 33. Not reachable through classNames: the mask hole is drawn on a canvas and the box as an SVG, so neither responds to CSS border-radius.

guideBoxMaxWidth
Fit guides only. Caps the ID-capture guide box’s width in CSS pixels. Unset by default, in which case the box grows to fill the viewport less the guide-box padding — on a desktop monitor, most of the screen. Applied together with the height cap BEFORE the box is fitted to the ID’s aspect ratio, so capping one axis pulls the other in with it rather than distorting the card. Under snapToGuides the camera feed is clipped to the guide box, so capping the box caps the feed too.

guideBoxMaxHeight
Fit guides only. Caps the ID-capture guide box’s height in CSS pixels. Unset by default. Applied together with the width cap BEFORE the aspect-ratio fit, so whichever axis binds first decides the box and the other follows the ratio.

guidanceMessagePlacement
Where the ID-capture guidance message sits. 'viewport' (the default) pins it 12.5% up from the bottom of the screen; 'guideBox' places it guidanceMessageGap pixels below the guide box, so it tracks the box across viewport sizes and orientation changes instead of needing per-breakpoint CSS. Requires guideType: 'fit' together with guideBoxFollowsMask; without both, the guide box and the rect the message would anchor to are different rectangles, so it falls back to 'viewport'.

guidanceMessageGap
Gap in CSS pixels between the ID-capture guide box and the guidance message. Defaults to 8. Only applies when guidanceMessagePlacement is 'guideBox'.

cameraFeedMode
Controls whether the ID-capture camera feed is clipped to the guide box or fills the available space. fullscreen shows the live feed behind the guides with the area outside the guide box dimmed by theme.idCapture.guideOverlay.backgroundColor; snapToGuides sizes the feed to the guide box, leaving the surrounding area as flat page background. Defaults to snapToGuides.

guideImages

portraitGuidesOnMobile

rotateLoadingOverlayImageWhenPortrait

modelLoadTimeoutMs

forceFallbackMode

silentFallback

allowUploadingDocumentsFromStorage

enableBarcodeRecapture

barcodeParsingMode

aggressiveModeDecodeThreshold

aggressiveModeDecodeIntervalMs

precapturedDocuments

onBeforeSubmit

onSubmit

onComplete

onApproved

onDenied

onRequestFailure

onExitCapture

onModelError

onDocumentCaptured

onDocumentDetected

documentDetectionThrottleMs

captureAdditionalDocuments

classNames

assets

colors

verbiage

Class Names

container
Class name for the outermost container of the IdCaptureWizard.

cameraFeed
Class name for the camera feed component of the IdCaptureWizard.

uploadOrCaptureScreen.container
Class name for the outermost container of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.captureWithCameraPanel
Class name for the capture with camera panel of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.captureWithCameraIcon
Class name for the capture with camera icon of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.captureWithCameraButton
Class name for the capture with camera button of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.separator
Class name for the separator between capture with camera and upload of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.orText
Class name for the OR circle in the separator of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.uploadFromStoragePanel
Class name for the upload from storage panel of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.uploadFromStorageIcon
Class name for the upload from storage icon of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.uploadFromStorageButton
Class name for the upload from storage button of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.selectIdTypeModal
Class name for the select ID type modal of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.selectIdTypeDialog
Class name for the select ID type dialog of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.selectIdTypeHeading
Class name for the select ID type heading of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.selectPassportTypePanel
Class name for the passport panel of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.selectPassportTypeIcon
Class name for the passport icon of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.selectPassportTypeButton
Class name for the passport button of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.selectIdCardTypePanel
Class name for the ID card panel of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.selectIdCardTypeIcon
Class name for the ID card icon of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.selectIdCardTypeButton
Class name for the ID card button of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.selectIdTypeModalCloseButton
Class name for the close button of the select ID type modal of the IdCaptureOrUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.container
Class name for the outermost container of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.uploadIdFrontPanel
Class name for the upload ID front panel of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.uploadIdFrontIcon
Class name for the upload ID front icon of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.uploadIdFrontButton
Class name for the upload ID front button of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.separator
Class name for the separator between upload ID front and upload ID back of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.uploadIdBackPanel
Class name for the upload ID back panel of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.uploadIdBackIcon
Class name for the upload ID back icon of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.uploadIdBackButton
Class name for the upload ID back button of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.uploadIdBackHelpTextIfSinglePageAllowed
Class name for the upload ID back help text of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.actionsBar
Class name for the actions bar at the bottom of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.continueButton
Class name for the continue button of the IdDocumentUploadScreen.

uploadOrCaptureScreen.idDocumentUploadScreen.cancelButton
Class name for the cancel button of the IdDocumentUploadScreen.

uploadOrCaptureScreen.passportUploadScreen.container
Class name for the outermost container of the PassportUploadScreen.

uploadOrCaptureScreen.passportUploadScreen.uploadPassportPanel
Class name for the upload passport panel of the PassportUploadScreen.

uploadOrCaptureScreen.passportUploadScreen.uploadPassportIcon
Class name for the upload passport icon of the PassportUploadScreen.

uploadOrCaptureScreen.passportUploadScreen.uploadPassportButton
Class name for the upload passport button of the PassportUploadScreen.

uploadOrCaptureScreen.passportUploadScreen.actionsBar
Class name for the actions bar at the bottom of the PassportUploadScreen.

uploadOrCaptureScreen.passportUploadScreen.continueButton
Class name for the continue button of the PassportUploadScreen.

uploadOrCaptureScreen.passportUploadScreen.cancelButton
Class name for the cancel button of the PassportUploadScreen.

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

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

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

loadingOverlay.imageContainer
Class name for the container of the image in the IdCaptureLoadingOverlay.

loadingOverlay.image
Class name for the image in the IdCaptureLoadingOverlay.

loadingOverlay.continuityCameraCheckboxContainer
Class name for the container of the continuity camera checkbox in the IdCaptureLoadingOverlay.

loadingOverlay.continuityCameraCheckboxInner
Class name for the inner container of the continuity camera checkbox in the IdCaptureLoadingOverlay.

loadingOverlay.continuityCameraCheckboxLabel
Class name for the label of the continuity camera checkbox in the IdCaptureLoadingOverlay.

loadingOverlay.continuityCameraCheckbox
Class name for the continuity camera checkbox in the IdCaptureLoadingOverlay.

loadingOverlay.continueBtnContainer
Class name for the container of the continue button in the IdCaptureLoadingOverlay.

loadingOverlay.continueBtn
Class name for the continue button in the IdCaptureLoadingOverlay.

loadingOverlay.cancelBtn
Class name for the cancel button in the IdCaptureLoadingOverlay.

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.buttonsRow
Class name for the buttons row in the IdCaptureLoadingOverlay.

loadingOverlay.progressContainer
Class name for the progress container in the IdCaptureLoadingOverlay.

loadingOverlay.progressBackground
Class name for the progress background in the IdCaptureLoadingOverlay.

loadingOverlay.progressBar
Class name for the progress bar in the IdCaptureLoadingOverlay.

loadingOverlay.progressIndicator
Class name for the progress indicator in the IdCaptureLoadingOverlay.

loadingOverlay.loadingListContainer
Class name for the loading list container in the IdCaptureLoadingOverlay.

loadingOverlay.loadingList
Class name for the loading list in the IdCaptureLoadingOverlay.

loadingOverlay.loadingListItem
Class name for the loading list items in the IdCaptureLoadingOverlay.

loadingOverlay.loadingListItemIndicator
Class name for the icons on the loading list items in the IdCaptureLoadingOverlay.

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.preloadChip
Class name for the background-preload chip in ring mode.

loadingOverlay.introPage

loadingOverlay.introBadge

loadingOverlay.introTitle

loadingOverlay.introSubtitle

loadingOverlay.introSteps

loadingOverlay.introStep

loadingOverlay.introStepDot

loadingOverlay.introReassuranceChip

loadingOverlay.introStartBtn

loadingOverlay.introPrivacy

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

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

capture.guides.inner
Class name for the inner container of the IdCaptureGuideOverlay.

capture.guides.dimmingRegion
Class name for the dimming region of the IdCaptureGuideOverlay.

capture.guides.dimmingRegionTop
Class name for the top dimming region of the IdCaptureGuideOverlay.

capture.guides.dimmingRegionLeft
Class name for the left dimming region of the IdCaptureGuideOverlay.

capture.guides.dimmingRegionRight
Class name for the right dimming region of the IdCaptureGuideOverlay.

capture.guides.dimmingRegionBottom
Class name for the bottom dimming region of the IdCaptureGuideOverlay.

capture.guides.centerRow
Class name for the center row of the IdCaptureGuideOverlay.

capture.guides.centerRegion
Class name for the center region of the IdCaptureGuideOverlay.

capture.guides.centerRegionBorder
Class name for the center region border of the IdCaptureGuideOverlay.

capture.guides.centerRegionInner
Class name for the center region inner of the IdCaptureGuideOverlay.

capture.guides.image
Class name for the image of the IdCaptureGuideOverlay.

capture.guides.guideText
Class name for the guide text of the IdCaptureGuideOverlay.

capture.guides.flipIdPrompt.frontImageContainer
Class name for the container of the front image of the FlipIdPrompt.

capture.guides.flipIdPrompt.backImageContainer
Class name for the container of the back image of the FlipIdPrompt.

capture.guides.flipIdPrompt.frontImage
Class name for the front image of the FlipIdPrompt.

capture.guides.flipIdPrompt.backImage
Class name for the back image of the FlipIdPrompt.

capture.guides.canvasWrapper
Class name for the canvas wrapper of the IdCaptureFitGuide.

capture.guides.canvas
Class name for the canvas of the IdCaptureFitGuide.

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

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

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

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

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

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

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

capture.overrideWrongDocumentTypeGuidanceDialog.container
Class name for the outermost container of the OverrideWrongDocumentTypeGuidanceDialog screen.

capture.overrideWrongDocumentTypeGuidanceDialog.inner
Class name for the inner container of the OverrideWrongDocumentTypeGuidanceDialog screen.

capture.overrideWrongDocumentTypeGuidanceDialog.message
Class name for the message of the OverrideWrongDocumentTypeGuidanceDialog screen.

capture.overrideWrongDocumentTypeGuidanceDialog.buttonContainer
Class name for the button container of the OverrideWrongDocumentTypeGuidanceDialog screen.

capture.overrideWrongDocumentTypeGuidanceDialog.button
Class name for the button of the OverrideWrongDocumentTypeGuidanceDialog screen.

guides.container
Class name for the outermost container of the IdCaptureGuideOverlay.

guides.inner
Class name for the inner container of the IdCaptureGuideOverlay.

guides.dimmingRegion
Class name for the dimming region of the IdCaptureGuideOverlay.

guides.dimmingRegionTop
Class name for the top dimming region of the IdCaptureGuideOverlay.

guides.dimmingRegionLeft
Class name for the left dimming region of the IdCaptureGuideOverlay.

guides.dimmingRegionRight
Class name for the right dimming region of the IdCaptureGuideOverlay.

guides.dimmingRegionBottom
Class name for the bottom dimming region of the IdCaptureGuideOverlay.

guides.centerRow
Class name for the center row of the IdCaptureGuideOverlay.

guides.centerRegion
Class name for the center region of the IdCaptureGuideOverlay.

guides.centerRegionBorder
Class name for the center region border of the IdCaptureGuideOverlay.

guides.centerRegionInner
Class name for the center region inner of the IdCaptureGuideOverlay.

guides.image
Class name for the image of the IdCaptureGuideOverlay.

guides.guideText
Class name for the guide text of the IdCaptureGuideOverlay.

guides.flipIdPrompt.frontImageContainer
Class name for the container of the front image of the FlipIdPrompt.

guides.flipIdPrompt.backImageContainer
Class name for the container of the back image of the FlipIdPrompt.

guides.flipIdPrompt.frontImage
Class name for the front image of the FlipIdPrompt.

guides.flipIdPrompt.backImage
Class name for the back image of the FlipIdPrompt.

guides.canvasWrapper
Class name for the canvas wrapper of the IdCaptureFitGuide.

guides.canvas
Class name for the canvas of the IdCaptureFitGuide.

success.container
Class name for the outermost container of the IdCaptureSuccess.

success.inner
Class name for the inner container of the IdCaptureSuccess.

success.card
Class name for the card of the IdCaptureSuccess.

success.heading
Class name for the heading of the IdCaptureSuccess.

success.imageContainer
Class name for the container of the image in the IdCaptureSuccess.

success.imageRow
Class name for the row of the image in the IdCaptureSuccess.

success.imageCol
Class name for the column of the image in the IdCaptureSuccess.

success.imageHeading
Class name for the heading of the image in the IdCaptureSuccess.

success.imageWrapper
Class name for the wrapper of the image in the IdCaptureSuccess.

success.image
Class name for the image in the IdCaptureSuccess.

success.instruction
Class name for the instruction of the IdCaptureSuccess.

success.buttonsRow
Class name for the buttons row in the IdCaptureSuccess.

success.retryBtn
Class name for the retry button in the IdCaptureSuccess.

success.doneBtn
Class name for the done button in the IdCaptureSuccess.

success.submitBtn
Class name for the submit button in the IdCaptureSuccess.

fallback.container
Class name for the outermost container of the IdCaptureFallback.

fallback.inner
Class name for the inner container of the IdCaptureFallback.

fallback.heading
Class name for the heading of the IdCaptureFallback.

fallback.description
Class name for the description of the IdCaptureFallback.

fallback.imageContainer
Class name for the container of the image in the IdCaptureFallback.

fallback.imageCol
Class name for the column of the image in the IdCaptureFallback.

fallback.image
Class name for the image in the IdCaptureFallback.

fallback.instruction
Class name for the instruction of the IdCaptureFallback.

fallback.buttonsRow
Class name for the buttons row in the IdCaptureFallback.

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

fallback.captureMoreBtn
Class name for the capture more button in the IdCaptureFallback.

fallback.doneBtn
Class name for the done button in the IdCaptureFallback.

fallback.documentCaptureClassNames.container

fallback.documentCaptureClassNames.cameraFeedWrapper

fallback.documentCaptureClassNames.cameraFeed

fallback.documentCaptureClassNames.previewImage

fallback.documentCaptureClassNames.captureContainer

fallback.documentCaptureClassNames.headingRow

fallback.documentCaptureClassNames.heading

fallback.documentCaptureClassNames.footerRow

fallback.documentCaptureClassNames.instructions

fallback.documentCaptureClassNames.buttonsRow

fallback.documentCaptureClassNames.retryCameraAccessBtn

fallback.documentCaptureClassNames.retryCaptureBtn

fallback.documentCaptureClassNames.uploadBtn

fallback.documentCaptureClassNames.uploadProgressBtn

fallback.documentCaptureClassNames.captureBtn

fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.container

fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.inner

fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.heading

fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.message

fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.exitButton

cameraStoreProvider.cameraTamperSeal.container

cameraStoreProvider.cameraTamperSeal.inner

cameraStoreProvider.cameraTamperSeal.heading

cameraStoreProvider.cameraTamperSeal.message

cameraStoreProvider.cameraTamperSeal.exitButton

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.signatureCanvasContainerDisabled
Class name for the signature canvas container of the SignatureVideoCaptureGuides screen when disabled.

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.loadingOverlay.ring
Class name for the ring SVG in ring mode.

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

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

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

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

videoSignatureCapture.faceLiveness.loadingOverlay.introPage

videoSignatureCapture.faceLiveness.loadingOverlay.introBadge

videoSignatureCapture.faceLiveness.loadingOverlay.introTitle

videoSignatureCapture.faceLiveness.loadingOverlay.introSubtitle

videoSignatureCapture.faceLiveness.loadingOverlay.introSteps

videoSignatureCapture.faceLiveness.loadingOverlay.introStep

videoSignatureCapture.faceLiveness.loadingOverlay.introStepDot

videoSignatureCapture.faceLiveness.loadingOverlay.introReassuranceChip

videoSignatureCapture.faceLiveness.loadingOverlay.introStartBtn

videoSignatureCapture.faceLiveness.loadingOverlay.introPrivacy

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

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

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

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

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.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.exitButton

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

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

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.faceLiveness.cameraStoreProvider.cameraTamperSeal.exitButton

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.assetSelectorOptions
Class name for the options of the asset selector of the VideoSignatureSuccess screen.

videoSignatureCapture.success.assetSelectorOption
Class name for the option of the asset selector of the VideoSignatureSuccess screen.

videoSignatureCapture.success.assetSelectorOptionRadio
Class name for the radio button of the asset selector of the VideoSignatureSuccess screen.

videoSignatureCapture.success.assetSelectorOptionLabel
Class name for the label of the asset selector 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

videoSignatureCapture.cameraStoreProvider.cameraTamperSeal.exitButton

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.

Assets

documentDetectionModelUrl
URL to the document detection model. Defaults to defaultDocumentDetectorModelPath.

focusModelUrl
URL to the focus model. Defaults to defaultFocusModelPath.

loadingOverlay.instructionImageUrl
URL to the instruction image on the loading overlay. Defaults to https://websdk-cdn-dev.idmission.com/assets/WebSDK-Instruction-DL-Capture-3-Portrait.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

Colors

guideBoxUnsatisfiedColor
Color of the guide box when it is not satisfied. Defaults to white.

guideBoxSatisfiedColor
Color of the guide box when it is 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.

fallback.captureBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.

fallback.captureBtn.borderColor
Border color of the button. Defaults to none.

fallback.captureBtn.textColor
Text color of the button. Defaults to white.

fallback.captureBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.

fallback.captureBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.

fallback.captureBtn.loadingTextColor
Text color of the button while loading. Defaults to white.

fallback.captureMoreBtn.backgroundColor
Background color of the button. Defaults to #0d6efd.

fallback.captureMoreBtn.borderColor
Border color of the button. Defaults to none.

fallback.captureMoreBtn.textColor
Text color of the button. Defaults to white.

fallback.captureMoreBtn.loadingBackgroundColor
Background color of the button while loading. Defaults to none.

fallback.captureMoreBtn.loadingBorderColor
Border color of the button while loading. Defaults to secondary-500.

fallback.captureMoreBtn.loadingTextColor
Text color of the button while loading. Defaults to white.

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

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

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

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

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

fallback.doneBtn.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

uploadOrCaptureScreen.captureWithCameraText
Text to display on the capture with camera button. Defaults to “Capture with Camera”.

uploadOrCaptureScreen.orText
Text to display on the separator between capture with camera and upload. Defaults to “OR”.

uploadOrCaptureScreen.uploadFromStorageText
Text to display on the upload from storage button. Defaults to “Upload from Storage”.

uploadOrCaptureScreen.selectIdTypeText
Text to display on the select ID type heading. Defaults to “Select ID Type”.

uploadOrCaptureScreen.passportText
Text to display on the passport button. Defaults to “Passport”.

uploadOrCaptureScreen.idCardText
Text to display on the ID card button. Defaults to “ID Card”.

uploadOrCaptureScreen.idDocumentUploadScreen.uploadIdFrontText
Text to display on the upload ID front button. Defaults to “Upload ID Front”.

uploadOrCaptureScreen.idDocumentUploadScreen.uploadIdBackText
Text to display on the upload ID back button. Defaults to “Upload ID Back”.

uploadOrCaptureScreen.idDocumentUploadScreen.uploadIdBackHelpTextIfSinglePageAllowed
Text to display on the upload ID back help text. Defaults to “Upload the back of the ID if it is not included in the front image”.

uploadOrCaptureScreen.idDocumentUploadScreen.loadingText
Text to display on the upload buttons while loading. Defaults to “Loading…“.

uploadOrCaptureScreen.idDocumentUploadScreen.continueText
Text to display on the continue button. Defaults to “Continue”.

uploadOrCaptureScreen.idDocumentUploadScreen.cancelText
Text to display on the cancel button. Defaults to “Cancel”.

uploadOrCaptureScreen.passportUploadScreen.uploadPassportText
Text to display on the upload passport button. Defaults to “Upload Passport”.

uploadOrCaptureScreen.passportUploadScreen.loadingText
Text to display on the upload button while loading. Defaults to “Loading…“.

uploadOrCaptureScreen.passportUploadScreen.continueText
Text to display on the continue button. Defaults to “Continue”.

uploadOrCaptureScreen.passportUploadScreen.cancelText
Text to display on the cancel button. Defaults to “Cancel”.

loadingOverlay.headingText
Text to display on the loading overlay. Defaults to “Use your device camera to capture your ID”.

loadingOverlay.useContinuityCameraText
Text to display on the loading overlay when iOS Continuity Camera is available. Defaults to “Use your iPhone as a webcam”.

loadingOverlay.downloadingText
Text to display on the loading overlay while the models are downloading. Defaults to “Downloading…“.

loadingOverlay.modelsWarmingUpText
Text to display on the loading overlay while the models are warming up. Defaults to “Models warming up…“.

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

loadingOverlay.cameraInitializingText
Text to display on the loading overlay while the camera is initializing. Defaults to “Camera initializing…“.

loadingOverlay.continueText
Text to display on the loading overlay continue button. Defaults to “Continue”.

loadingOverlay.pleaseWaitText
Text to display on the loading overlay when the continue button is disabled. Defaults to “Please wait…“.

loadingOverlay.cameraInitializedText
Text to display on the loading overlay when the camera is initialized. 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 loading overlay while 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.ringPreloadChipText
Ring mode: chip shown while face-capture models preload in the background (composite flows). Defaults to “Face capture preloading in background”.

loadingOverlay.introTitleText

loadingOverlay.introSubtitleText
Subtitle below the ring intro title. Defaults to “Just one quick step — about 10 seconds.”.

loadingOverlay.introStep1Text

loadingOverlay.introStep2Text
Second step label on the ring intro screen. Defaults to an empty string, which hides the step.

loadingOverlay.introReassuranceChipText

loadingOverlay.introEnableCameraText

loadingOverlay.introRequestingCameraText

loadingOverlay.introPrivacyText

idCardFront.instructionText
Text to display while the ID card is being captured. Defaults to “Scan the front of ID”.

idCardFront.processingIdCardText
Text to display while the ID card is being processed. Defaults to “ID card front captured.”.

idCardFront.capturingText
Text to display while the document is being captured. Defaults to “Capturing…“.

idCardFront.captureFailedText
Text to display when the document capture fails. Defaults to “Capture failed!“.

idCardFront.guidanceSatisfiedText
Text to display when guidance is satisfied. Defaults to “ID Capture Successful”.

idCardFront.guidancePleaseFlipText
Text to display when guidance is not satisfied because the user is showing the back of the ID card when the front is desired. Defaults to “ID card front detected - please flip your ID card”.

idCardFront.guidanceBackDetectedFirstText
Text to display when guidance is not satisfied because the user is showing the front of the ID card when the back is desired. Defaults to “ID card back detected - please flip your ID card”.

idCardFront.guidanceTooBlurryText
Text to display when guidance is not satisfied because the ID card is too blurry. Defaults to “Document out of focus - try improving the lighting”.

idCardFront.guidanceNotCenteredText
Text to display when guidance is not satisfied because the document is not centered on screen. Defaults to “Document is not centered”.

idCardFront.guidanceTooCloseText
Text to display when guidance is not satisfied because the document is too close to the camera. Defaults to “Document too close, please back up”.

idCardFront.guidanceBookletTooFarText
Shown when requireFullPassportBooklet is on and the booklet is too far / not fully open. Defaults to “Move closer, fill the frame with your fully opened passport booklet.”.

idCardFront.guidanceBookletCornersCutOffText
Shown when requireFullPassportBooklet is on and the booklet runs off-screen. Defaults to “Move back, make sure all 4 corners of your fully opened passport booklet are visible.”.

idCardFront.guidanceNotStableText
Text to display when guidance is not satisfied because the document is not stable. Defaults to “Document is not stable”.

idCardFront.guidanceFingersOccludingText
Text shown when a finger is detected occluding the document. Defaults to “Please move your fingers off the document”. Only fires when enableFingerOcclusionGuidance is on (LiteRT runtime).

idCardFront.guidanceGlareOnDocumentText
Text shown when glare is detected on the document. Defaults to “Please reduce glare on the document”. Only fires when enableGlareOcclusionGuidance is on (LiteRT runtime).

idCardFront.guidanceHologramOnDocumentText
Text shown when a hologram reflection is detected on the document. Defaults to “Please reduce reflections on the document”. Only fires when enableHologramOcclusionGuidance is on (LiteRT runtime).

idCardFront.guidanceNotDetectedText
Text to display when guidance is not satisfied because no document is detected. Defaults to “Document not detected”.

idCardFront.guidanceIdCardNotAllowedText
Text to display when guidance is not satisfied because an ID card is detected but idCaptureRequirement indicates ID cards should not be accepted. Defaults to “ID card detected, please scan a passport instead”.

idCardFront.guidancePassportNotAllowedText
Text to display when guidance is not satisfied because a passport is detected but idCaptureRequirement indicates passports should not be accepted. Defaults to “Passport detected, please scan an ID card instead”.

idCardFront.overrideWrongDocumentTypeGuidanceDialog.messageText
Text to display when on bottom of screen when the wrong document type has been shown for too long. Defaults to “We are having trouble identifying the correct side of your id, do you want to continue with capture anyway?“.

idCardFront.overrideWrongDocumentTypeGuidanceDialog.buttonText
Text to display on the button when on bottom of screen when the wrong document type has been shown for too long. Defaults to “OK”.

idCardBack.instructionText
Text to display while the ID card is being captured. Defaults to “Scan the front of ID”.

idCardBack.processingIdCardText
Text to display while the ID card is being processed. Defaults to “ID card front captured.”.

idCardBack.capturingText
Text to display while the document is being captured. Defaults to “Capturing…“.

idCardBack.captureFailedText
Text to display when the document capture fails. Defaults to “Capture failed!“.

idCardBack.guidanceSatisfiedText
Text to display when guidance is satisfied. Defaults to “ID Capture Successful”.

idCardBack.guidancePleaseFlipText
Text to display when guidance is not satisfied because the user is showing the back of the ID card when the front is desired. Defaults to “ID card front detected - please flip your ID card”.

idCardBack.guidanceBackDetectedFirstText
Text to display when guidance is not satisfied because the user is showing the front of the ID card when the back is desired. Defaults to “ID card back detected - please flip your ID card”.

idCardBack.guidanceTooBlurryText
Text to display when guidance is not satisfied because the ID card is too blurry. Defaults to “Document out of focus - try improving the lighting”.

idCardBack.guidanceNotCenteredText
Text to display when guidance is not satisfied because the document is not centered on screen. Defaults to “Document is not centered”.

idCardBack.guidanceTooCloseText
Text to display when guidance is not satisfied because the document is too close to the camera. Defaults to “Document too close, please back up”.

idCardBack.guidanceBookletTooFarText
Shown when requireFullPassportBooklet is on and the booklet is too far / not fully open. Defaults to “Move closer, fill the frame with your fully opened passport booklet.”.

idCardBack.guidanceBookletCornersCutOffText
Shown when requireFullPassportBooklet is on and the booklet runs off-screen. Defaults to “Move back, make sure all 4 corners of your fully opened passport booklet are visible.”.

idCardBack.guidanceNotStableText
Text to display when guidance is not satisfied because the document is not stable. Defaults to “Document is not stable”.

idCardBack.guidanceFingersOccludingText
Text shown when a finger is detected occluding the document. Defaults to “Please move your fingers off the document”. Only fires when enableFingerOcclusionGuidance is on (LiteRT runtime).

idCardBack.guidanceGlareOnDocumentText
Text shown when glare is detected on the document. Defaults to “Please reduce glare on the document”. Only fires when enableGlareOcclusionGuidance is on (LiteRT runtime).

idCardBack.guidanceHologramOnDocumentText
Text shown when a hologram reflection is detected on the document. Defaults to “Please reduce reflections on the document”. Only fires when enableHologramOcclusionGuidance is on (LiteRT runtime).

idCardBack.guidanceNotDetectedText
Text to display when guidance is not satisfied because no document is detected. Defaults to “Document not detected”.

idCardBack.guidanceIdCardNotAllowedText
Text to display when guidance is not satisfied because an ID card is detected but idCaptureRequirement indicates ID cards should not be accepted. Defaults to “ID card detected, please scan a passport instead”.

idCardBack.guidancePassportNotAllowedText
Text to display when guidance is not satisfied because a passport is detected but idCaptureRequirement indicates passports should not be accepted. Defaults to “Passport detected, please scan an ID card instead”.

idCardBack.overrideWrongDocumentTypeGuidanceDialog.messageText
Text to display when on bottom of screen when the wrong document type has been shown for too long. Defaults to “We are having trouble identifying the correct side of your id, do you want to continue with capture anyway?“.

idCardBack.overrideWrongDocumentTypeGuidanceDialog.buttonText
Text to display on the button when on bottom of screen when the wrong document type has been shown for too long. Defaults to “OK”.

passport.instructionText
Text to display while the ID card is being captured. Defaults to “Scan the front of ID”.

passport.processingIdCardText
Text to display while the ID card is being processed. Defaults to “ID card front captured.”.

passport.capturingText
Text to display while the document is being captured. Defaults to “Capturing…“.

passport.captureFailedText
Text to display when the document capture fails. Defaults to “Capture failed!“.

passport.guidanceSatisfiedText
Text to display when guidance is satisfied. Defaults to “ID Capture Successful”.

passport.guidancePleaseFlipText
Text to display when guidance is not satisfied because the user is showing the back of the ID card when the front is desired. Defaults to “ID card front detected - please flip your ID card”.

passport.guidanceBackDetectedFirstText
Text to display when guidance is not satisfied because the user is showing the front of the ID card when the back is desired. Defaults to “ID card back detected - please flip your ID card”.

passport.guidanceTooBlurryText
Text to display when guidance is not satisfied because the ID card is too blurry. Defaults to “Document out of focus - try improving the lighting”.

passport.guidanceNotCenteredText
Text to display when guidance is not satisfied because the document is not centered on screen. Defaults to “Document is not centered”.

passport.guidanceTooCloseText
Text to display when guidance is not satisfied because the document is too close to the camera. Defaults to “Document too close, please back up”.

passport.guidanceBookletTooFarText
Shown when requireFullPassportBooklet is on and the booklet is too far / not fully open. Defaults to “Move closer, fill the frame with your fully opened passport booklet.”.

passport.guidanceBookletCornersCutOffText
Shown when requireFullPassportBooklet is on and the booklet runs off-screen. Defaults to “Move back, make sure all 4 corners of your fully opened passport booklet are visible.”.

passport.guidanceNotStableText
Text to display when guidance is not satisfied because the document is not stable. Defaults to “Document is not stable”.

passport.guidanceFingersOccludingText
Text shown when a finger is detected occluding the document. Defaults to “Please move your fingers off the document”. Only fires when enableFingerOcclusionGuidance is on (LiteRT runtime).

passport.guidanceGlareOnDocumentText
Text shown when glare is detected on the document. Defaults to “Please reduce glare on the document”. Only fires when enableGlareOcclusionGuidance is on (LiteRT runtime).

passport.guidanceHologramOnDocumentText
Text shown when a hologram reflection is detected on the document. Defaults to “Please reduce reflections on the document”. Only fires when enableHologramOcclusionGuidance is on (LiteRT runtime).

passport.guidanceNotDetectedText
Text to display when guidance is not satisfied because no document is detected. Defaults to “Document not detected”.

passport.guidanceIdCardNotAllowedText
Text to display when guidance is not satisfied because an ID card is detected but idCaptureRequirement indicates ID cards should not be accepted. Defaults to “ID card detected, please scan a passport instead”.

passport.guidancePassportNotAllowedText
Text to display when guidance is not satisfied because a passport is detected but idCaptureRequirement indicates passports should not be accepted. Defaults to “Passport detected, please scan an ID card instead”.

passport.overrideWrongDocumentTypeGuidanceDialog.messageText
Text to display when on bottom of screen when the wrong document type has been shown for too long. Defaults to “We are having trouble identifying the correct side of your id, do you want to continue with capture anyway?“.

passport.overrideWrongDocumentTypeGuidanceDialog.buttonText
Text to display on the button when on bottom of screen when the wrong document type has been shown for too long. Defaults to “OK”.

flipIdPrompt.instructionText
Text to display on the flip ID prompt. Defaults to “Please flip your ID card…“.

success.headingText
Text to display on the heading of the IdCaptureSuccess screen. Defaults to “ID Capture Successful”.

success.submitText
Text to display on the submit button of the IdCaptureSuccess screen. Defaults to “Submit”.

success.submittingText
Text to display on the submit button of the IdCaptureSuccess screen when submission is in progress. Defaults to “Submitting…“.

success.retryText
Text to display on the retry button of the IdCaptureSuccess screen if submission fails. Defaults to “Retry”.

fallback.headingText
Text to display on the heading of the IdCaptureFallback screen. Defaults to “We’re having some trouble.”.

fallback.descriptionText
Text to display on the description of the IdCaptureFallback screen. Defaults to “On-device capture guidance failed, please capture a photo of the ID card manually.”.

fallback.firstInstructionText
Text to display on the first instruction of the IdCaptureFallback screen. Defaults to “Please capture the front of your ID card.”.

fallback.secondInstructionText
Text to display on the second instruction of the IdCaptureFallback screen. Defaults to “Please capture the back of your ID card.”.

fallback.thirdInstructionText
Text to display on the third instruction of the IdCaptureFallback screen. Defaults to “Please capture the ID page of your passport.”.

fallback.captureBtnText
Text to display on the capture button of the IdCaptureFallback screen. Defaults to “Capture”.

fallback.captureMoreBtnText
Text to display on the capture more button of the IdCaptureFallback screen. Defaults to “Capture ID page of passport”.

fallback.doneBtnText
Text to display on the done button of the IdCaptureFallback screen. Defaults to “Done”.

fallback.documentCaptureVerbiage.headingText

fallback.documentCaptureVerbiage.loadingBtnText

fallback.documentCaptureVerbiage.retryCameraAccessBtnText

fallback.documentCaptureVerbiage.captureBtnText

fallback.documentCaptureVerbiage.capturingBtnText

fallback.documentCaptureVerbiage.retryCaptureBtnText

fallback.documentCaptureVerbiage.uploadBtnText

fallback.documentCaptureVerbiage.uploadingBtnText

fallback.documentCaptureVerbiage.retryUploadBtnText

fallback.documentCaptureVerbiage.successBtnText

fallback.documentCaptureVerbiage.cameraStoreProvider.cameraTamperSeal.headingText

fallback.documentCaptureVerbiage.cameraStoreProvider.cameraTamperSeal.messageText

fallback.documentCaptureVerbiage.cameraStoreProvider.cameraTamperSeal.exitButtonText

cameraStoreProvider.cameraTamperSeal.headingText

cameraStoreProvider.cameraTamperSeal.messageText

cameraStoreProvider.cameraTamperSeal.exitButtonText

guidanceBarcodeRecaptureText

guidanceBarcodeRecaptureInProgressText

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.guides.signHereText
Text to display on the sign here text 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.guidanceVisibilityTooLowText
Text shown when the user needs better lighting. Defaults to “Improve lighting conditions…“.

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

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

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.guidanceValidatingText
Text to display on the guidance message when the selfie has been captured and is being validated. Defaults to “Photo captured, verifying…“.

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.challengeTurnLeftText
Text to display when the challenge asks the user to turn their head left. Defaults to “Turn your head left”.

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

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

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

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

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

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.loadingOverlay.ringCameraWarmingText
Ring mode: status line while the camera initializes. Defaults to “Getting your camera ready…“.

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

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

videoSignatureCapture.faceLiveness.loadingOverlay.introTitleText

videoSignatureCapture.faceLiveness.loadingOverlay.introSubtitleText

videoSignatureCapture.faceLiveness.loadingOverlay.introStep1Text

videoSignatureCapture.faceLiveness.loadingOverlay.introStep2Text

videoSignatureCapture.faceLiveness.loadingOverlay.introReassuranceChipText

videoSignatureCapture.faceLiveness.loadingOverlay.introEnableCameraText

videoSignatureCapture.faceLiveness.loadingOverlay.introRequestingCameraText

videoSignatureCapture.faceLiveness.loadingOverlay.introPrivacyText

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

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

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

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.faceLiveness.cameraStoreProvider.cameraTamperSeal.exitButtonText

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

videoSignatureCapture.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 ID”. Empty string hides the row.

finishingScreen.finishingStage2Text
Second stage row. Defaults to “Confirming your identity data”. 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 “ID 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 third stat chip. Defaults to “Identity data”. Empty string hides the chip.

successScreen.successIssuerCaptionText
Caption of the third stat chip. Defaults to “confirmed”.