Properties for individuals
Refer to the following list of properties for individuals and matching rules when creating branch elements.
Associated role
This is the role an associate holds in a company.
In the portal, you can see the Associate role field by going to a profile's product application. It's displayed in the Overall status section.
If the Associate role field is not present, the profile is not an associate and they are classified as None for the purposes of the matching rule.
Note
The API 4.0 field for Associate role is linked_to.roles. The API 3.5 field is applications.associated_role.
Matching rule | Behavior | Example |
Associate role is one of:
Note that you can select multiple associate roles. | If the profile holds any of the specified associate roles, the product application takes the Yes branch. | Associate role is one of Authorized person, Director:
|
Associate role is not one of:
Note that you can select multiple associate roles. | If the profile does not hold any of the specified associate roles, the product application takes the Yes branch. | Associate role is not one of Authorized person, Director:
|
Risk level
The risk level of the product application.
In the portal, you can see the risk level by going to a profile's Application risk scores.
The API field for the risk level is applications.risk.overall.level. To get a notification when a risk level changes, use the risk level changed webhook.
Matching rule | Behavior | Example |
Risk level is one of:
Note that you can select multiple risk levels. | If the product application has any of the specified risk levels, the product application takes the Yes branch. | Risk level is one of High, Medium:
|
Risk level is not one of:
Note that you can select multiple risk levels. | If the product application does not have any of the specified risk levels, the product application takes the Yes branch. | Risk level is not one of High, Medium:
|
Notice
This property is only available if you're using the Risk module. Contact us to learn more.
Risk score
The risk score of the product application.
In the portal, you can see the risk score by going to a profile's Application risk scores.
The API field for the risk score is applications.risk.overall.score.
Matching rule | Behavior | Example |
Risk score is less than: A number | If the product application's risk score is less than the specified number, the product application takes the Yes branch. | Risk score is less than 100:
|
Risk score is less than or equal to: A number | If the product application's risk score is less than or equal to the specified number, the product application takes the Yes branch. | Risk score is less than or equal to 100:
|
Risk score is greater than: A number | If the product application's risk score is greater than the specified number, the product application takes the Yes branch. | Risk score is greater than 0
|
Risk score is greater than or equal to: A number | If the product application's risk score is greater than or equal to the specified number, the product application takes the Yes branch. | Risk score is greater than or equal to 0:
|
Risk score is in the range: A number ≤ value ≤ A number | If the product application's risk score is within the specified range, including the start number and end number, the product application takes the Yes branch. | Risk score is in the range 0 ≤ value ≤ 100:
|
Risk score is in the range: A number < value < A number | If the product application's risk score is within the specified range, excluding the start number and end number, the product application takes the Yes branch. | Risk score is in the range 0 < value < 100:
|
Risk score is in the range: A number ≤ value < A number | If the product application's risk score is within the specified range, including the start number and excluding the end number, the product application takes the Yes branch. | Risk score is in the range 0 ≤ value < 100:
|
Risk score is in the range: A number < value ≤ A number | If the product application's risk score is within the specified range, excluding the start number and including the end number, the product application takes the Yes branch. | Risk score is in the range 0 < value ≤ 100:
|
Notice
This property is only available if you're using the Risk module. Contact us to learn more.
Age
The age of the individual.
The age is determined by taking the profile's Date of birth field and calculating the number of years between that date and today.
The profile's Date of birth is stored in their Profile data. The API field for Date of birth is collected_data.personal_details.dob.
Matching rule | Behavior | Example |
Age is less than:
| If the profile's age is less than the specified number, the product application takes the Yes branch. | Age is less than 25:
|
Age is less than or equal to:
| If the profile's age is less than or equal to the specified number, the product application takes the Yes branch. | Age is less than or equal to 25:
|
Age is greater than:
| If the profile's age is greater than the specified number, the product application takes the Yes branch. | Age is greater than 18:
|
Age is greater than or equal to:
| If the profile's age is greater than or equal to the specified number, the product application takes the Yes branch. | Age is greater than or equal to 18:
|
Age is in the range:
≤ value ≤
| If the profile's age is within the specified range, including the start number and end number, the product application takes the Yes branch. | Age is in the range 18 ≤ value ≤ 25:
|
Age is in the range:
< value <
| If the profile's age is within the specified range, excluding the start number and end number, the product application takes the Yes branch. | Age is in the range 18 < value < 25:
|
Age is in the range:
≤ value <
| If the profile's age is within the specified range, including the start number and excluding the end number, the product application takes the Yes branch. | Age is in the range 18 ≤ value < 25:
|
Age is in the range:
< value ≤
| If the profile's age is within the specified range, excluding the start number and including the end number, the product application takes the Yes branch. | Age is in the range 18 < value ≤ 25:
|
The email address of the individual.
The profile's Email address is stored in their Profile data.
The API field for Email address is collected_data.contact_details.email.
Matching rule | Behavior | Examples |
Email starts with:
(case insensitive) | If the profile's email address starts with the specified letters/numbers/symbols, the product application takes the Yes branch. Letter case does not need to match. | Email starts with alex (case insensitive): The product application follows the Yes branch if, for example, the profile has any of these email addresses: alex@forexo.com, alexa@aerialtraders.com, or ALEX@FOREXO.COM. It follows the No branch if, for example, the profile has darcy.alex@forexo.com. |
Email starts with:
(case sensitive) | If the profile's email address starts with the specified letters/numbers/symbols, the product application takes the Yes branch. Letter case must match exactly. | Email starts with alex (case sensitive):
|
Email ends with:
(case insensitive) | If the profile's email address ends with the specified letters/numbers/symbols, the product application takes the Yes branch. Letter case does not need to match. | Email ends with @forexo.com (case insensitive):
|
Email ends with:
(case sensitive) | If the profile's email address ends with the specified letters/numbers/symbols, the product application takes the Yes branch. Letter case must match exactly. | Ends with @forexo.com (case sensitive):
|
Email contains:
(case insensitive) | If the profile's email address contains the specified letters/numbers/symbols, the product application takes the Yes branch. Letter case does not need to match. | Email contains .com (case insensitive):
|
Email contains:
(case sensitive) | If the profile's email address contains the specified letters/numbers/symbols, the product application takes the Yes branch. Letter case must match exactly. | Email contains .com (case sensitive):
|
Email is equal to:
(case insensitive) | If the profile's email address matches the specified letters/numbers/symbols exactly, the product application takes the Yes branch. Letter case does not need to match. | Email is equal to alex@forexo.com (case insensitive):
|
Email is equal to:
(case sensitive) | If the profile's email address matches the specified letters/numbers/symbols exactly, the product application takes the Yes branch. Letter case must match exactly. | Email is equal to alex@forexo.com (case sensitive):
|
Is one of:
Note that each email address should be on a new line. | If the profile's email address matches any of the email addresses exactly, the product application takes the Yes branch. Letter case must match exactly. | Email is one of alex@forexo.com:
|
Is not one of:
Note that each email address should be on a new line. | If the profile's email address does not match any of the email addresses exactly, the product application takes the Yes branch. Letter case must match exactly. | Email is not one of alex@forexo.co.uk, ALEX@FOREXO.CO.UK:
|
Nationality
The nationality of the individual.
The profile's Nationality is stored in their Profile data.
The API field for Nationality is collected_data.personal_details.nationality.
Matching rule | Behavior | Example |
Nationality is one of:
Note that you can select multiple countries. | If the profile's country of nationality matches one of the specified countries, the product application takes the Yes branch. | Nationality is one of Canada, United States:
|
Nationality is not one of:
Note that you can select multiple countries. | If the profile's country of nationality does not match one of the specified countries, the product application takes the Yes branch. | Nationality is not one of No state:
|
Country of address
The country present in the individual's current address.
The profile's Address is stored in their Profile data.
The API field for Address is collected_data.address_history.
Matching rule | Behavior | Example |
Is one of:
Note that you can select multiple countries. | If the profile's current address has a country that matches one of the specified countries, the product application takes the Yes branch. | Is one of Canada, United States:
|
Is not one of:
Note that you can select multiple countries. | If the profile's current address has a country that does not match one of the specified countries, the product application takes the Yes branch. | Is not one of No state:
|
Screening matches
Any PEPs, sanctions, or adverse media matches the individual has.
The profile's risk screening matches are stored on their Assess PEPs and sanctions or Assess PEPs, sanctions, and adverse media task.
The API object for risk screening matches is events.
Matching rule | Behavior | Example |
One or more confirmed matches are:
Note that you can select multiple match types. | If the profile has any confirmed matches with the specified types, the product application takes the Yes branch. | One or more confirmed matches are PEP, Sanction:
Note that the product application will only follow a branch path when there are no potential matches left. |
One or more potential matches are:
Note that you can select multiple match types. | If the profile has any potential matches with the specified types, the product application takes the Yes branch. | One or more potential matches are PEP, Sanction:
|
Potential, confirmed, or ignored matches are:
Note that you can select multiple match types. | If the profile has any risk screening matches, ignored, potential, or confirmed, with the specified types, the product application takes the Yes branch. | Ignored matches, and potential or confirmed matches are PEP, Sanction:
|
If any additional screening matches are returned during ongoing monitoring, the product application returns to this branch point and is re-evaluated using the new matches.
Custom fields
You can add branch elements for any of your custom fields.
The matching rules you can use depend on the custom field's content type.