Signature KYC

Render a fullscreen capture component that records a short selfie/liveness video and a hand-drawn signature, uploading both for signature KYC.

View Live Demos

Example

React


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

Props

sessionId
A session identifier generated with your IDmission credentials.

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

submissionUrl
URL used for submission requests.

authUrl
URL to validate the session against.

documentServiceUrl
URL to upload captured documents to via Tus.

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

clientRequestID
The ClientRequestID field is typically populated with the Form ID and is used to link records together - in this case an id validation record to the original form

jobId
The ID of the job to associate with the submission.

taskId
The ID of the task to associate with the submission.

sendBase64DocumentsInSwaggerProxy
Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false.

onBeforeDocumentUpload
Callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded.

onDocumentUploadProgress
Callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters.

onDocumentUploaded
Callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters.

onDocumentUploadFailed
Callback function that fires when a document failed to upload. The error and metadata are passed in as parameters.

onAuthError
Callback function that fires when the session creation or validation fails.

onLoadingStarted
Callback function that fires when the loading overlay is shown.

onLoadingProgress
Callback function that fires when the loading overlay progress changes.

onLoadingCompleted
Callback function that fires when the loading overlay is dismissed.

onLoadingFailed
Callback function that fires when the loading sequence fails.

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

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

onUserCancel
Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.

onCameraAccessDenied
Callback function that fires when the camera access is denied.

onCameraTamperingDetected
Callback function that fires when the camera tampering is detected.

onExitAfterTamperSealPopped
Callback function that fires when the user clicks the exit button on the tamper detection screen. Only renders the button when bound.

lang
Language code to use. Supported values: ‘auto’ (detect based on user’s OS), ‘en’ (English), ‘es’ (Spanish). Defaults to auto.

theme
Name of an included theme or object containing theme properties. *

geolocationEnabled
Boolean flag to indicate whether users should be prompted to share their location. Default is true.

geolocationRequired
Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is false.

debugMode
Boolean flag to enable on-screen prediction information output. Default is false.

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

captureProgress
Optional capture-progress task, created with createCaptureProgress({ sessionId, authUrl }).task(context). Reports capture progress to Portal where Portal enables it; capture never depends on it.

faceDetector
Which face-detection model to use. Defaults to 'face-landmarker' (478-point face mesh; also enables challenge-response). Set to 'docdetect' to use plain BlazeFace bounding-box detection.

faceLandmarkerRuntime
Which inference runtime backs the face landmarker. Defaults to 'litert' (runs a raw .tflite via @litertjs/core). Set to 'mediapipe' to use the .task bundle. Only applies when faceDetector is 'face-landmarker'.

showFaceLandmarks
Boolean flag to show face landmark dots during face tracking. Defaults to false.

handOverFaceCheck
Opt-in: before a selfie is auto-captured, checks that frame for a hand over the face, and if one covers it, holds the capture and asks the user to remove their hand. Fetches two extra models (~4 MB) after the face models load.

requireEyesOpen
Hold the selfie auto-capture while either of the user’s eyes is closed, and ask them to keep their eyes open. Each eye is judged against its own open-eye shape, calibrated while the user looks at the camera. A wink is caught too, except in the fallback used when the iris model fails to load, which only registers both eyes closed. That iris model is downloaded only when this is on, so leaving it off costs nothing. Needs the face-landmarker detector (the default); ignored under docdetect. Defaults to false.

challengeResponse

customOverlayContent
React component to render if the warmup overlay needs to be completely replaced. Note that 100px padding should be applied to the bottom as the loading progress will be displayed over this content. *

onLoadingOverlayDismissed
Callback function that fires when the continue button is clicked on the loading overlay. *

selfieCaptureRecovery
Opt-in timed manual capture and bounded contrast relaxation for the selfie stage.

onSelfieCaptureQualityException
Fires when the committed selfie failed its original capture-quality gates.

allowHigherCameraResolutions
Allows the shared front camera used for selfie guidance and signing above the default 1280×720 (720p) cap. Defaults to false. True restores normal camera resolution selection; it does not guarantee a higher resolution. Higher resolutions can reduce signing responsiveness on slower devices. Read once when the flow mounts; remount to change it.

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

useDocumentServiceForLivenessChecks
Boolean flag to indicate whether the liveness check photos should be uploaded to the document service, rather than sent as base64. Defaults to false.

onSelfieCaptured
Callback function that fires immediately after the selfie capture is completed, giving the client application an opportunity to specify custom logic that captures the selfie document token. The document token is passed in as a parameter.

onSignatureCaptureAtRisk
Callback function that fires when the user submits the signature pad and the SDK has detected signals suggesting the captured video may have quality issues (very low byte rate, large frame gaps, low signing-window FPS, low chunk rate, or a combination of low-end device indicators). Use this to display a “we may have detected an issue” prompt. The full set of metrics and which thresholds were tripped are passed in as a parameter. This is a retrospective signal — the capture has already happened.

onSignatureCaptureAnalyzed
Fires with the analysis of every completed video signature recording, including those that raised no at-risk warning. Still signatures are not analysed, so it does not fire for them.

onSignatureCaptureInterrupted
Fires when the recording stops before the user finishes signing, for example when a phone call takes the microphone, and the SDK ends the attempt. Notification only: the SDK shows its own recovery screen.

simulateAtRiskWarning

simulateRecordingInterrupted
Debug switch: stops the recorder partway into every recording, so you can reach the interrupted-recording screen without a real interruption. Not for production.

recordingInterruptedComponent
Replaces the contents of the interrupted-recording screen with your own component, for designs the verbiage and classNames overrides can’t reach. Bind your button to the onStartOver prop it receives: that clears the signature and takes the user back for a fresh selfie.

onBeforeSubmit
Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned.

onSubmit
Callback function that fires when the user has completed the flow instead of making a call to IDmission’s servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission’s API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, onComplete will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk!

onComplete
Callback function that fires after the user completes the SignatureKYC flow and all captures have uploaded. Arguments: the completed SubmissionResponse and the request payload containing the user’s captured data. This capture-only flow does not return a verification verdict.

onRequestFailure
Callback function that fires when an error occurs during the submission process. Arguments: the Error object is passed as an argument to the customer’s application for further handling.

onModelError
Callback function that fires when the selfie capture models fail to load or fail during runtime.

allowVirtualCameras

faceLivenessProps
Props for the inner selfie step, as in 2.x. This component’s own props take precedence; keys only 2.x’s internal wizard understood have no effect.

loadingOverlayMode
String indicating which loading overlay screen should be used. Supported values: ‘default’, ‘legacy’, and ‘ring’. Defaults to ‘default’.

autoContinueAfterLoading
When true, the loading overlay hides its “Let’s Go!” continue button and the flow enters the camera automatically ~400ms after all dependencies (session check, models, camera) are ready. In composite flows this applies to every loading overlay in the flow. Defaults to false.

showIntroScreen

skipSuccessScreen
Boolean or async function to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false, or true while the ring intro screen is active — the intro’s single-tap promise also skips capture review screens.

captureAudio
Boolean to indicate whether the audio should be captured during the signature capture flow. Defaults to false.

idCardForFaceMatch
String containing a base64 image or document service ID pointing to an ID card front image that should be used to match the user’s face against. Leave blank to disable face matching.

modelLoadTimeoutMs
Number of milliseconds indicating the maximum amount of time that should be spent trying to load the guided capture experience before giving up and resorting to the stock camera instead. Defaults to 45000 (45 seconds).

runtime
Unified inference runtime override. Set to ‘litert’ to route all models to LiteRT; overridden by per-model runtime props.

minSignaturePadPoints

signatureValidity

onSignatureValidityConcern

headTrackingDisabled
Boolean to indicate whether the head tracking should be disabled. Defaults to false.

headTrackingBoundaryPercentage
Number of percentage points indicating the maximum amount of space that the user’s head can be near the outside of the frame before the head tracking is considered unsatisfied. Defaults to 0.01 (1%).

headTrackingBoundaryType
String indicating whether the head tracking boundary should be based on the head or the nose. Supported values: ‘head’ (default) and ‘nose’.

allowSignatureAfterLivenessCheckFailure
Boolean to indicate whether the user should be allowed to proceed to the signature capture flow after all liveness checks have failed. Defaults to false.

restartVideoOnSignaturePadCleared
Boolean to indicate whether the clearing the signature pad should also clear the captured video data. Defaults to true.

skipLivenessValidation
Boolean to indicate whether the liveness validation should be skipped. When true, a selfie is captured and uploaded to the documents service, but no liveness check is performed. Defaults to false.

allowManualSelfieCaptureOnLoadingError
Boolean to indicate whether the user should be allowed to manually capture a selfie if the loading sequence fails. Defaults to false.

guidesComponent
React component to render if the capture guides component needs to be completely replaced. Note that the component should be rendered with a container that is absolute positioned and covers the entire screen. *

showFaceGuideThenSignaturePad
Boolean to indicate that the guides should be shown in sequence. Defaults to false.

minCaptureBrightnessThreshold

minCaptureRangeThreshold

minCaptureVarianceThreshold

debugShowSamplePoints
Boolean flag to show brightness sample point locations on the debug overlay. Requires debugMode to be true. Default is false.

assets
Object containing any asset overrides.

classNames
Class names for the component’s inner elements, keyed as in 2.x (SignatureKYCClassNames). Keys marked deprecated have no effect in 3.0.

colors
Object containing any color overrides.

verbiage
Object containing any verbiage overrides.

Class Names

container
Class name for the outermost container of the VideoSignatureCapture screen.

cameraFeed
Class name for the camera feed component of the VideoSignatureCapture screen.

guidanceMessageContainer No effect in 3.0
Class name for the guidance message container of the VideoSignatureCapture screen.
3.0 renders no element for this.

guidanceMessage
Class name for the guidance message of the VideoSignatureCapture screen.

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

guides.container
Class name for the outermost container of the SignatureVideoCaptureGuides screen.

guides.inner
Class name for the inner container of the SignatureVideoCaptureGuides screen.

guides.faceGuideContainer
Class name for the container of the face guide of the SignatureVideoCaptureGuides screen.

guides.faceGuide
Class name for the face guide of the SignatureVideoCaptureGuides screen.

guides.signaturePadContainer
Class name for the container of the signature pad of the SignatureVideoCaptureGuides screen.

guides.signatureCanvasContainer
Class name for the signature canvas container of the SignatureVideoCaptureGuides screen.

guides.signatureCanvasContainerDisabled
Class name for the signature canvas container of the SignatureVideoCaptureGuides screen when disabled.

guides.signatureCanvasInner
Class name for the signature canvas inner container of the SignatureVideoCaptureGuides screen.

guides.signatureCanvas
Class name for the signature canvas of the SignatureVideoCaptureGuides screen.

guides.signatureButtonsRow
Class name for the container of the signature buttons of the SignatureVideoCaptureGuides screen.

guides.clearSignatureBtn
Class name for the clear signature button of the SignatureVideoCaptureGuides screen.

guides.acceptSignatureBtn
Class name for the accept signature button of the SignatureVideoCaptureGuides screen.

guides.emptyContentContainer
Class name for the container of the empty content of the SignatureVideoCaptureGuides screen.

guides.emptyContentInner
Class name for the inner container of the empty content of the SignatureVideoCaptureGuides screen.

guides.headTrackingUnsatisfiedContentContainer
Class name for the container of the head tracking unsatisfied content of the SignatureVideoCaptureGuides screen.

guides.headTrackingUnsatisfiedContentInner
Class name for the inner container of the head tracking unsatisfied content of the SignatureVideoCaptureGuides screen.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

faceLiveness.loadingOverlay.introPage

faceLiveness.loadingOverlay.introBadge

faceLiveness.loadingOverlay.introTitle

faceLiveness.loadingOverlay.introSubtitle

faceLiveness.loadingOverlay.introSteps

faceLiveness.loadingOverlay.introStep

faceLiveness.loadingOverlay.introStepDot

faceLiveness.loadingOverlay.introReassuranceChip

faceLiveness.loadingOverlay.introStartBtn

faceLiveness.loadingOverlay.introPrivacy

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

faceLiveness.capture.fallback.documentCaptureClassNames.container

faceLiveness.capture.fallback.documentCaptureClassNames.cameraFeedWrapper

faceLiveness.capture.fallback.documentCaptureClassNames.cameraFeed

faceLiveness.capture.fallback.documentCaptureClassNames.previewImage

faceLiveness.capture.fallback.documentCaptureClassNames.captureContainer

faceLiveness.capture.fallback.documentCaptureClassNames.headingRow

faceLiveness.capture.fallback.documentCaptureClassNames.heading

faceLiveness.capture.fallback.documentCaptureClassNames.footerRow

faceLiveness.capture.fallback.documentCaptureClassNames.instructions

faceLiveness.capture.fallback.documentCaptureClassNames.buttonsRow

faceLiveness.capture.fallback.documentCaptureClassNames.retryCameraAccessBtn

faceLiveness.capture.fallback.documentCaptureClassNames.retryCaptureBtn

faceLiveness.capture.fallback.documentCaptureClassNames.uploadBtn

faceLiveness.capture.fallback.documentCaptureClassNames.uploadProgressBtn

faceLiveness.capture.fallback.documentCaptureClassNames.captureBtn

faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.container

faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.inner

faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.heading

faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.message

faceLiveness.capture.fallback.documentCaptureClassNames.cameraStoreProvider.cameraTamperSeal.exitButton

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

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

faceLiveness.capture.imagePreview.container No effect in 3.0
Class name for the outermost container of the SelfieProgressPreview.
3.0 no longer renders this element.

faceLiveness.capture.imagePreview.text No effect in 3.0
Class name for the text of the SelfieProgressPreview.
3.0 no longer renders this element.

faceLiveness.capture.imagePreview.spinner No effect in 3.0
Class name for the spinner of the SelfieProgressPreview.
3.0 no longer renders this element.

faceLiveness.capture.imagePreview.imageContainer No effect in 3.0
Class name for the image container of the SelfieProgressPreview.
3.0 no longer renders this element.

faceLiveness.capture.imagePreview.image No effect in 3.0
Class name for the image of the SelfieProgressPreview.
3.0 no longer renders this element.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

faceLiveness.cameraStoreProvider.cameraTamperSeal.container

faceLiveness.cameraStoreProvider.cameraTamperSeal.inner

faceLiveness.cameraStoreProvider.cameraTamperSeal.heading

faceLiveness.cameraStoreProvider.cameraTamperSeal.message

faceLiveness.cameraStoreProvider.cameraTamperSeal.exitButton

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

success.inner No effect in 3.0
Class name for the inner container of the VideoSignatureSuccess screen.
3.0 renders no element for this.

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

success.assetSelectorOptions No effect in 3.0
Class name for the options of the asset selector of the VideoSignatureSuccess screen.
3.0 no longer renders this element.

success.assetSelectorOption No effect in 3.0
Class name for the option of the asset selector of the VideoSignatureSuccess screen.
3.0 no longer renders this element.

success.assetSelectorOptionRadio No effect in 3.0
Class name for the radio button of the asset selector of the VideoSignatureSuccess screen.
3.0 no longer renders this element.

success.assetSelectorOptionLabel No effect in 3.0
Class name for the label of the asset selector of the VideoSignatureSuccess screen.
3.0 no longer renders this element.

success.videoContainer No effect in 3.0
Class name for the video container of the VideoSignatureSuccess screen.
3.0 renders no element for this.

success.video
Class name for the video of the VideoSignatureSuccess screen.

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

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

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

cameraStoreProvider.cameraTamperSeal.container

cameraStoreProvider.cameraTamperSeal.inner

cameraStoreProvider.cameraTamperSeal.heading

cameraStoreProvider.cameraTamperSeal.message

cameraStoreProvider.cameraTamperSeal.exitButton

finishingScreen.finishingScreen No effect in 3.0
Class name for the finishing screen’s content container.
Not supported on this component yet.

finishingScreen.finishingThumb No effect in 3.0
Class name for the selfie thumbnail (or its fallback badge).
Not supported on this component yet.

finishingScreen.finishingTitle No effect in 3.0
Class name for the title.
Not supported on this component yet.

finishingScreen.finishingStageList No effect in 3.0
Class name for the stage list.
Not supported on this component yet.

finishingScreen.finishingStage No effect in 3.0
Class name for each stage row.
Not supported on this component yet.

successScreen.successScreen No effect in 3.0
Class name for the success screen’s content container.
Not supported on this component yet.

successScreen.successCheck No effect in 3.0
Class name for the big check badge.
Not supported on this component yet.

successScreen.successTitle No effect in 3.0
Class name for the title.
Not supported on this component yet.

successScreen.successSubtitle No effect in 3.0
Class name for the subtitle block.
Not supported on this component yet.

successScreen.successStatList No effect in 3.0
Class name for the stat chip row.
Not supported on this component yet.

successScreen.successStat No effect in 3.0
Class name for each stat chip.
Not supported on this component yet.

Assets

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

faceLiveness.loadingOverlay.cameraAccessDenied.imageUrl
URL to the image to display when camera access is denied. Defaults to https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png .

faceLiveness.loadingOverlay.microphoneAccessDenied.imageUrl
URL to the image to display when microphone access is denied. Defaults to https://websdk-cdn-dev.idmission.com/assets/microphone-disable-icon.svg .

faceLiveness.loadingOverlay.introStep1Emoji

faceLiveness.loadingOverlay.introStep2Emoji
Emoji for the second step on the ring intro screen. SignatureKYC defaults to ✍️.

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

faceLiveness.failure.imageUrl
URL to the image to display on the FaceLivenessFailure screen. Defaults to https://websdk-cdn-dev.idmission.com/assets/Face_Not_Detected.svg .

Colors

guidanceMessageBackgroundColor
Background color of the guidance message. Defaults to #ccc.

guidanceMessageTextColor
Text color of the guidance message. Defaults to black.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

Verbiage

guidanceMessageText
Text to display on the guidance message of the VideoSignatureCapture screen. Defaults to “Please sign the box below”.

guides.signaturePadEmptyText
Text to display on the signature pad empty content of the SignatureVideoCaptureGuides screen.

guides.headTrackingUnsatisfiedText
Text to display on the head tracking unsatisfied content of the SignatureVideoCaptureGuides screen.

guides.clearSignatureBtnText
Text to display on the clear signature button of the SignatureVideoCaptureGuides screen.

guides.acceptSignatureBtnText
Text to display on the accept signature button of the SignatureVideoCaptureGuides screen.

guides.signHereText
Text to display on the sign here text of the SignatureVideoCaptureGuides screen.

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

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

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

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

faceLiveness.guidanceMoveToCenterText
Text to display on the guidance message when the user’s face is not centered in the frame. Defaults to “Move to the center…“.

faceLiveness.guidanceNoFaceDetectedText
Text to display on the guidance message when the user’s face is not detected in the frame. Defaults to “Waiting for face to be detected…“.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

faceLiveness.loadingOverlay.cameraAccessDenied.descriptionText
Text elaborating on the meaning of camera access being denied. Defaults to “This application requires access to your camera to continue. Please accept the permission once prompted by the browser. If the browser does not prompt for camera permissions, you must go to settings and provide camera access to the current browser.”.

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

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

faceLiveness.loadingOverlay.microphoneAccessDenied.descriptionText
Text to display on the description of the MicrophoneAccessDeniedOverlay. Defaults to “This application requires access to your microphone to continue. Please accept the permission once prompted by the browser. If the browser does not prompt for microphone permissions, you must go to settings and provide microphone access to the current browser.”.

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

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

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

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

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

faceLiveness.loadingOverlay.introTitleText

faceLiveness.loadingOverlay.introSubtitleText
Subtitle below the ring intro title. Defaults to “Just two quick steps — about 10 seconds.”.

faceLiveness.loadingOverlay.introStep1Text

faceLiveness.loadingOverlay.introStep2Text
Second step label on the ring intro screen. Defaults to “Sign your name”.

faceLiveness.loadingOverlay.introReassuranceChipText

faceLiveness.loadingOverlay.introEnableCameraText

faceLiveness.loadingOverlay.introRequestingCameraText

faceLiveness.loadingOverlay.introPrivacyText

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

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

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

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

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

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

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

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

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

faceLiveness.cameraStoreProvider.cameraTamperSeal.headingText

faceLiveness.cameraStoreProvider.cameraTamperSeal.messageText

faceLiveness.cameraStoreProvider.cameraTamperSeal.exitButtonText

success.headingText
Text to display on the heading of the VideoSignatureSuccess screen. Defaults to “Video signature has been successfully captured!“.

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

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

cameraStoreProvider.cameraTamperSeal.headingText

cameraStoreProvider.cameraTamperSeal.messageText

cameraStoreProvider.cameraTamperSeal.exitButtonText

finishingScreen.finishingTitleText No effect in 3.0
Title of the ring finishing screen. Defaults to “All captured — finishing up…”.
Not supported on this component yet.

finishingScreen.finishingStage1Text No effect in 3.0
First stage row. Defaults to “Uploading your captures”. Empty string hides the row.
Not supported on this component yet.

finishingScreen.finishingStage2Text No effect in 3.0
Second stage row. Defaults to “Saving your signature”. Empty string hides the row.
Not supported on this component yet.

finishingScreen.finishingStage3Text No effect in 3.0
Third stage row. Defaults to “Completing your submission”. Empty string hides the row.
Not supported on this component yet.

successScreen.successTitleText No effect in 3.0
Title of the ring success screen. Defaults to “Signature captured! 🎉”.
Not supported on this component yet.

successScreen.successSubtitleText No effect in 3.0
First subtitle line. Defaults to an empty string, which hides the line.
Not supported on this component yet.

successScreen.successContinuingText No effect in 3.0
Second subtitle line. Defaults to “Continuing to your account…”. Empty string hides the line.
Not supported on this component yet.

successScreen.successTimeCaptionText No effect in 3.0
Caption of the elapsed-time stat chip. Defaults to “total time”. Empty string hides the chip.
Not supported on this component yet.

successScreen.successCapturesValueText No effect in 3.0
Bold value of the captures stat chip. Defaults to a derived count, e.g. “2 captures”. Empty string hides the chip.
Not supported on this component yet.

successScreen.successCapturesCaptionText No effect in 3.0
Caption of the captures stat chip. Defaults to a derived list, e.g. “front + selfie”.
Not supported on this component yet.

successScreen.successIssuerValueText No effect in 3.0
Bold value of the issuing-authority stat chip. Defaults to an empty string, which hides the chip.
Not supported on this component yet.

successScreen.successIssuerCaptionText No effect in 3.0
Caption of the issuing-authority stat chip. Defaults to “data confirmed”.
Not supported on this component yet.