ID and Face Validation
Render a fullscreen capture component that performs IdValidation and FaceValidation sequentially.
Use onJourneyEvent to track how far
a user progresses through this flow, including captures, retries, completed
stages, and explicit exits.
Example
React
import { IdAndFaceValidation } from 'idmission-web-sdk'
async function getSessionId() {
const resp = await fetch("/api/get-session");
return (await resp.json()).id;
}
export default function App() {
return (
<IdAndFaceValidation
sessionId={getSessionId}
onApproved={(submissionResponse) => {
alert('Your ID has been validated, proceed to the next checkpoint.')
}}
onDenied={(submissionResponse) => {
alert('Your ID could not be validated, you shall not pass!')
}}
/>
)
}Props
Class Names
Assets
idCapture.documentDetectionModelUrlURL to the document detection model. Defaults to defaultDocumentDetectorModelPath. |
idCapture.focusModelUrlURL to the focus model. Defaults to defaultFocusModelPath. |
idCapture.loadingOverlay.instructionImageUrlURL to the instruction image on the loading overlay. Defaults to https://websdk-cdn-dev.idmission.com/assets/WebSDK-Instruction-DL-Capture-3-Portrait.png . |
idCapture.loadingOverlay.cameraAccessDenied.imageUrlURL to the image to display when camera access is denied. Defaults to https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png . |
idCapture.loadingOverlay.microphoneAccessDenied.imageUrlURL to the image to display when microphone access is denied. Defaults to https://websdk-cdn-dev.idmission.com/assets/microphone-disable-icon.svg . |
idCapture.loadingOverlay.introStep1Emoji |
idCapture.loadingOverlay.introStep2Emoji |
faceLiveness.loadingOverlay.instructionImageUrlURL to the instruction image on the loading overlay. Defaults to https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png . |
faceLiveness.loadingOverlay.cameraAccessDenied.imageUrlURL 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.imageUrlURL 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 |
faceLiveness.loadingOverlay.transitionEmojiRing mode: emoji on the flipped badge of the ID→selfie handoff. Defaults to 🤳. |
faceLiveness.failure.imageUrlURL to the image to display on the FaceLivenessFailure screen. Defaults to https://websdk-cdn-dev.idmission.com/assets/Face_Not_Detected.svg . |
Colors
Verbiage
Last updated on