With Custom lists it is possible to list names, bank accounts, countries and other information and us it in Monitoring scenarios or Risk rules.
How does setting up a Custom list look like
Client creates a list
Client defines schema of the list
Client defines usable monitoring and/or risk fields in the list
Client writes/enables desired scenarios/rules
Client adds records to the list
Client starts using Custom list
š Step 5 can be started after step 2, i.e. you can already start uploading records right after schema has been defined.
Step 1: Creating a list
Custom lists feature enables the system to screen and monitor persons and transactions against customisable multiple lists. Custom lists can be found in Analyst Toolbox ā Custom lists.
To add a new Custom list, click on a ā+ New listā.
Every new list must contain List name, Description and Code.
List name helps to separate one list from others.
Description provides more detailed information about certain list.
Code helps to reference list in monitoring scenarios or clearance rules (Custom list Code can contain letters, numbers and underscores).
Once List name, Description and Code are typed in click on āAddā and Custom list will be created.
When Custom list is added it will be visible in Custom lists table.
Step 2: Defining listās schema
Once a list is created and general information is inputted, fields can be added (ā List settings ā Fields in the list).
These fields have three functions:
They define the schema used when adding list records
Data you upload is validated against the schema (e.g. text cannot be uploaded, when a field is defined as NUMBERS type)
They are used for defining usable fields, which can be later used either in monitoring or screening
āļø Existing schema can only be partially edited (Display name and Visibility boxes can be reconfigured) once Usable fields are defined or when first records are added, so make sure schema is defined correctly before. New fields can be added, but fields can only be removed from empty Custom lists.
Adding fields
Write down Display name (descriptive name for a field, for example, First name, Date of birth, etc.)
Indicate Field name (name of the attribute, for example,
first_name,dob,address, etc.)We highly recommend you follow Salvās recommended field naming conventions as this will help to maintain your clearance rules better in the future. For example, date of birth should always be
dob, in case of name try to split names intofirst_nameandlast_name. The list of recommended field names can be found here: person fields and transaction fields.
Select Input type from the dropdown menu. There are five input types you can choose from: STRING, DATE, NUMBER, OBJECT and ENUM.
When OBJECT type is selected, multiple nested fields can be defined, for example, when adding
Addressfield,country,street_addressorpostal_codecan be added as 1 level JSON attribute. Display name, field name and input type (STRING, NUMBER or DATE) have to be defined for OBJECT fields.
Values of these fields are shown under Address field in the list view (comma separated) and in matches.
When ENUM type is selected, multiple (at least 2) dropdown options can be defined. When āMultiple valuesā is selected, multiple values from the dropdown can be selected when creating a record.
You can select whether you want to make this field visible in matches or in the list.
In matches - when selected, field name and value will be shown in matches information when an alert is generated.
In list - when selected, field column will be shown in the list view. In the example below, First name field is selected not be shown in the list view.
Toggling Multiple values on allows adding several values for the same data field, which are then saved as an array, for example - adding several bank account numbers.
You can define which Schema fields are required and which are optional. A record cannot be saved if a required field is not filed.
Step 3: Defining usable fields
When at least one schema field is added you are all set to add usable fields. Usable fields allow you to reference Custom list values in screening and monitoring. Configuring usable fields for screening and monitoring is done separately.
These fields can be used in monitoring scenarios.
When adding a usable monitoring field you have to define following properties:
Name - a human readable name.
Code - must be unique per list. Can contain letters, numbers and underscores. Can be referenced when writing scenarios.
Field(s) - that can be later used in monitoring scenarios, for example
first_name last_nameorbank_accounts[].You have to explicitly specify which list fields nested in the OBJECT field you would like to use, e.g
addressby itself is not a valid Usable field, butaddress.streetis.Multiple list fields can be selected per one Usable field when needed, e.g.
first_name last_name,sort_code account_number, etc. Creating a Usable field with multiple list fields has following restrictions:List fields defined to have Multiple values can not be combined with any other list field, e.g
bank_accounts[]can not be combined with any other list fieldYou can combine all list fields that are not nested inside an OBJECT field, e.g
first_namelast_namecan be combined with each otherYou can combine all list fields that are nested inside a single OBJECT field, e.g
shareholders[].first_nameshareholders[].last_namecan be combined with each other
ā If your Usable field comprises of multiple Custom list Fields then the value in the value column is delimited by spaces. E.g if your Usable field is first_name last_name, then an extracted value in the value column would be John Doe.
Additional data - selected Custom list schema data can be included in scenarios and rules alongside the main field as an additional condition, or shown in Alert details to give Analysts more context.
For OBJECT fields only the parent field name can be selected (e.g.
address), however, child fields (e.g.address.street) can be used in Scenarios and Rules as additional data.
Example field:
Values from Custom list are put into special table called custom_list_value. Most important columns over there are:
list_code- code defined by you, with a prefix of#LIST-field_code- code defined by you, with a prefix of#LIST-LIST_CODE-value- Value extracted from a Custom list recordadditional_data- additional data values extracted from a Custom list record
You can write scenarios against this table like this:
WHERE custom_list_value.list_code = '#LIST-EXCLUSION_LIST'
AND custom_list_value.field_code = '#LIST-EXCLUSION_LIST-ACCOUNTS'
AND transaction.sender_account = custom_list_value.value
additional_data opens up options, for example, to enrich Alert information, so the Agent has more context. In the following example, matching happens on the account number. In the Alert context, the Agent sees the account number as well as the name of the Person behind this account number in the Custom list and the reason for being in this particular Custom list:
select true
,new.sender_account
,custom_list_value.additional_data->>'name' as customer_name
,custom_list_value.additional_data->>'reason' as reason
from transaction new
join custom_list_value on new.customer_id = custom_list_value.organisation_id
where new.id = $transactionId
and custom_list_value.organisation_id = $organisationId
and custom_list_value.list_code = '#LIST-EXCLUSION_LIST'
and custom_list_value.field_code = '#LIST-EXCLUSION_LIST-ACCOUNTS'
and new.sender_account = custom_list_value.value
Step 5: Adding records
5.1 Adding record through UI
To add a new record first select the Custom list and then click ā + New recordā.
Add new record tab corresponds to schema setup in live environment. Once information is added a new record can be saved.
5.2 Adding records through API
New records to the Custom list can be added via API, however before sending data about new records via API, Schema and Usable fields should be already in place. More technical information on how to add a record via API can be found here.
5.3 Adding records using a CSV file
List records can also be batch uploaded using CSV files by users with CUSTOMER_ADMIN an ANALYST roles, the upload is done through the UI, the upload is done through the UI (Data upload ā selecting āCustom list recordā for the file that is being uploaded).
Currently there is one mandatory data field - list_code.
More information about adding Custom list records through UI using a CSV file can be found here.