Customer Biometrics Enrollment
Render a fullscreen capture component that performs FaceValidation, and then stores the results in IDmission’s customer database using the supplied enrollmentId for later verification or 1:N matching.
Example
import React, { useState } from 'react'
import { CustomerBiometricsEnrollment } 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 Customer Biometrics Enrollment</button>
 
      {running && (
        <CustomerBiometricsEnrollment
          sessionId={getSessionId}
          enrollmentId="some-guy"
        />
      )}
    </>
  )
}Props
| enrollmentIdThe unique identifier to match from previously enrolled customers. | 
| langLanguage code to use. Supported values: ‘auto’ (detect based on user’s OS), ‘en’ (English), ‘es’ (Spanish). Defaults to auto. | 
| sessionIdA session identifier generated with your IDmission credentials. | 
| submissionUrlURL to hit with all API requests. Defaults to the value specified in your decoded submissionToken. | 
| authUrlURL to validate session against. Defaults to https://portal-api.idmission.com. | 
| documentServiceUrlURL to upload captured documents to via Tus. | 
| companyIdCompany identifier to include with submission. | 
| jobIdThe ID of the job to associate with the submission. | 
| taskIdThe ID of the task to associate with the submission. | 
| needImmediateResponseBoolean flag to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. | 
| deduplicationEnabledBoolean flag indicating whether submissions from the same user should be de-duplicated. | 
| deduplicationSynchronousBoolean flag indicating whether to wait for de-duplication to complete before allowing the user to proceed. | 
| webhooksEnabledBoolean flag to indicate whether customer-configured webhooks should be invoked after submission. | 
| webhooksURLURL to use when invoking customer-configured webhooks. | 
| webhooksClientTraceIdA customer provided trace id to use when invoking customer-configured webhooks. | 
| webhooksStripSpecialCharactersBoolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. | 
| webhooksSendInputImagesBoolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. | 
| webhooksSendProcessedImagesBoolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. | 
| webhooksFireOnReviewBoolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. | 
| webhooksFireOnReviewURLURL to use when invoking customer-configured webhooks when ID is marked for manual review. | 
| sendBase64DocumentsInSwaggerProxyBoolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. | 
| useDocumentServiceForLivenessChecksBoolean flag to indicate whether the liveness check photos should be uploaded to the document service, rather than sent as base64. Defaults to false. | 
| loadingOverlayModeString indicating which loading overlay screen should be used. Supported values: ‘default’ and ‘legacy’. Defaults to ‘default’. | 
| initialCaptureDelayMsThe duration of time in milliseconds to wait after the loading overlay is dismissed before starting the capture experience. This helps with the problem of the first few frames being of the user looking down at the bottom of the screen but the frame otherwise being good. Defaults to 1000(1 second). | 
| timeoutDurationMsThe duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000(15 seconds). | 
| modelLoadTimeoutMsNumber 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). | 
| skipSuccessScreenBoolean 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. | 
| onLoadingStartedCallback function that fires when the loading overlay is shown. | 
| onLoadingProgressCallback function that fires when the loading overlay progress changes. | 
| onLoadingCompletedCallback function that fires when the loading overlay is dismissed. | 
| onLoadingFailedCallback function that fires when the loading sequence fails. | 
| onAuthErrorCallback function that fires when the session creation or validation fails. | 
| onBeforeDocumentUploadCallback 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. | 
| onDocumentUploadProgressCallback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. | 
| onDocumentUploadedCallback 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. | 
| onDocumentUploadFailedCallback function that fires when a document failed to upload. The error and metadata are passed in as parameters. | 
| onBeforeSubmitCallback 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. | 
| onSubmitCallback 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, onCompletewill never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! | 
| onCompleteCallback function that fires when the user has completed the CustomerBiometricsEnrollment flow. 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. | 
| onEnrolledCallback function that fires when the user has completed the CustomerBiometricsEnrollment flow successfully. 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. | 
| onDeniedCallback function that fires when the user has completed the CustomerBiometricsEnrollment flow but could not be enrolled. 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. | 
| onRequestFailureCallback 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. | 
| onExitCaptureCallback function that fires when the user clicks the exit button during ID or selfie capture. | 
| onExitAfterFailureCallback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. | 
| onUserCancelCallback 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. | 
| onModelErrorCallback function that fires when the selfie capture models fail to load or fail during runtime. | 
| onCameraAccessDeniedCallback function that fires when the camera access is denied. | 
| onCameraTamperingDetectedCallback function that fires when the camera tampering is detected. | 
| captureSignatureBoolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to false. | 
| captureSignatureVideoBoolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false. | 
| captureAdditionalDocumentsArray of additional documents to be captured. Each element includes a name and description. | 
| themeName of an included theme or object containing theme properties. * | 
| assetsObject containing any asset overrides. | 
| classNamesObject containing any classNames for inner components. * | 
| colorsObject containing any color overrides. | 
| verbiageObject containing any verbiage overrides. | 
| geolocationEnabledBoolean flag to indicate whether users should be prompted to share their location. Default is true. | 
| geolocationRequiredBoolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is false. | 
| debugModeBoolean flag to enable on-screen prediction information output. Default is false. | 
Class Names
Assets
| 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.failure.imageUrlURL to the image to display on the FaceLivenessFailure screen. Defaults to https://websdk-cdn-dev.idmission.com/assets/Face_Not_Detected.svg. |