Additional Documents Collection

Introduction

Additional Documents allow users to define and collect non-identity and non-government documents. These documents are specific to a certain customer and may include health insurance card, electricity bill, residency card, bank loan application etc and be in various forms.

Custom defined documents can be implemented using a new action available in the Process Designer. This guide will cover the steps required to create an additional document and add it to the process flow.

Configure Additional Document Collection

Additional Document configuration is managed from the Process Designer found in the Process Definition page of the Backoffice. For this guide, Electricity Bills and Health Insurance Cards will be used as examples, however, it is possible to configure any additional document using the JSON Schema of the additionalDocuments input parameter.

Additional Document collection can be included as part of an existing Process Definition or introduced from scratch. For this guide, a new Process Definition will be created. For more information, see the Process Definition Guide.

Click the 'New Process Definition' button found at the top-right of the Process Definition page.

A new template is available that integrates Additional Documents Collection as default in the Process Designer.

Activities pertaining to capturing additional documents can be found after document verification activities, with the Select Additional Document Type V2 as the first activity.

Alternatively, additional document capture can be configured manually using the activities available in the left-side activity menu.

Defining JSON Schema and Activity Descriptions

There are three activities that must be configured to collect Additional Document information: Selection Additional Document Type, Capture Additional Document, and Addition Capture Decider.

Select Additional Document Type is used to choose the appropriate document that will be captured via picture or file upload. The main input parameter is additionalDocuments, which is used to define list of additional documents to capture or upload. All documents should have the following properties:

• id - The unique identifier associated with the document.

• required - A true/ false boolean type. This determines whether the document is required to proceed with the ID&V flow.

• title - The title given to the document. This will be displayed in the TrustX app to end users.

• captures - The capture type associated with the document. Formats include .jpeg, .png, and .pdf.

• subtitle - This is a subtitle associated with the document that will be shown on the capture instructions screen.

• instructions - A list of instructions which will be displayed to the end user for capturing/ uploading a document.

• acceptableFileTypes - A list of acceptable file types. Supported file types include:

  • image - jpg, jpeg, and png
  • file - pdf

• sampleImage - A sample image which will be displayed to the end user on the capture instructions screen.

• pages - The number of pages associated with the additional document.

• imageHref - Add an image to the Additional Document.

• requirements - A list of requirements that must be met for the document to pass validation.

  • minAdditionalDocuments - The minimum number of documents that should be captured/uploaded to finish the step successfully. If the value is 1 and the end user has yet to capture the required document, then they should capture the required document to finish the step.

An example JSON schema can be found below:

xxxxxxxxxx

{

   "additionalDocuments":{...},

   "requirements":{...}

}

Example of the JSON schema in the Additional documents configuration input parameter

The Capture Additional Document activity is used to capture or upload the selected document based on the ID that is sent from the client web application. It has the following input parameters:

• Document File Format - Defines the file format to be captured/ uploaded. File formats include: .jpeg, .png, .pdf.
• Starting component ID - Unique identifier for the capture screen.
• List of Screens - The list of screens to be displayed to the end user.
• UI Component ID - Unique identifier representing the UI component of the activity.
• Timeout In Seconds - The allotted time required to complete the capture before a timeout error occurs.
• Use Native Capture - A boolean value to determine whether to use native capturing.

The Additional Capture Decider activity is used to determine whether all required documents have been captured. If all additional documents are present, the end user will proceed to the next step in the ID&V flow. If additional captures are required, the end user will be redirected to the Select Additional Document Type step.

Example Implementation

After the Additional Document Capture activities have been successfully implemented in the Process Designer, the ID&V flow can be tested. First, generate a token for the newly created Process Definition.

Scan the QR code or open the token URL and navigate through the steps of the ID&V flow before reaching the Additional Document Capture steps.

Select Additional Document Type screen

When a document type is selected, the capture instructions screen will be displayed:

Example Capture Instructions page

Clicking 'Continue' will open the file upload page where users can take a photo or upload an existing photo from the gallery. Once a file is chosen, a progress tracking screen will appear:

The progress bar displays remaining time before upload is completed

When all requirements are met, the upload step will complete successfully:

Success Screen showing a completed progress bar when all conditions are met

Viewing Results

Successfully uploaded documents can be viewed via the Process Instance page of the Backoffice. Select the Process Instance associated with the completed ID&V flow and find the section titled "Additional Documents" to view all additional documents that were captured during the ID&V process.

Manual Additional Document Capture

Early Access

Capture additional Document v5+ introduces manual capture functionality which displays a new screen for manual capture. The 'Capture Additional Document v5+' activity provides a 'Capture Mode' input parameter that can be used to change between NATIVE and MANUAL capture.

The example below demonstrates how to configure a Process Definition to utilize the MANUAL Capture setting.

1. In the BackOffice, create a new Process Definition by navigating to Process Definitions > New Process Definition to create a new Process Definition.
2. Set up the simple framework of a Process Definition by adding a Start Event and End Event to the Process Definition.

3. Add a 'Select Additional Document Type V2' activity to the Process Definition. This activity will request the user to select the document type of the additional document to be uploaded.

4. The activity supports the following input parameters:

5. After the 'Select Additional Document Type V2' activity, add a 'Capture Additional Document v5' activity.

6. This activity supports the following input parameters:

7. For this example, set the Capture Mode to MANUAL.

8. After the 'Capture Additional Document v5' activity, add an 'Additional Capture Decider'. This activity decides whether the user finishes capturing or should go back to Select Additional Document Type activity and do selection and capturing again.

9. Finally, add a 'Simple Decider' to the Process Definition. This activity will make a final decision on the Process Instance.

10. Once the Process Definition has been finalized, click the Save & Deploy button to complete the Process Definition.
11. When the capture steps appears in the Trust Web, the user will be met with the manual capture screen.