TrustX Watchlists enables the capture and storing of the Daon Face v6 images. Adding and utilizing Face v6 Watchlists provide the following security benefits:
- Adding confirmed fraudsters to watchlist
- Flagging suspicious identities discovered during review
- Recording declined applications
- Building custom risk databases
- Creating allowlists for expedited processing
Creating a FaceV6 Watchlist
A FaceV6 Watchlist stores a list of Persons of Interest by face image. To create a Face v6 Watchlist, follow the steps below.
- Log in to the Backoffice application and select Watchlists from the left-side vertical menu.
- From the Watchlists landing page, ensure that 'New Management' is selected and click the 'New Watchlist' button.
- Set the name of the Watchlist and set the Type to 'Face v6'.
- Click the 'Save' button to save the new Watchlist.
Add Watchlist Entry
A Face v6 Watchlist entry can be added in various methods. This section will cover each potential method.
Add Watchlist Entry via Backoffice
- Navigate to the Watchlists page in the Backoffice application.
- Find the name of the Face v6 Watchlist that will be updated.
- Click the 'Manage Entries' button to open a list of entries currently within the Watchlist.
- Click the 'Add New Entry' button. A pop-up modal will appear where details about the new Watchlist entry can be defined.
- Each new entry can contain the following information:
| Field Name | Type | Description |
|---|---|---|
| Face Image | .jpeg/.png/.svg/.gif | The face image to add to the Watchlist. Max file size is 5MB and max image resolution is 1080p. |
| First Name | String | The first name of the Person of Interest. |
| Last Name | String | The last name of the Person of Interest. |
| String | An optional email address associated with the Person of Interest (max 255 chars). | |
| Phone number | String | An optional phone number associated with the Person of Interest (max 255 chars). |
| Expiry Date | Date-Time | ISO 8601 duration after which the entry will be automatically deleted (e.g., PT1H, P1D). Converted to UTC timestamp by the activity. |
| Additional Parameters | [key, value] | A list of additional parameters associated with the Person of Interest. |
- Once all fields are finalized, click the 'Create Entry' button to save the new Watchlist member.
Add Watchlist Entry via Process Definition
A Watchlist member can also be added from a Process Definition using the face capture activities and 'Add FaceV6 Watchlist Entry v1'.
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 - Capture a Face Image
- After the 'Start' event, add a 'Capture Face Image' activity to the Process Designer and use the 'Global connect tool' to connect the activity to the flow.
Step 3 - Add a FaceV6 to a Watchlist
- From the Process Designer, add an 'Add FaceV6 Watchlist Entry v1' activity. Connect the activity to the 'Capture Face Image' activity.
- This activity includes the following input parameters:
| Parameter | Description | Type | Default |
|---|---|---|---|
| The email address associated with the POI. By default, this will be set to the email address of the Process Token email parameter. | String | ${_initVars.params.email} | |
| Expire After | When the POI will expire and be removed from the Watchlist. | String | |
| External ID | String | ${_initVars.params.externalId} | |
| Face Key | String | ||
| First Name | The first name of the POI. By default, this will be set as the Process Token first name parameter. | String | ${_initVars.params.firstName} |
| Full Name | The full name of the POI. | String | |
| Last Name | The last name of the POI. By default, this will be set as the Process Token last name parameter. | String | ${_initVars.params.lastName} |
| Phone Number | The phone number of the POI. By default, this will be set as the Process Token phone number parameter. | String | ${_initVars.params.phoneNumber} |
| Store Face Image | If enabled, the captured face image will be stored in TrustX. | String | ${true} |
| Watchlist Name | String |
- The activity will identify the face image using the 'Face Key' parameter. This should match the identifier used in the 'Capture Face Image' activity.
- By default, the 'First Name', 'Last Name' and 'Phone Number' parameters are set to accept the values defined by in the Process Token parameters.
Step 4 - Test the Process Definition
This section will describe how to test the Process Definition created above by generating a Process Token. After completing the flow, results of the Process Instance can be viewed from the Process Instances page.
- To test the Process Definition, create a new Process Token by navigating to the Process Definitions > Process Tokens page.
- Click the 'New Process Token' button found on the top-right of the page to start creating a new token. A popup modal will appear where details of the token can be entered.
- Once the token is created, scan the QR code or follow the link to begin the flow. The face image and details about the POI will be recorded and added to the Watchlist.
- Watchlist entries can be viewed by navigating to the Watchlists > Watchlist > Manage Entries page in the Backoffice.
- Selecting the magnifying glass under the 'Actions' column will provide more information in a popup modal.
Add a Watchlist Entry via TrustX API
To add a Watchlist entry via the TrustX API, the following tenant permissions are required:
Permissions:
The following query adds a new entry to the watchlist. The entry type must match the Watchlist type.
Example Request:
POST https://{{tenant}}.{{region}}.trustx.com/api/watchlist-manager/watchlists/{watchlistId}/entriesContent-Type: application/jsonAuthorization: Bearer {{token}}{ "type": "facev6", "note": "Flagged for review", "expireAtDtm": "2024-02-15T10:30:00Z", "value": "{file}", "template": "{file}", "userId": "user_12345", "storeSamples": true, "fullName": "John Doe", "firstName": "John", "lastName": "Doe", "extId": "ext_12345", "phoneNumber": "+1234567890", "email": "john.doe@example.com", "attributes": {}}Searching a FaceV6 Watchlist
Multiple methods can be used to search for a Watchlist match against a face image such as the TrustX API, Backoffice application, or via a Process Definition. This section will describe how to perform a Watchlist search using each of the listed methods and how to react to search results.
Searching via Backoffice
It is possible to search for a Watchlist match using the Backoffice 'Test Watchlist' functionality. As the name suggests, this method is primarily intended for testing purposes.
- Navigate to the Watchlists page in the Backoffice.
- Find the Watchlist to be tested using the search functionality provided.
- Under the 'Actions' column. select the 'Test' icon.
- The test page provides a drag and drop field where a face image can be uploaded to test against the watchlist. The match threshold and the number of candidates to return can be set using the filter options provided.
- If a match is found, the results will be displayed in the table below with the result "Match (Detected)".
It is not possible to action on search results returned. This functionality is intended for testing purposes only.
Searching via Process Definition
The 'Search FaceV6 Watchlist v1' activity can be used to search for a matching face image during a Process Instance. This section will describe how to configure a Process Definition that captures a face image before performing a search against a Face V6 Watchlist.
Step 1 - Configure the Process Definition
This process follows steps 1 and 2 of the Add Watchlist Entry via Process Definition flow where the 'Capture Face Image' activity is used to capture the face image that will be used for testing.
- Follow the steps outlined in the section above by creating a 'Start' and 'End' event connected to a 'Capture Face Image activity in a new Process Definition.
Step 2 - Perform Search Against Watchlist
- Add a 'Search FaceV6 Watchlist v1' activity to the Process Designer and connect it to the 'Capture Face Image V2' activity using the 'Global connect tool'.
- The 'Search FaceV6 Watchlist v1' activity includes the following input parameters:
| Parameter | Description | Type | Default |
|---|---|---|---|
| Face Key | String | ||
| Match Threshold (Score) | Double | ${0.205245} | |
| Max Match Results | Integer | ${10} | |
| Search Behavior | String | BLOCK | |
| Search Key | String | watchlistSearch1 | |
| Watchlist Name | String |
- The 'Search Behavior' property controls how the activity will response to matches.
| Value | Match Found | No Match | Use Case |
|---|---|---|---|
BLOCK | outcome = FAIL | outcome = PASS | Blocklist: Fail the check if the face is found on the watchlist |
ALLOW | outcome = PASS | outcome = FAIL | Allowlist: Pass only if the face is found on the watchlist |
BLOCK_REVIEW | outcome = REVIEW | outcome = PASS | Blocklist with Review: Send to review if found, otherwise pass |
ALLOW_REVIEW | outcome = REVIEW | outcome = FAIL | Allowlist with Review: Send to review if found (match needs human verification), otherwise deny (not on allowlist) |
- By default, the activity will identify the face image using the 'Face Key' parameter. This should match the identifier used in the 'Capture Face Image' activity.
- Results of the search will be stored in the _checks table and can be viewed from the Backoffice application or retrieved using the TrustX API.
Searching via API
The following query searches a watchlist for matches against the provided query. The query type must match the watchlist type. Returns matching entries with scores and metadata.
To search a Watchlist entry via the TrustX API, the following tenant permissions are required.
Permissions:
Example Request:
POST https://{{tenant}}.{{region}}.trustx.com/api/watchlist-manager/watchlists/{watchlistId}/queriesContent-Type: application/jsonAuthorization: Bearer {{token}}{ "type": "facev6", "value": "{string - Face image to search for (base64 in JSON)}", "template": "{string - Face template to search for (base64 in JSON)}", "matchThreshold": 0.205245, "maxMatchResultsPerQuery": 10}Example Response:
{ "type": "facev6", "matchThreshold": 0.205245, "maxMatchResults": 10, "queries": [ { "query": "searchValue", "matches": [ { "entryId": "01HZ123456789ABCDEFGHIJKLMN", "score": 0.95, "_links": { "entry": { "href": "/tenants/{tenantId}/watchlists/{watchlistId}/entries/{entryId}" } } } ] } ]}Viewing Results
The results of a Watchlist search attempt can be found in the Backoffice application or retrieved using the TrustX API. This section will describe how to retrieve the results of a search in both cases.
Viewing Results in the Backoffice
To find the results of the Watchlist search in the Backoffice application, follow the steps outlined:
- Log in to the Backoffice and navigate to the Process Instances page.
- Using the search filters provided, find the Process Instance where Watchlist searching was performed.
- Watchlist search results can be found in the
_checkstable, displayed in the Backoffice under the Checks section.
- A list of Watchlist search results can be found in the Watchlist Search Results section.
Example No Match Detected:
Example Match Detected:
The table of results include the following information:
- Query Item - Displays the captured face image used to perform the search query.
- Match - The name of the POI matched against within the Watchlist.
- Result - The result of the Watchlist search.
- Actions - In the event of a match, enables users to see additional details about the Watchlist entry that the face image was matched against.
Using the blue 'tracking' button under the 'Query Item' column, it is possible to add the Face v6 entry directly to a Watchlist. Selecting this button will open a popup modal where the face can be added.
