Configuration Settings
When creating an instance of the 'IDVC' object in Javascript the constructor takes a single Javascript object as its parameter with the following fields.
Fields
allowSubmitWithWarnings (boolean) - the setting to allow submissions to be made even when a step's collected image has generated a warning. Default: true
autocaptureDelay - an integer value can be configured that will delay the autocapture the configured number of milliseconds before trying to capture an image of the ID. This prevents the autocapture mechanism from firing too quickly.
autoContinue (boolean) - the setting that enables the automatic transition from one step to the next step. Default: true
autoStart (boolean) - the setting that enables the automatic transition into the first configured step. Default: false
chunkPublicPath (string) - Path to the folder with chunks. Specify the path on the server if you need to remove the folder to another location. Default: networks
documentTypes (array) - the array contains an object per document type that is configured. Each object has the document type listed in the type field and then in its steps array you can configure what steps you want the user to complete and what capture modes you will allow (i.e. uploader and/or video)
Example of how the object for each document types is structured
{
type: "DL",
steps: [
{
type: "front",
name: "Document Front",
mode: { uploader: false, video: true },
autocaptureDelay: 500,
enableDesktopNotification: true
},
{
type: "pdf",
name: "Document PDF417 Barcode",
mode: { uploader: true, video: true },
autocaptureDelay: 500,
enableDesktopNotification: true,
enableFourCornerCapture: false
},
{
type: "face",
name: "Face",
mode: { uploader: true, video: false },
},
],
},
Available Document Types
- DL (1) – USA driver's licenses and Canadian driver's licenses
- IC (1) - USA State ID (non-driver's license)
- Passport (2) – All passports with a 2 line MRZ
- PassportCard (3) – USA passport cards
- GreenCard (6) – USA Permanent Resident Cards
- InternationalId (7) – International Documents
- EmploymentAuthorization (9) - USA Employment Authorizations
- Barcode (11) – 1-D and 2-D barcodes
Available Step Types
- front – capturing the front side of a document
- mrz – detection and capturing of the MRZ of a document
- pdf – detection and capturing of pdf417 of a document
- face – detection and capturing of the end user's face using the front camera
- barcode – detection and capturing of 1 dimensional (barcodes) or 2 dimensional (qr codes)
- back – capturing the back side of a document which contains a MRZ, a PDF417 barcode or neither
Available Capture Mode
- uploader - uploading an image from the file system
- video - capturing an image using the auto capture feature
Note
If both modes are set to false they will be default to both being true. Having no capture mode set to true is not a valid setting and is disregarded. The default setting option is used in its place. The user is made aware of this in the browser's console.
enableDesktopNotification - the front and the pdf step types can have a notification presented to the user when they are trying to use a desktop or laptop device to autocapture images of the front of an ID or a barcode that will let them know this device may not provide the best user experience and switching to a mobile device is recommended
enableFourCornerCapture - the pdf and the back step types can be configured to skip the capturing of an image of the back of the document that contains all four corners
el (string) – this is the id of the html tag on the page where the web library will be displayed. Default: videoCapturingEl
fixFrontOrientAfterUpload (boolean) - this setting will change the orientation of a front step's image if it is not horizontal when it is uploaded. Default: false
Note
This setting will only affect the orientation of a front step. So if you are using an mrz step with the Passport document type the orientation will not be affected in any way
isShowDocumentTypeSelect (boolean) – if only one document type is configured in the documentTypes array AND this setting is set to false the document type dialog will not be displayed to the end user. Default: true
language (string) – the web library supports two languages, english and spanish. English uses en and Spanish uses es. Default: en
licenseKey (string) – License Key for the Web Library provided by IDScan.net
modalPosition (string) - Place the document type selection modal inside the component
- center - place the document type selection modal in the component's middle
- bottom - place the document type selection modal in the component's bottom
- top - place the document type selection modal in the component's top
- sticky-top - sticks the document type selection modal in the component's top
- sticky-bottom - sticks the document type selection modal in the component's bottom
networkUrl (string) - run time path to the folder where the web library's neural networks have been placed. Default: networks
playPreviewAnimations (boolean) - the setting that enables the automatic playing of animations at the begining of each step. Default: true
processingImageFormat (string) - This option switches image format, that used for image processing. Available values: 'jpeg', 'png', 'webp'.
realFaceMode (string) - an option that enables advanced image capturing with volumetric face detection. Available values: 'auto', 'all', 'none'.
- auto - enable "realFaceMode" only for iPhones
- all - enable "realFaceMode" for all devices
- none - disable this option
resizeUploadedImage (integer) - sets the maximum size in pixels (of the larger of the height or width) for a manually uploaded picture. Default: -1
showSubmitBtn (boolean) - option to show the button 'submit' after capturing all the images. If the button is turned off, an event will automatically fire that triggers the submit event handler. Default: true
useCDN (boolean) - set to true if you prefer to load neural networks from a content delivery network instead of from your web server. Default: false
customTranslations (object) - Custom translations for UI strings (e.g., titles, buttons). Overrides the default library translations if provided. Default: {}
▸ Show example of a configurable object
{
"en": {
"errorCodes": {
"mrzNotFound": "Warning: MRZ was not found.",
"mrzNotRecognized": "Warning: MRZ data could not be read. Try taking another image.",
"barcodeNotFound": "Warning: Barcode not found.",
"barcodeNotRecognized": "Warning: Barcode data could not be read.<br/>Try taking a higher quality image.",
"heic": "HEIC file incorrupted",
"fileType": "File Type Error. Supported types: bmp, gif, jpg, png, tif, webp.",
"fileTypeHeic": "File Type Error: Only jpeg, png and heic images are supported.",
"disableStepFileUpload": "A device with a camera must be used to capture this image",
"notAllowedDocument": "Document not recognized as required document type",
"documentSideLowPerimeter": "Warning: The document in the photo is too small, bring it closer",
"frontSideNotDetected": "Warning: The image isn't recognized as the front side of the chosen document type",
"backSideNotDetected": "Warning: The document's side isn't recognized as the back side of the chosen document type",
"faceNotFound": "Warning: A person's face was not found in captured image",
"faceOnFrontNotDetected": "Warning: No face is found on the front of the document",
"disabledManualUpload": {
"header": "Manual upload is disabled",
"text": "Document capture via manual upload is disabled in the configuration"
},
"default": {
"header": "Please try again",
"text": "We're sorry, but there was an issue capturing and submitting the images of your document. Please try again"
},
"CameraNotFound": {
"header": "Not found",
"text": "No camera was found on your device"
},
"CameraNotFoundInVerification": {
"header": "Not found",
"text": "No camera was found on your device. <br/>Please use a different device or allow access to the camera for verification"
},
"CameraNotAllowed": {
"header": "Not allowed",
"text": "Grant permission for the browser to access the device camera <br/> or choose the Manual Upload option"
},
"CameraNotAvailable": {
"header": "Not available",
"text": "Camera is not available at the moment"
},
"CameraInUse": {
"header": "In use",
"text": "Camera is already in use"
},
"MediaDevicesNotSupported": {
"header": "Not supported",
"text": "Your browser is not supported"
},
"UnsuitableCamera": {
"header": "An unsuitable camera",
"text": "The camera on your device is unsuitable for our application (dual camera, wide-angle camera, etc.)"
},
"lowImageResolution": "The resolution of the uploaded image is too low",
"imageIsBlurred": "The image is too blurry to be used",
"faceLowArea": "Face area in the photo takes up too little space"
},
"hintTexts": {
"front": "Position the front of the document",
"frontMRZ": "Zoom in to capture code at bottom",
"mrz": "Zoom in to capture code on back side",
"capturing": "Position the front of the document",
"pdf": "Position the barcode inside the frame",
"switchToUploader": "The barcode cannot be read. <br/>Please switch to manual photo upload mode",
"back": "Turn around your document",
"barcode": "Position the barcode inside the frame",
"hold": {
"front": "Position the front side of your document inside the bounding box",
"pdf": "Position the side of your document with a PDF417 barcode inside the bounding box",
"mrz": "Position the side with MRZ of your document inside the bounding box",
"back": "Position the back side of your document inside the bounding box",
"barcode": "Position the barcode inside the bounding box"
},
"capture": {
"pdf": "Line up the barcode on your document with the barcode on the screen",
"mrz": "Line up the MRZ on your document with the MRZ on the screen",
"back": "Capture the back side of your document"
},
// hold: 'Position the front side of your document inside the bounding box',
"dontSee": "I don't see you",
"dontMove": "Don't move",
"turnFaceLeft": "Turn your face left",
"turnFaceRight": "Turn your face right",
"turnFaceUp": "Turn your face up",
"turnFaceDown": "Turn your face down",
"faceCam": "Face the camera",
"camAway": "Move camera further away",
"moveCenter": "Move to the center",
"comeCloser": "Come closer",
"documentCloser": "Bring the document closer",
"holdCamera": "Hold steady, analyzing document",
"captureCorners": "Make sure all corners of the document are inside the frame",
"frontSideNotMatch": "The front side of the document does not match the selected document"
},
"keyErrors": [
"License Key has Expired",
"License Key is Not Valid",
"License Key's Configured URL Does Not Match"
],
"general": {
"step": "Step",
"scan": "Scan",
"front": "Front",
"mrz": "MRZ",
"mrzFront": "MRZ",
"pdf": "PDF",
"face": "Selfie",
"barcode": "Barcode",
"back": "Back",
"awaiting": "Awaiting",
"notificationStepSuccess": "Successfully added",
"notificationStepWarning": "Image is not recognized",
"notificationDocumentTypeChangedInfo": "Document type has been changed",
"notificationStepsResetInfo": "All steps have been reset",
"notificationStepMinSize": "The resolution is too low",
"notificationSubmit": "Submitted",
"notificationCaptureHook": "Autocapture will work best if the document is placed on a dark colored, flat surface in an area with good lighting. If your document cannot be automatically captured using the Manual Upload option may be best",
"notificationCaptureSide": "The side of the document was captured",
"notificationCaptureWithWarnings": "Click on the Back button to go to the start page and submit the uploaded documents.",
"idvcVersionPlank": "Powered by",
"submitProcessSpinner": {
"top": "Document has been submitted for processing",
"bottom": "Please wait for the response"
},
"card": {
"edit": "Edit",
"complete": "Complete"
},
"modeSwitch": {
"video": "Camera Scan",
"uploader": "Manual Upload"
},
"uploader": {
"dragHint": "Click or Drag and Drop <br> to Upload File",
"dividerHint": "or",
"fileHint": "Browse File",
"successUpload": "uploaded successfully",
"warningUpload": "incorrect result",
"mainHint": "Ensure that your ID fills the entire screen <br> with little to no background",
"complete": "Complete"
},
"messageBox": {
"default": "Scan your Document",
"changeDocumentTypeText": "Change Document Type",
"documentTypeText": "Document Type",
"disableProcessing": "Camera permissions the configuration that is being used does not allow the user to complete the image capture/submission process"
},
"desktopNotification": {
"barcode": "The barcode capturing process using your device may not work very well. Try using your mobile device instead.",
"mrz": "The MRZ capturing process using your device may not work very well. Try using your mobile device instead.",
"other": "The image capturing process using your device may not work very well. Try using your mobile device instead."
},
"controlButtons": {
"upload": "Upload",
"reset": "Reset all steps",
"submit": "Submit",
"start": "Start",
"back": "Back",
"edit": "Change Photo",
"continue": "Continue",
"capture": "Capture",
"retake": "Retake"
},
"documentType": "Your document type is",
"selectDocumentTypeText": "Select Document Type",
"changeBtn": "Change",
"correctBtn": "Correct",
"cancelBtn": "Cancel",
"doneBtn": "Done",
"closeBtn": "CLOSE",
"retakeBtn": "Retake",
"continueBtn": "CONTINUE",
"submitBtn": "SUBMIT",
"resetAllStepsBtn": "Reset all steps",
"btnUploader": "Switch to manual uploader",
"btnCamera": "Switch to camera mode",
"pressToUpdateText": "Press to update",
"pressToUpdateTextSuccess": "Press to update"
},
"documentsTypes": {
"DL": "Driver's License",
"IC": "Identification Card",
"Passport": "Passport",
"PassportCard": "US Passport Card",
"GreenCard": "Green Card",
"EmploymentAuthorization": "Employment Authorization",
"InternationalId": "International ID",
"Barcode": "1-D and 2-D Barcodes",
"FaceAuthorization": "Face Authorization"
},
"uploaderDescription": {
"textFront": "Click here to upload the front of your ID",
"textBack": "Click here to upload the back of your ID",
"textFace": "Click here to upload a photo of your face",
"textPdf": "Click here to upload the back of a ID",
"textMrz": "Click here to upload a photo of your document",
"textFrontBack": "Please make sure your ID fills up the entire <br> camera screen with little to no background.",
"textPass": "Please make sure your ID fills up the entire camera screen <br> with little to no background, and the full MRZ code is included.",
"textFacePosition": "Please position your face to take up <br> the full camera screen with little to no background."
},
"loaderText": {
"warmup": {
"top": "Neural network is warming up",
"bottom": "Document capture will be ready to use shortly..."
},
"awaiting": "Awaiting camera response",
"loadingStep": "Loading step",
"changeMode": "Mode is changing",
"resetting": "Resetting",
"uploading": "Uploading",
"preparingToWork": "Preparing to work",
"loadingDocument": "Loading document"
}
}
}