General Activity Parameters

Custom Pages

Deprecated Custom Data Form v2

This activity allows users to define custom forms that are introduced to the ID&V flow. For more information, see the Custom Data Forms guide.

Input Parameters

Parameter	Description	Type	Default
Data form name	A drop-down list of all available custom forms created in TrustX. The chosen form will be displayed to the end user in the ID&V flow.	STRING
Data form version	Determines which version of the selected custom form will be displayed.	INTEGER	1
Dynamic data form name	The name of the dynamic data form.	String
Form data key	When multiple Custom Data Forms are used in one Process Definition, the form data key will be used as a unique identifier to distinguish Custom Form activities from each other.	STRING	form1
Hide buttons	When set to true, all form buttons will be hidden	BOOLEAN	${false}
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	[ custom-data-form ]
Max Attempts	The maximum number of attempts to retake the form before an error is thrown.	INTEGER	${3}
Readonly	This field determines whether the displayed form is readonly.	BOOLEAN	${false}
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-data-form
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-data-form

Custom Data Form v3

This activity allows users to define custom forms that are introduced to the ID&V flow. For more information, see the Custom Data Forms guide.

Input Parameters

Parameter	Description	Type	Default
Data form name	A drop-down list of all available custom forms created in TrustX. The chosen form will be displayed to the end user in the ID&V flow.	STRING
Data form version	Determines which version of the selected custom form will be displayed.	INTEGER	1
Dynamic data form name	The name of the dynamic data form.	String
Form data key	When multiple Custom Data Forms are used in one Process Definition, the form data key will be used as a unique identifier to distinguish Custom Form activities from each other.	STRING	form1
Hide buttons	When set to true, all form buttons will be hidden	BOOLEAN	${false}
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	[ custom-data-form ]
Max Attempts	The maximum number of attempts to retake the form before an error is thrown.	INTEGER	${3}
Readonly	This field determines whether the displayed form is readonly.	BOOLEAN	${false}
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-data-form
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-data-form

Custom Data Form Without Response

This activity allows users to define custom forms that will not receive a response from TrustX.

Input Parameters

Parameter	Description	Type	Default
Data form name	A drop-down list of all available custom forms created in TrustX. The chosen form will be displayed to the end user in the ID&V flow.	STRING
Data form version	Determines which version of the selected custom form will be displayed.	INTEGER	1
Dynamic data form name	The name of the dynamic data form.	String
Form data key	When multiple Custom Data Forms are used in one Process Definition, the form data key will be used as a unique identifier to distinguish Custom Form activities from each other.	STRING	form1
Hide buttons	When set to true, all form buttons will be hidden	BOOLEAN	${false}
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	[ custom-data-form ]
Max Attempts	The maximum number of attempts to retake the form before an error is thrown.	INTEGER	${3}
Readonly	This field determines whether the displayed form is readonly.	BOOLEAN	${false}
Redirect URL	The URL that will be redirected to after the Custom Page is complete. This parameter is required in order for the flow to continue.	STRING
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-data-form
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-data-form

Deprecated Custom Page

This activity enables users to create a custom page within the ID&V flow. For more information, see the Custom Pages Guide.

Input Parameters

Parameter	Description	Type	Default
Constants	A list of key value pairs that are sent to the custom page allowing users to customize behavior using variables between custom pages.	Key Value Map
Custom Page Key	The unique identifier of the custom page activity.	STRING	customPage1
Custom Page Name	The name of the custom page to be used	STRING
Custom Page Version	The version of the custom page to be used.	STRING	${1}
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	[ custom-page ]
Session Data	A key value list of session data to pass to the custom page.	Key Value Map
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-page
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-page

Custom Page V2

This activity enables users to create a custom page within the ID&V flow. For more information, see the Custom Pages Guide.

Input Parameters

Parameter	Description	Type	Default
Constants	A list of key value pairs that are sent to the custom page allowing users to customize behavior using variables between custom pages.	Key Value Map
Custom Page Key	The unique identifier of the custom page activity.	STRING	customPage1
Custom Page Name	The name of the custom page to be used	STRING
Custom Page Version	The version of the custom page to be used.	STRING	${1}
Hide Spinner	If enabled, the spinner graphic will be hidden from the custom page.	BOOLEAN	${false}
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	[ custom-page ]
Session Data	A key value list of session data to pass to the custom page.	Key Value Map
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-page
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-page

Early Access Custom Page V3

This activity enables users to create a custom page within the ID&V flow. For more information, see the Custom Pages Guide.

Input Parameters

Parameter	Description	Type	Default
Constants	A list of key value pairs that are sent to the custom page allowing users to customize behavior using variables between custom pages.	Key Value Map
Custom Page Key	The unique identifier of the custom page activity.	STRING	customPage1
Custom Page Name	The name of the custom page to be used	STRING
Custom Page Version	The version of the custom page to be used.	STRING	${1}
Hide Spinner	If enabled, the spinner graphic will be hidden from the custom page.	BOOLEAN	${false}
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	[ custom-page ]
Session Data	A key value list of session data to pass to the custom page.	Key Value Map
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-page
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-page

Custom Page Without Response

This activity enables users to create a custom page that will not receive a response from TrustX.

Input Parameters

Parameter	Description	Type	Default
Constants	A list of key value pairs that are sent to the custom page allowing users to customize behavior using variables between custom pages.	Key Value Map
Custom Page Key	The unique identifier of the custom page activity.	STRING	customPage1
Custom Page Name	The name of the custom page to be used	STRING
Custom Page Version	The version of the custom page to be used.	STRING	${1}
Hide Spinner	When set to true, the loading spinner that appears on the page will be hidden.	BOOLEAN	${false}
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	[ custom-page ]
Redirect URL	The URL that will be redirected to after the Custom Page is complete. This parameter is required in order for the flow to continue.	STRING
Session Data	A key value list of session data to pass to the custom page.	Key Value Map
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-page
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-page

Early Access Custom Page Without Response V2

This activity enables users to create a custom page that will not receive a response from TrustX.

Input Parameters

Parameter	Description	Type	Default
Constants	A list of key value pairs that are sent to the custom page allowing users to customize behavior using variables between custom pages.	Key Value Map
Custom Page Key	The unique identifier of the custom page activity.	STRING	customPage1
Custom Page Name	The name of the custom page to be used	STRING
Custom Page Version	The version of the custom page to be used.	STRING	${1}
Hide Spinner	When set to true, the loading spinner that appears on the page will be hidden.	BOOLEAN	${false}
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	[ custom-page ]
Redirect URL	The URL that will be redirected to after the Custom Page is complete. This parameter is required in order for the flow to continue.	STRING
Session Data	A key value list of session data to pass to the custom page.	Key Value Map
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-page
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-page

Deprecated Custom Page - External

This activity enables users to share a custom page via URL within the ID&V flow.

Input Parameters

Parameter	Description	Type	Default
Constants	A list of key value pairs that are sent to the custom page allowing users to customize behavior using variables between custom pages.	Key Value Map
Custom Page Key	The unique identifier of the custom page activity.	STRING	customPage1
External Page URL	The URL to the custom page. "https://" will be automatically added to the beginning of the URL value.	STRING	https://
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	[ custom-page ]
Session Data	A key value list of session data to pass to the custom page.	Key Value Map
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-page
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-page

Custom Page V2 - External

This activity enables users to share a custom page via URL within the ID&V flow.

Input Parameters

Parameter	Description	Type	Default
Constants	A list of key value pairs that are sent to the custom page allowing users to customize behavior using variables between custom pages.	Key Value Map
Custom Page Key	The unique identifier of the custom page activity.	STRING	customPage1
External Page URL	The URL to the custom page. "https://" will be automatically added to the beginning of the URL value.	STRING	https://
Hide Spinner	If enabled, the spinner graphic will be hidden.	BOOLEAN	${false}
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	[ custom-page ]
Session Data	A key value list of session data to pass to the custom page.	Key Value Map
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-page
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-page

Early Access Custom Page V3 - External

This activity enables users to share a custom page via URL within the ID&V flow.

Input Parameters

Parameter	Description	Type	Default
Constants	A list of key value pairs that are sent to the custom page allowing users to customize behavior using variables between custom pages.	Key Value Map
Custom Page Key	The unique identifier of the custom page activity.	STRING	customPage1
External Page URL	The URL to the custom page. "https://" will be automatically added to the beginning of the URL value.	STRING	https://
Hide Spinner	If enabled, the spinner graphic will be hidden.	BOOLEAN	${false}
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	[ custom-page ]
Session Data	A key value list of session data to pass to the custom page.	Key Value Map
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-page
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-page

Custom Page Without Response - External

This activity enables users to share a custom page via URL within the ID&V flow.

Input Parameters

Parameter	Description	Type	Default
Constants	A list of key value pairs that are sent to the custom page allowing users to customize behavior using variables between custom pages.	Key Value Map
Custom Page Key	The unique identifier of the custom page activity.	STRING	customPage1
External Page URL	The URL to the custom page. "https://" will be automatically added to the beginning of the URL value.	STRING	https://
Hide Spinner	When set to true, the loading spinner animation will not appear on the page.	BOOLEAN	${false}
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	[ custom-page ]
Redirect URL	The URL to redirect to after the page is complete. This parameter is required in order for the flow to continue.	STRING
Session Data	A key value list of session data to pass to the custom page.	Key Value Map
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-page
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-page

Early Access Custom Page Without Response - External V2

This activity enables users to share a custom page via URL within the ID&V flow.

Input Parameters

Parameter	Description	Type	Default
Constants	A list of key value pairs that are sent to the custom page allowing users to customize behavior using variables between custom pages.	Key Value Map
Custom Page Key	The unique identifier of the custom page activity.	STRING	customPage1
External Page URL	The URL to the custom page. "https://" will be automatically added to the beginning of the URL value.	STRING	https://
Hide Spinner	When set to true, the loading spinner animation will not appear on the page.	BOOLEAN	${false}
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	[ custom-page ]
Redirect URL	The URL to redirect to after the page is complete. This parameter is required in order for the flow to continue.	STRING
Session Data	A key value list of session data to pass to the custom page.	Key Value Map
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	custom-page
UI Component ID	The name of the screen used in the capture UI.	STRING	custom-page

Reports

Deprecated Write Summary Report

Writes a summary report of the end user activity through the ID&V flow.

Input Parameters

Parameter	Description	Type	Default
List of Screens	The list of screens to be presented to the user during the capture process.	LIST_STRING	[ "thank-you" ]
Starting Component ID	The name of the capture step to be sent to the UI.	STRING	thank-you
UI Component ID	The name of the screen used in the capture UI.	STRING	instructions

Write Summary Report V2

Writes a summary report of the end user activity through the ID&V flow.

Counter V1

Adds a counter so that users can keep track of the number of times an action was performed during the Process Instance.

Input Parameters

Parameter	Description	Type	Default
Counter Name	The name of the counter.	STRING	myCounter

General Activities

Capture Consent

The Capture Consent activity will display the full privacy policy and terms and conditions that the user must agree to before continuing the ID&V flow.

Input Parameters

Parameter	Description	Type	Default
Consent	A JSON document representing the consent info to be sent to the user.	LIST_STRING	[ "{"title":"Terms and Conditions", "url":"https://d16p4au7y0bczp.cloudfront.net/term_of_use_consent.html", "type":"url"}", "{"title":"Privacy Policy", "url":"https://d16p4au7y0bczp.cloudfront.net/privacy_policy_consent.html", "type":"url"}" ]
List of Screens	The list of screens to be presented to the user during this activity. Possible values include: consent.	LIST_STRING	["consent"]
Starting Component ID	The name of the step ID for this activity.	STRING	consent
UI Component ID	The name of the screen used to excute this activity.	STRING	consent

Switch to Mobile

This activity will prompt the end user to scan a QR code that will switch from desktop to mobile before continuing the ID&V flow.

Input Parameters

Parameter	Description	Type	Default
Consent	The list of screens to be presented to the user during this activity. Possible values include: instructions and scan-qr.	LIST_STRING	[ "instructions", "scan-qr" ]
List of Screens	The list of screens to be presented to the user during this activity.	LIST_STRING	["consent"]
Starting Component ID	The name of the step ID for this activity.	STRING	mobile-to-switch
UI Component ID	The name of the screen used to excute this activity.	STRING	instructions

Switch to Browser

This list will redirect the user from a mobile device back to the desktop browser they started the ID&V flow from.

Input Parameters

Parameter	Description	Type	Default
List of Screens	The list of screens to be presented to the user during this activity. Possible values include: switch-to-desktop.	LIST_STRING	["switch-to-desktop"]
Starting Component ID	The name of the step ID for this activity.	STRING	switch-to-desktop
UI Component ID	The name of the screen used to excute this activity.	STRING	switch-to-desktop

Introduction

The introduction page that the end user will meet at the start of the ID&V flow.

Input Parameters

Parameter	Description	Type	Default
Activities	The list of activities to be presented to the user during this activity.	LIST_STRING	[ "consent", "document-capture", "face-capture" ]
List of Screens	The list of screens to be presented to the user during this activity. Possible values include: introduction.	LIST_STRING	["introduction"]
Starting Component ID	The name of the step ID for this activity.	STRING	introduction
UI Component ID	The name of the screen used to excute this activity.	STRING	introduction

Sample - Update Steps Order

The order of steps as they appear on the Introduction page can be modified by using the 'Activities' input parameter. To update this order, follow the steps below.

1. Navigate to the Create/ Edit Process Definition page in the Backoffice.
2. In the BPMN editor, click the 'Introduction' activity.

3. From the right-side context menu, expand the 'Input Parameters' option. Expand the 'Activities' option listed beneath.

Currently, activities listed at the bottom of the list will appear first in the order of the TrustX app. In the example above, consent will appear first and document-capture will appear last in the TrustX app.

Note, that a change in behaviour is expected shortly in order to display the activities in the order set.

4. The listed values will determine the order in which the steps will appear on the Introduction page. Click Save & Deploy to ensure that any changes are saved and reflected in the TrustX app.
5. Launch the TrustX app to see the updated order of steps.

Cloud Function Activities

Execute Cloud Function v2

This activity will allow users to execute a cloud function during the current point of the process. For more information on configuring cloud functions, see the Cloud Functions and Process Definitions guide. This Cloud Function will run Python 3.9 & 3.12 Cloud Functions.

Input Parameters

Parameter	Description	Type	Default
Cloud Secrets	The name of the cloud secrets to be passed to the cloud function, wildcard matches are not supported.	LIST_STRING	[]
Function Name	The name of the function to execute.	STRING	The name of the function
Function Version	The version of the function to execute.	INTEGER	${0}
Metrics		LIST_STRING
Process Variables	The name of the process variables to be passed to the cloud function, wildcard matches are supported.	LIST_STRING	[H_documentProcessorResults, documentProcessorDocInfo, documentProcessorName, documentProcessorResultsPath, idDocs]
Report Log	Use Report Log.	BOOLEAN	${true}
Rule Execution Name	The name of the function to rule execution name.	STRING	The name of the rule execution name

Review Activities

Review Required

Presents the end user with a screen informing them that further review is required. For more information, see the Manual Review Guide.

Input Parameters

Parameter	Description	Type	Default
List of Screens	The list of screens to be presented to the user during the review process.	LIST_STRINGS	["thank-you"]
Starting Component ID	The name of the component to be sent to the UI	STRING	review
UI Component ID	The name of the screen used in the capture UI	STRING	review

Send Email

This activity is used to send an email to the specified recipients. The body of the email is defined using Email Template. For more information, see the Email Templates Guide.

Input Parameters

Parameter	Description	Type	Default
BCC	The list of blind carbon copy recipients.	LIST_STRINGS	[]
CC	The list of carbon copy recipients.	LIST_STRINGS	review
Email template language	The language that the email will be displayed in.	STRING	NULL
Email template name	A drop-down list of all email templates created in the Backoffice.		NULL
Email template version	The version of the selected email template to send.	INTEGER	${1}
Fail on Invalid Email	Determine whether to fail the activity if an invalid email is provided.	BOOLEAN	${false}
From	The From address that the email is sent from.	STRING	no-reply@trustx.com
To	A list of recipients to send the email to.	LIST_STRING	[]

Deprecated Redirect User

This activity is used to redirect the end-user to the _redirectUrl defined within the Additional Parameters of the Process Token.

Input Parameters

Parameter	Description	Type	Default
Redirect URL	The _redirectURL that the end-user will be redirected to. Additional Parameters defined within the Process Token can also be passed to the URL. For example: https://your-domain.com/{{processvar._initVars.params['firstName']}}	{{processvar._redirectUrl}}

Redirect User V2

This activity is used to redirect the end-user to the _redirectUrl defined within the Additional Parameters of the Process Token.

Input Parameters

Parameter	Description	Type	Default
Redirect URL	The _redirectURL that the end-user will be redirected to. Additional Parameters defined within the Process Token can also be passed to the URL. For example: https://your-domain.com/{{processvar._initVars.params['firstName']}}	{{processvar._redirectUrl}}

Waiting for Resume v2

This activity is used to resume a paused Process Instance.

Input Parameters

Parameter	Description	Type	Default
Key	The unique identifier associated with the activity.	resume1

Raise Incident v1

Raises an incident that will lead a Process Instance to an error state with a configurable error message.

Input Parameters

Parameter	Description	Type	Default
Error	The error message to display to the user.	String