Document Capture
Overview
As part of the standard ID&V flow, TrustX provides document capture capability to capture and verify identity documents. For client-side capture on iOS, Android and web browsers, the IDCapture SDK is used.
The following document types are supported:
- Passports
- Drivers Licenses
- ID Cards
Additional document types can be added by defining additional documents in TrustX. See Additional Documents Collection for more information.
TrustWeb Feedback Messages
Document Capture V3 and above provides end-users with helpful feedback during the document capture process to ensure an efficient and accurate capture is taken. The table below outlines each scenario and the feedback message that can be expected when an issue occurs.
The list of feedback messages below apply to the Document Capture v3, Select Document Type v3, and Confirm Document Image activities. Earlier versions of the Document Capture, Select Document Type or Confirm Document activities activities will not show the same feedback messages.
| Scenario | Feedback Message |
|---|---|
| Document must be held still to take a clear photo | Hold your document still while we take a clear photo. |
| Document has been detected, but it is too small | Bring your document closer to fill the frame. |
| Camera was not steady during capture | Keep your device steady for a clear image. |
| Strong glare in camera feed | Reduce bright spots on your document by moving away from strong light. |
| Not enough contrast between document and background | Place your document on a plain background for better contrast. |
| No document detected - The document must be repositioned | Reposition your document to fill the frame. |
| MRZ is not fully visible - The document must be repositioned | Please ensure that the MRZ is fully visible inside the rectangle. |
| Barcode is not fully visible - The document must be repositioned | Please ensure that the barcode is fully visible inside the rectangle. |
| Shaky or blurry image detected | Your document image is low quality, please recapture the image. |
| Document is tilted | Keep your document flat for a clear photo. |
| No document detected - The document must be repositioned | Align your document within the frame. |
Document Capture Input Parameters
Camera Width and Camera Height
The camera width and height properties control the camera resolution of the document capture process. The default value is 2560x1440 pixels. Users can downscale the resolution to 1920x1080 if applicable.
The width and height can be adjusted from the Process Designer. Under Input Parameters, find Camera Width and Camera Height fields.
Capture Orientation
Capture orientation controls the orientation of which the document will be captured. Possible values include portrait and landscape. Portrait capture will also allow both portrait and landscape orientations to be captured. However, landscape will only support landscape capture.
Capture orientation can be updated from the Process Designer. Under Input Parameters, find the 'Capture Orientation' input parameter. Possible values include 'PORTRAIT' or 'LANDSCAPE'.
Cropping Tolerance
The cropping tolerance value controls the edge detection threshold of the area surrounding the document to be captured. The default value is 6% (0.06). This can be adjusted higher or lower depending on the document processor.
The cropping tolerance ratio can be updated from the Process Designer. Under Input Parameters, find the 'Cropping Tolerance' input parameter. This field accepts a double value as input.
Report Metrics
When enabled, report metrics will send document capture session data to TrustX for debugging purposes. It will store all feedback messages and values. This functionality is enabled by default.
Metric reporting can be enabled or disabled from the Process Designer. Under Input Parameters, find the 'Report Metrics' input parameter.
Document Aspect Ratio
This value controls aspect ratio of the identity document. For passport documents, the recommended value is 1.42. For all other document types, the default value is 1.58.
The document aspect ratio can be updated from the Process Designer. Under Input Parameters, find the 'Document aspect ratio' input parameter. This field accepts a double value as input.
Document Image Format
This configuration determines the image format that the document capture will be saved as. Supported file types include jpg, jpeg, or png.
The image format can be defined from the Process Designer. Under Input Parameters, find the 'Document Image Format' input parameter where the list of supported formats can be defined. Formats can be provided as a comma separated list.
The image format is defined using the following syntax:
png example: image/png.
Only one image format is supported for each document capture.
Example:
Flash Experience
The Flash experience configuration will provide feedback during the document capture process. If enabled, a flash will trigger when a document is captured successfully during the capture document step. This configuration can be applied for both front and back document capture and is enabled by default. This field accepts a boolean value of either true or false.
MRZ Enabled
Document Capture V3 supports machine-readable zone (MRZ) , which contains the encoded personal information belonging of a document holder. MRZ scanning is supported by Passport document types only.
MRZ scanning can be configured from the Process Designer. Under Input Parameters, find the 'MRZ Enabled' input parameter.
For front capture, MRZ is enabled for passport documents by default: ${_documentType == "PASSPORT"}. For back capture, MRZ scanning is disabled by default.
PDF417 Enabled
When enabled, PDF417 scanning will capture the barcode of a supported document. This functionality is disabled by default.
PDF417 scanning can be configured from the Process Designer. Under Input Parameters, find the 'PDF417 Enabled' input parameter.
For front-side document capture, this property is disabled by default. For back-side document capture, this parameter is configured to capture US drivers licenses, using the value: ${_documentType_== "_DRIVERS _LICENSE" && _documentCountry == "us"}``
When a barcode is scanned as part of the document capture process, the results can be viewed from the Process Instance Details page. Captured barcodes can be found under the Document Images and Security Elements sections.
Advanced Configuration
This is an optional field that will allow the override of capture parameters without explicitly naming all the parameters.
A full list of configurable properties can be seen in the table below.
| Property | Type | Description |
|---|---|---|
| idCaptureCropEnabled | boolean | When true, ID Capture will perform cropping on the image. If false, the SDK will perform cropping. |
| shouldDownscaleFrame | boolean | When true, images will be downscaled to 1080p while processing. |
| nPassedFrames | number | Sets the number of consecutive frames to pass. |
| delayStartInMilliseconds | number | Delay of capture at the start in milliseconds. |
| lastPassedFrameDelayInMilliseconds | number | Introduced in document capture v4, this configuration applies a delay when processing the last passed frame in situations where the processing may be slow. |
| thresholds | object | Quality thresholds to be overridden (not recommended). |
Tags
Tags are optional values that users can use to “tag” the capture process.
It may be useful for a custom data form to capture tags from a user during a process instance and record these on the server.
Three tags are available and can be accessed via the Document Capture v3 activity input parameters.
Disable Switch Camera
Document Capture v3 enables users to disable the switch camera functionality. This will allow users restrict the camera used during document capture.
This property can be configured by setting a boolean value in the input parameters of the Document Capture v3 activity. By default, this property is set to false, meaning that switching cameras is enabled.
Scale Frames Down if Slow
Document Capture v4 allows users set whether to reduce the number of required frames of a document capture in the event that the capture processing is too slow.
This property is a boolean value and can be configured within the input parameters of the Document Capture v4 activity.
Manual Capture Delay
Introduced in Document Capture v4, this parameter is represented as a list of integer values that determine the intervals when the popup modal will appear. The value is in seconds.
Use Legacy Processing Screen
Available to Document Capture v4, the 'Use Legacy Processing Screen' input parameter enables users to switch between the legacy processing screen and the newer processing screen. Both screens are customizable in the Themes section of the Backoffice application. For information on managing Themes, see the Themes Guide.
The default value of the 'Use Legacy Processing Screen' input parameter is false, meaning the new processing screen will be in use.
This input parameter will be available to new Document Capture v4 activities added to a Process Definition. Existing Process Definitions utilizing the Document Capture v4 activity will not contain the 'Use Legacy Processing Screen' input parameter and will default to the legacy behavior.
New Processing Screen:
Legacy Processing Screen:
