Branch elements
In smart policies, the branch element is used to split the policy path into a Yes branch and a No branch.
When you create the branch element:
Give it any name you like, for example Lives in North America?. The name is used so you can identify the purpose of the branch when you read your smart policy.
Choose a product application or profile property, for example, Country of address. Properties are different for individuals and companies.
Create a matching rule, for example, Country of address is one of Canada, United States.
When a product application reaches the branch element, it follows the Yes branch of the path if it matches the rule and the No branch if it doesn't.
Taking the example Country of address is one of Canada, United States, any product applications from individuals living in North America will follow the Yes branch of the path, and any product applications from individuals living outside of North America will follow the No branch of the path.
If the product application reaches a branch and the corresponding property does not exist on the profile or product application, for example, the individual's profile does not have a Country of address, the product application remains at the branch element until the value is added. Once the value is added, the product application resumes its path along the smart policy automatically.
If a product application goes into a Requires data state when it reaches a branch element, any tasks added to the product application previously will remain on the product application.
Product applications never go into the Requires data state when they reach branch elements for the Associated role. This is because if the profile does not have an associate role, it's classified as None for the matching rule. To learn more, see associated role for individuals and the associated role for companies.
What follows is a list of the properties available for individuals and companies, along with the matching rules you can use for each one.
Properties for individuals
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 asses 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.
Properties for companies
Associated role
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.
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 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 roles, the product application takes the Yes branch. | Associate role is not one of Authorized person, Director:
|
If the profile does not have any associate roles, it's classified as None for the matching rule.
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:
|
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:
| If the product application's risk score is less than the specified number, the application takes the Yes branch. | Risk score is less than 100:
|
Risk score is less than or equal to:
| 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:
| 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:
| 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:
≤ value ≤
| 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:
< value <
| 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:
≤ value <
| 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:
< value ≤
| 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:
|
This property is only available if you're using the Risk module. Contact us to learn more.
Company shares type
The type of company shares.
In the portal, the profile's Shares field is stored in Profile data.
The API field for Shares is collected_data.metadata.structured_company_type.is_public.
Matching rule | Behavior | Example |
Company share type is one of:
| If the profile's share type matches one of the specified types, the product application takes the Yes branch. | Company share type is one of Publicly Traded:
|
Company share type is not one of:
| If the profile's share type does not match one of the specified types, the product application takes the Yes branch. | Company share type is not one of Publicly Traded:
|
Warning
While it is possible to select both share types for the matching rule, this is not recommended because it creates a situation where product applications never follow the No branch.
Company liability type
The type of company liability.
In the portal, the profile's Liability field is stored in Profile data.
The API field for Liability is collected_data.metadata.structured_company_type.is_limited.
Matching rule | Behavior | Example |
Company liability type is one of:
| If the company's liability type matches one of the specified types, the product application takes the Yes branch. | Company liability type is one of Limited:
|
Company liability type is not one of:
| If the company's liability type does not match one of the specified types, the product application takes the Yes branch. | Company liability type is not one of Limited:
|
Warning
While it is possible to select both liability types for the matching rule, this is not recommended because it creates a situation where product applications never follow the No branch.
Company ownership type
The type of company ownership.
In the portal, the company ownership information is stored in the Entity Type field on the profile's Profile data.
The API field for Entity Type is collected_data.metadata.structured_company_type.ownership_type.
Matching rule | Behavior | Example |
Company ownership type is one of:
Note that you can add multiple ownership types to the rule. | If the profile's ownership type matches one of the specified types, the product application takes the Yes branch. | Company ownership type is one of Partnership, Association:
|
Company ownership type is not one of:
Note that you can add multiple ownership types to the rule. | If the profile's ownership type does not match one of the specified types, the product application takes the Yes branch. | Company ownership type is not one of Other:
|
Country of registry address
The country present in the company's current registered address.
The profile's Registered address is stored in their Profile data.
The API field for Registered address is collected_data.metadata.addresses.
Matching rule | Behavior | Example |
Is one of:
Note that you can select multiple countries. | If the profile's current registered 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 registered 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:
|
Country of incorporation
The country in which the company is incorporated.
In the portal, the profile's Country of incorporation is stored in Profile data.
The API field for Country of incorporation is collected_data.metadata.country_of_incorporation.
Matching rule | Behavior | Example |
Is one of:
Note that you can select multiple countries. | If the profile's current country of incorporation 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 country of incorporation does not match one of the specified countries, the product application takes the Yes branch. | Is not one of No state:
|
Years since incorporation
The number of years since the company was incorporated.
Years since incorporation is determined by taking the profile's Incorporation date and calculating the number of years between that date and today.
In the portal, the profile's Incorporation date is stored in Profile data.
The API field for Incorporation date is collected_data.metadata.incorporation_date.
Matching rule | Behavior | Example |
Years since incorporation is less than:
| If the profile's years since incorporation are less than the specified number, the product application takes the Yes branch. | Years since incorporation is less than 25:
|
Years since incorporation is less than or equal to:
| If the profile's years since incorporation are less than or equal to the specified number, the product application takes the Yes branch. | Years since incorporation is less than or equal to 25:
|
Years since incorporation is greater than:
| If the profile's years since incorporation are greater than the specified number, the product application takes the Yes branch. | Years since incorporation is greater than 5:
|
Years since incorporation is greater than or equal to:
| If the profile's years since incorporation are greater than or equal to the specified number, the product application takes the Yes branch. | Years since incorporation is greater than or equal to 5:
|
Years since incorporation is in the range:
≤ value ≤
| If the profile's years since incorporation is within the specified range, including the start number and end number, the product application takes the Yes branch. | Years since incorporation is in the range 5 ≤ value ≤ 25:
|
Years since incorporation is in the range:
< value <
| If the profile's years since incorporation is within the specified range, excluding the start number and end number, the product application takes the Yes branch. | Years since incorporation is in the range 5 < value < 25:
|
Years since incorporation is in the range:
≤ value <
| If the profile's years since incorporation is within the specified range, including the start number and excluding the end number, the product application takes the Yes branch. | Years since incorporation is in the range 5 ≤ value < 25: The product application follows the Yes branch when the years since incorporation is 5, 24, or anything in between. It follows the No branch when the years since incorporation is 4 or less or 25 or more. |
Years since incorporation is in the range:
< value ≤
| If the profile's years since incorporation is within the specified range, excluding the start number and including the end number, the product application takes the Yes branch. | Years since incorporation is in the range 5 < value ≤ 25:
|
Screening matches
Any PEPs, sanctions, or adverse media matches the company has.
The profile's risk screening matches are stored on their Assess sanctions or Assess 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, theproduct application takes the Yes branch. | One or more confirmed matches are PEP, Sanction: The product application follows the Yes branch when at least one potential PEP or sanctions match has been confirmed. It follows the No branch when no potential PEPs or sanctions matches were returned, or when any returned PEPs and sanction matches were ignored. 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.
Tax codes
The ID the company uses for their tax code.
In the portal, the profile's Tax ID is stored in Profile data.
The Tax ID type, for example, VAT, is not used. The API field for Tax ID is collected_data.metadata.tax_ids.value.
Matching rule | Behavior | Example |
Tax codes is equal to:
Note that each tax ID should be on a new line. | If the profile's tax ID(s) matches the specified tax ID(s) exactly, the product application takes the Yes branch. If the profile does not have one of the specified tax IDs or has any additional tax IDs that are not specified, the product application takes the No branch. The letter case must match exactly. | Tax codes is equal to: GB462793578 GB462793579
|
Tax codes includes all of:
Note that each tax ID should be on a new line. | If the profile's tax ID(s) includes all of the specified tax ID(s) exactly, the product application takes the Yes branch. If the profile has any additional tax IDs not specified, the product application takes the Yes branch. The letter case must match exactly. | Tax codes includes all of: GB462793578 GB462793579
|
Tax codes includes any of:
Note that each tax ID should be on a new line. | If the profile's tax ID(s) includes any of the specified tax ID(s) exactly, the product application takes the Yes branch. The letter case must match exactly. | Tax codes includes any of: GB462793578 GB462793579
|
Tax codes excludes all of:
Note that each tax ID should be on a new line. | If the profile's tax ID(s) excludes all of the specified tax ID(s), the product application takes the Yes branch. The letter case must match exactly. | Tax codes excludes all of: GB462793578 GB462793579
|
Tax codes excludes any of:
Note that each tax ID should be on a new line. | If the profile's tax ID(s) excludes any of the specified tax ID(s), the product application takes the Yes branch. The letter case must match exactly. | Tax codes excludes any of: GB462793578 GB462793579
|
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.