Title
Create new category
Edit page index title
Edit category
Edit link
Desktop Document Capture
TrustX supports native ID document capture directly through a web browser on a desktop using Trust Web. Desktop Capture support enables users to complete document verification directly from their desktop webcam, with new activities, quality tuning, and injection attack detection tailored for the desktop environment.
This guide will describe how to integrate the suite of desktop capture activities to configure a flow in the Process Designer.
Desktop document capture is only available on request.
Configuring the Process Definition
Desktop document capture support front and back facing ID documents. The capture process for each follows a similar flow to regular document capture. This guide will cover front-facing document capture, but the same rules apply for back-facing document capture. For more information on each configurable activity, see the Desktop Document Capture activity parameters.
Step 1 - Create a Process Definition
- Create a new Process Definition by navigating to Process Definitions > New Process Definition in the Backoffice application.
- Add a 'Create Start Event' to the Process Designer.

- Click the 'Start' event to open the right-side contextual menu and enter a name for the 'Name' input parameter.
- Add a 'Create End Event' to the Process Designer and connect it to the 'Start' event using a sequence flow arrow.

- Click the 'End' event to open the right-side contextual menu and enter a name for the 'Name' input parameter.
Step 2 - Introduction and Capture Consent
It is recommended to configure a Process Definition to include an introduction and confirmation of capture consent when capturing an ID document.
- Add an 'Introduction' and 'Capture Consent' activity to the Process Designer and connect them using the Global connect tool.

Step 3 - Set Document Type
There are various approaches that can be taken to set the document type, including:
- Define Document Type - Define the document type and country. This activity sets the document type and country code to be used in the next activities without user interaction.
- Select Document Type - Requests the user to select a document type.
For this example, the 'Select Document Type' activity will be used.
- Add a new gateway to the Process Designer. This will represent the entry of the document capture flow.
- After the gateway, add the 'Select Document Type' activity to the Process Designer.

- By default, the 'Select Document Type' activity supports the following; drivers license, ID card, Passport, other. It features the following input parameters:
| Parameter | Description | Type | Default |
|---|---|---|---|
| Allowed Countries | Only allow certain countries to be selected. This is a list of two letter ISO 2 country codes. For example: gb | LIST_STRING | |
| Custom Countries Configuration | Custom document configuration for countries. A JSON example can be found below. | STRING | {} |
| Default Country | The country code of the default country. This value must be a two letter ISO 2 country code. For example: gb. This field must not be blank. | STRING | us |
| Document Key | The identifier of the document. | STRING | doc1 |
| Document Types | The list of document types to be presented to the user. Possible values include: DRIVERS_LICENSE, ID_CARD, PASSPORT, and OTHER. | LIST_STRING | [ "DRIVERS_LICENSE", "ID_CARD", "PASSPORT", "OTHER" ], |
| List of Screens | The list of screens to be presented to the user during this activity. | LIST_STRINGS | [ "document-type-selection", "country-selection" ], |
| Starting Component ID | The name of the capture step ID for this activity. | STRING | document-capture-v3 |
| UI Component ID | The name of the screen used in the capture UI. | STRING | document-type-selection |
Step 4 - Capture Document
The 'Desktop Document Capture - Front' activity can be used to capture the front-side of an ID document using a desktop. This step will describe how to add the activity and the configurable input parameters available.
- After the 'Select Document Type' activity, add a new gateway to represent the beginning of the front-side document capture.
- Add the 'Desktop Document Capture - Front' activity to the Process Designer and connect them using the Global connect tool.

- The activity supports the following configurable input parameters:
| Parameter | Description | Type | Default |
|---|---|---|---|
| Advance configuration | An optional field that will allow the override of capture parameters without explicitely naming all the parameters. | String | {"delayStartInMilliseconds": 200,"lastPassedFrameDelayInMilliseconds":150} |
| Allow back | Allow the scanning of the back of the document. | Boolean | ${false} |
| Auto Capture Timeout | Only applicable when 'Capture Mode' is set to AUTOCAPTURE. The timeout for autocatpure in seconds, this should be less than the overall activity timeout. After the allotted time has passed, the ‘Failed to capture’ error boundary event will trigger. | Integer | ${60} |
| Camera Height | The height of the camera set during capture. | Integer | ${1080} |
| Camera Width | The width of the camera set during capture. | Integer | ${1920} |
| Capture Mode | Defines the capture mode. Acceptable values include 'AUTOCAPTURE' and 'MANUAL'. In MANUAL mode, the user clicks a button to start a countdown to capture a frame from the video feed. In AUTOCAPTURE, capture will occur automatically. | String | AUTOCAPTURE |
| Cropping Tolerance | The cropping tolerance. | DOUBLE | ${0.06} |
| Disable switch camera | Disable switching between front and back cameras. | Boolean | ${false} |
| Document aspect ratio | Document aspect ratio. | String | ${_documentType == 'PASSPORT' ? 1.42 : 1.58} |
| Document Image Format | The format of the image to be captured. | String | jpeg |
| Document Key | The identifier of the document. | String | doc1 |
| Document Side | Which side of the document will be scanned by this activity. | String | FRONT |
| Flash experience | Determines whether a flash is triggered upon successful capture of a document image. | Boolean | ${false} |
| Focus Mode | Only applicable when 'Capture Mode' is set to MANUAL. Sets the focus mode of the camera when initialized and available. "continuous" showed better results for webcams that support focus control. Applicable values include: manual, single-shot, and continuous. | String | continuous |
| List of Screens | The List of screens to be presented to the user during the capture process. Possible values include: instructions, capture, and preview. | List_String | ["capture"] |
| Manual Capture - Count Down Seconds | Only applicable when 'Capture Mode' is set to MANUAL. The count down in seconds before the capture will be taken. | Integer | ${3} |
| Manual Capture - Focus Distance | Only applicable when 'Capture Mode' is set to MANUAL. Sets the focus distance amount. | Integer | |
| Manual Capture - Max Attempts | Only applicable when 'Capture Mode' is set to MANUAL. The maximum number of allowed retry attempts. If 0, the user will have infinite retries. | Integer | ${3} |
| Manual Capture - Show Focus Distance Control | Only applicable when 'Capture Mode' is set to MANUAL. If focus control is available on the device - show the focus control | Boolean | ${true} |
| Mirror video | If enabled, the capture feed will be mirrored to match the capture experience on a mobile device. This is recommended for the best user experience. | Boolean | ${true} |
| MRZ Enabled | Set whether MRZ scanning will be enabled. By default, MRZ scanning is enabled for passport documents. | String | ${_documentType == "PASSPORT"} |
| Report Metrics | When enabled, report metrics will send document capture session data to TrustX for debugging purposes. This functionality is enabled by default. | Boolean | ${true} |
| Starting Component ID | The name of the capture step to be sent to the UI | String | document-capture-desktop |
| Tag 1 | The name of the capture step to be sent to the UI | String | Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional. |
| Tag 2 | The name of the capture step to be sent to the UI | String | Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional. |
| Tag 3 | The name of the capture step to be sent to the UI | String | Tags are values that the user can put into the activity to “tag” the capture process. These values may not be provided and are optional. |
| Timeout in Seconds | Camera timeout in seconds. | Integer | ${60} |
| UI Component ID | The name of the screen used in the capture UI. | String | capture |
| Use Native Capture Only | Use the native capture process. This parameter is not officially supported and Daon recommends to keep the value set to false. | Boolean | ${false} |
- Additionally, the activity contains two error boundary events:
| Name | Description |
|---|---|
| Timer Boundary Event | Triggered when the user fails to capture a document after the allotted time has elapsed. |
| Failed to capture | Triggered when the number of retry attempts are exceeded. |
Step 5 - Configure Document Checks
TrustX provides a variety of document checks that can be used to determine quality and authenticity of a captured document image. See Document Capture and Verification for a full list of available document checks.
For desktop document capture, the only unique difference from a regular document capture flow is the use of the 'Document Desktop Quality' assessment activity.

The activity includes the following configurable input parameters:
| Parameter | Description | Type | Default |
|---|---|---|---|
| Crop Image | Whether the received document image will be cropped. | Boolean | ${true} |
| Document Key | The identifier of the document. | String | doc1 |
| Error navigation screen | The screen that the end user will be redirected to if an error occurs. Common values include: instructions, capture, preview. However, this can be any 'list of screen' value that appears in the activity connected to the error event. | String | preview |
The activity includes one error boundary event, 'F ailed document quality', which is triggered when the document fails quality assessment.
Step 6 - Process and Check Document Type
After document quality and authenticity checks, an ID Document Processor can be used to process and extract document information. In this step, the document will be processed and the document type will be checked for an acceptable document type.
- After completing checks, add a 'Confirm Document Image - Front' activity to the Process Designer. This activity will prompt the user to confirm the captured document image.
- Add an 'ID Document Processor' to process that captured and confirmed document.
- After data has been extracted, add an 'Acceptable Document Type' activity to check the document type to ensure it matches the document type selected at the start of the flow.

Step 7 - Finalize Process Definition
- After the 'Acceptable Document Type' activity, add a 'Simple Decider'. This activity is used to make a PASS or FAIL decision based on the outcome of the quality and authenticity checks.
- Connect the 'Simpler Decider' activity to the 'End' event.

- Click the 'Save & Deploy' button at the bottom of the page to finalize the Process Definition.
Test and View Results
To test the flow, create a new Process Token from the Process Definitions page.
- Navigate to the Process Definitions page and find the passcode registration Process Definition.
- Click the 'key' under the 'Actions' tab to create a new Process Token.

- A pop-up modal will appear where parameters of the token can be defined.

- At the desktop capture screen, permissions to use the web camera will be requested. If MANUAL is configured, a button will appear where the user can start the capture process. Otherwise, document capture will initiate automatically.

Manual desktop capture will show a circular button to initiate the capture process
- Results of the capture can be viewed by navigating to the Process Instances page and finding the Process Definition using the search filter options.

- Captured documents and checks performed can be found under the 'Documents' section.
