Video ID Validation
Render a fullscreen capture component that performs IDValidation and FaceValidation sequentially, then captures a video of the user holding their ID, and optionally speaking a prompt aloud.
Example
import React, { useState } from 'react'
import { VideoIdValidation } from 'idmission-web-sdk'
function getSessionId() {
return fetch('/api/get-session').then(resp => resp.json()).then(resp => resp.id)
}
function MyComponent() {
const [running, setRunning] = useState(false)
return (
<>
<button onClick={() => setRunning(true)}>Start Video ID Validation</button>
{running && (
<VideoIdValidation
sessionId={getSessionId}
onComplete={(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
lang Language code to use. Supported values: ‘auto’ (detect based on user’s OS), ‘en’ (English), ‘es’ (Spanish). Defaults to auto. |
sessionId A session identifier generated with your IDmission credentials. |
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 |
submissionUrl URL to hit with all API requests. Defaults to the value specified in your decoded submissionToken . |
authUrl URL to validate session against. Defaults to https://portal-api.idmission.com. |
documentServiceUrl URL to upload captured documents to via Tus. |
companyId Company identifier to include with submission. |
jobId The ID of the job to associate with the submission. |
taskId The ID of the task to associate with the submission. |
needImmediateResponse Boolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. |
manualReviewRequired Boolean flag to indicate whether responses should always be reviewed by a human. If set to ‘forced’, the server will push all forms to “Review Forced” for the manual review team to work, regardless of the automated decision results. Defaults to false. |
idBackImageRequired Boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Default is true . |
verifyIdWithExternalDatabases Boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc. |
bypassAgeValidation Boolean to indicate whether end-users under the age of 18 should be allowed through validation. Defaults to false. |
bypassNameMatching Boolean to indicate if matching the name in the request against the name extracted from the ID should be bypassed. Defaults to true. |
personalData Object of personal data to store with the submitted ID. Valid keys: uniqueNumber , name , phone , phoneCountryCode , email , dob , gender , addressLine1 , addressLine2 , city , district , postalCode , country . |
cardData Object of credit/debit card data to store with the submitted ID. Valid keys: cardToken , cardLast4 , cardExpDate , nameOnCard . |
idData Object of ID data to validate against the submitted ID. Valid keys: issueDate , expDate . |
webhooksEnabled Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. |
webhooksURL URL to use when invoking customer-configured webhooks. |
webhooksClientTraceId A customer provided trace id to use when invoking customer-configured webhooks. |
webhooksStripSpecialCharacters Boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. |
webhooksSendInputImages Boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. |
webhooksSendProcessedImages Boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. |
webhooksFireOnReview Boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. |
webhooksFireOnReviewURL URL to use when invoking customer-configured webhooks when ID is marked for manual review. |
sendBase64DocumentsInSwaggerProxy Boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. |
customerDataMatchConfig Object of configuration flags to send for data matching on the server against the data extracted from the ID. |
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. |
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. |
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 when the user has completed all flows. Arguments: the SubmissionResponse from IDmission’s API is passed as an argument to the customer’s application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission’s API, which contains the images submitted by the user. |
onRequestFailure Callback function that fires when an error occurs during the submission process. Arguments: the Error object is passed as an argument to the customer’s application for further handling. |
onExitCapture Callback function that fires when the user clicks the exit button during ID or selfie capture. |
onExitAfterFailure Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. |
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. |
onMicrophoneAccessDenied Callback function that fires when the microphone access is denied. |
onLoadingOverlayDismissed Callback function that fires when the continue button is clicked on the loading overlay. * |
idCaptureProps Object containing any overrides for IDValidation. |
faceLivenessProps Object containing any overrides for FaceLiveness. |
captureSignature Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to false . |
captureSignatureVideo Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false . |
captureAdditionalDocuments Array of additional documents to be captured. Each element includes a name and description. |
idCaptureModelsEnabled Boolean indicating whether ID guided capture experience should be utilized for automatic capture. Setting to false enables the manual capture button. Defaults to true. |
videoIdCaptureThresholds Object containing threshold overrides for ID capture. |
readTextPrompt An optional text prompt to display on screen for the user to read during video capture after the ID card has been shown. |
readTextTimeoutDurationMs The duration of time in milliseconds that the user is allowed to spend reading the readTextPrompt . Defaults to 15000 (15 seconds). |
readTextMinReadingMs The duration of time in milliseconds that the user is forced to spend reading the readTextPrompt before they can click the Done button. Defaults to 3000 (3 seconds). |
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 . |
skipIdCapture Boolean to indicate whether to skip the initial ID capture flow. Note that when this flag is set, submission to IDmission’s servers will not be attempted; it should be used in tandem with onSubmit . Defaults to false . |
skipShowIdCardBack Boolean or async function to indicate whether to instruct the user to show the back of their ID card during video capture. If an async function is supplied returning a boolean, it will be evaluated at the time of ID front video capture completion. Defaults to false . |
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. * |
idCaptureLoadingOverlayMode String indicating which ID capture loading overlay screen should be used. Supported values: ‘default’ and ‘legacy’. Defaults to ‘default’. |
idCaptureGuideType String to indicate what type of guides to use during capture. Using fit is highly recommended in order to capture the best quality image. Valid values: fit , overlay . Defaults to fit . |
idCaptureGuideImages Object containing any overrides for the guide overlay images during ID capture. Images must be supplied for in both portrait and landscape orientations for both sides of the ID card. Each image must include a url, width, and height — this is due to some interesting behavior in Safari where the image measurements cannot be trusted. |
idCapturePortraitGuidesOnMobile Boolean to indicate whether guide images should be rotated on mobile. Defaults to true . |
idCaptureRotateLoadingOverlayImageWhenPortrait Boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to true . |
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. |
idDocumentType String indicating which type of ID document to guide the user to hold up during the video. Supported values: ‘idCardOrPassport’, ‘idCard’, ‘passport’. Defaults to ‘idCardOrPassport’. |
faceLivenessLoadingOverlayMode String indicating which face liveness loading overlay screen should be used. Supported values: ‘default’ and ‘legacy’. Defaults to ‘default’. |
disableFaceDetectionWhileAudioCapture Boolean to disable face detection during audio capture after X seconds as defined by disableFaceDetectionWhileAudioCaptureMsDelay. Defaults to false. |
disableFaceDetectionWhileAudioCaptureMsDelay Number of milliseconds after which face detection will be disabled if disableFaceDetectionWhileAudioCapture is set to true. Defaults to 2000. |
silentFallback Flag for suppressing fallback messaging - used when models fail to load |
mergeAVStreams Boolean flag to indicate whether recorded audio should be merged onto the recorded video stream before submission. Defaults to false. |
matchOnly Boolean flag to indicate whether we should only attempt to match the ID and face, rather than running a validation job on the captured ID. Defaults to false. |
theme Name of an included theme or object containing theme properties. * |
assets Object containing any asset overrides. |
classNames Object containing any classNames for inner components. * |
colors Object containing any color overrides. |
verbiage Object containing any verbiage overrides. |
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 . |
Assets
idCapture.documentDetectionModelUrl URL to the document detection model. Defaults to defaultDocumentDetectorModelPath . |
idCapture.focusModelUrl URL to the focus model. Defaults to defaultFocusModelPath . |
idCapture.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. |
idCapture.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.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.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. |