Branch elements
Updated 4 months ago
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 (e.g. Lives in North America?). The name is used so you can identify the purpose of the branch when you read your smart policy.
- Choose an application or profile property (e.g. Country of address). Properties are different for individuals and companies.
- Create a matching rule (e.g. Country of address is one of Canada, United States).
When an 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 above (Country of address is one of Canada, United States), any applications from individuals living in North America will follow the Yes branch of the path, and any applications from individuals living outside of North America will follow the No branch of the path.
If the application reaches a branch and the corresponding property does not exist on the profile or application (e.g. the individual's profile does not have a Country of address), the application remains at the branch element until the value is added. Once the value is added, the application resumes its path along the smart policy automatically.
Below 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 application. It's displayed above the Initial Application Date.
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.
linked_to.roles. The API 3.5 field is applications.associated_role.Matching rule | Behaviour | 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 application takes the Yes branch. | Associate role is one of Authorised person, Director The application follows the Yes branch when the individual is an authorised person or a director. It follows the No branch when the individual does not hold either of these roles. |
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 application takes the Yes branch. | Associate role is not one of Authorised person, Director The application follows the Yes branch when the individual is not an authorised person or a director. It follows the No branch when the individual holds either of these roles. |
Risk level
The risk level of the application.
In the portal, you can see the risk level by going to a profile's Application risk scores.
applications.risk.overall.level. To get a notification when a risk level changes, use the Risk level changed webhook.Matching rule | Behaviour | Example |
Risk level is one of:
Note that you can select multiple risk levels. | If the application has any of the specified risk levels, the application takes the Yes branch. | Risk level is one of High, Medium The application follows the Yes branch when the risk level is High or Medium. It follows the No branch when the risk level is Low. |
Risk level is not one of:
Note that you can select multiple risk levels. | If the application does not have any of the specified risk levels, the application takes the Yes branch. | Risk level is not one of High, Medium The application follows the Yes branch when the risk level is Low. It follows the No branch when the risk level is High or Medium. |
Risk score
The risk score of the application.
In the portal, you can see the risk score by going to a profile's Application risk scores.
applications.risk.overall.score.Matching rule | Behaviour | Example |
Risk score is less than:
| If the application's risk score is less than the specified number, the application takes the Yes branch. | Risk score is less than 100 The application follows the Yes branch when the risk score is 99 or less. It follows the No branch when the risk score is 100 or more. |
Risk score is less than or equal to:
| If the application's risk score is less than or equal to the specified number, the application takes the Yes branch. | Risk score is less than or equal to 100 The application follows the Yes branch when the risk score is 100 or less. It follows the No branch when the risk score is 101 or more. |
Risk score is greater than:
| If the application's risk score is greater than the specified number, the application takes the Yes branch. | Risk score is greater than 0 The application follows the Yes branch when the risk score is 1 or more. It follows the No branch when the risk score is 0 or less. |
Risk score is greater than or equal to:
| If the application's risk score is greater than or equal to the specified number, the application takes the Yes branch. | Risk score is greater than or equal to 0 The application follows the Yes branch when the risk score is 0 or more. It follows the No branch when the risk score is -1 or less. |
Risk score is in the range:
≤ value ≤
| If the application's risk score is within the specified range, including the start number and end number, the application takes the Yes branch. | Risk score is in the range 0 ≤ value ≤ 100 The application follows the Yes branch when it has a risk score of 0, 100, or anything in between. It follows the No branch when the risk score is -1 or less or 101 or more. |
Risk score is in the range:
< value <
| If the application's risk score is within the specified range, excluding the start number and end number, the application takes the Yes branch. | Risk score is in the range 0 < value < 100 The application follows the Yes branch when it has a risk score of 1, 99, or anything in between. It follows the No branch when the risk score is 0 or less or 100 or more. |
Risk score is in the range:
≤ value <
| If the application's risk score is within the specified range, including the start number and excluding the end number, the application takes the Yes branch. | Risk score is in the range 0 ≤ value < 100 The application follows the Yes branch when it has a risk score of 0, 99, or anything in between. It follows the No branch when the risk score is -1 or less or 100 or more. |
Risk score is in the range:
< value ≤
| If the application's risk score is within the specified range, excluding the start number and including the end number, the application takes the Yes branch. | Risk score is in the range 0 < value ≤ 100 The application follows the Yes branch when it has a risk score of 1, 100, or anything in between. It follows the No branch when the risk score is 0 or less or 101 or 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.
collected_data.personal_details.dob.Matching rule | Behaviour | Example |
Age is less than:
| If the profile's age is less than the specified number, the application takes the Yes branch. | Age is less than 25 The application follows the Yes branch when the individual is 24 or younger. It follows the No branch when the individual is 25 or older. |
Age is less than or equal to:
| If the profile's age is less than or equal to the specified number, the application takes the Yes branch. | Age is less than or equal to 25 The application follows the Yes branch when the individual is 25 or younger. It follows the No branch when the individual is 26 or older. |
Age is greater than:
| If the profile's age is greater than the specified number, the application takes the Yes branch. | Age is greater than 18 The application follows the Yes branch when the individual is 19 or older. It follows the No branch when the individual is 18 or younger. |
Age is greater than or equal to:
| If the profile's age is greater than or equal to the specified number, the application takes the Yes branch. | Age is greater than or equal to 18 The application follows the Yes branch when the individual is 18 or older. It follows the No branch when the individual is 17 or younger. |
Age is in the range:
≤ value ≤
| If the profile's age is within the specified range, including the start number and end number, the application takes the Yes branch. | Age is in the range 18 ≤ value ≤ 25 The application follows the Yes branch when the individual is 18, 25, or anything in between. It follows the No branch when the individual is 17 or younger or 26 or older. |
Age is in the range:
< value <
| If the profile's age is within the specified range, excluding the start number and end number, the application takes the Yes branch. | Age is in the range 18 < value < 25 The application follows the Yes branch when the individual is 19, 24, or anything in between. It follows the No branch when the individual is 18 or younger or 25 or older. |
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 application takes the Yes branch. | Age is in the range 18 ≤ value < 25 The application follows the Yes branch when the individual is 18, 24, or anything in between. It follows the No branch when the individual is 17 or younger or 25 or older. |
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 application takes the Yes branch. | Age is in the range 18 < value ≤ 25 The application follows the Yes branch when the individual is 19, 25, or anything in between. It follows the No branch when the individual is 18 or younger or 26 or older. |
The email address of the individual.
The profile's Email address is stored in their Profile data.
collected_data.contact_details.email.Matching rule | Behaviour | Examples |
Email starts with:
(case insensitive) | If the profile's email address starts with the specified letters/numbers/symbols, the application takes the Yes branch. Letter case does not need to match. | Email starts with alex (case insensitive) The 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 application takes the Yes branch. Letter case must match exactly. | Email starts with alex (case sensitive) The application follows the Yes branch if, for example, the profile has either of these email addresses: alex@forexo.com, alexa@aerialtraders.com. It follows the No branch if, for example, the profile has ALEX@FOREXO.COM. |
Email ends with:
(case insensitive) | If the profile's email address ends with the specified letters/numbers/symbols, the application takes the Yes branch. Letter case does not need to match. | Email ends with @forexo.com (case insensitive) The application follows the Yes branch if, for example, the profile has either of these email addresses: alex@forexo.com, ALEX@FOREXO.COM. It follows the No branch if, for example, the profile has alexa@aerialtraders.com. |
Email ends with:
(case sensitive) | If the profile's email address ends with the specified letters/numbers/symbols, the application takes the Yes branch. Letter case must match exactly. | Ends with @forexo.com (case sensitive) The application follows the Yes branch if, for example, the profile has alex@forexo.com. It follows the No branch if, for example, the profile has either of these email addresses: ALEX@FOREXO.COM, alexa@aerialtraders.com. |
Email contains:
(case insensitive) | If the profile's email address contains the specified letters/numbers/symbols, the application takes the Yes branch. Letter case does not need to match. | Email contains .com (case insensitive) The application follows the Yes branch if, for example, the profile has either of these email addresses: alex@forexo.com, ALEX@FOREXO.COM. It follows the No branch if, for example, the profile has alex@forexo.co.uk. |
Email contains:
(case sensitive) | If the profile's email address contains the specified letters/numbers/symbols, the application takes the Yes branch. Letter case must match exactly. | Email contains .com (case sensitive) The application follows the Yes branch if, for example, the profile has the email address alex@forexo.com. It follows the No branch if, for example, the profile has either of these email addresses: ALEX@FOREXO.COM, alex@forexo.co.uk. |
Email is equal to:
(case insensitive) | If the profile's email address matches the specified letters/numbers/symbols exactly, the application takes the Yes branch. Letter case does not need to match. | Email is equal to alex@forexo.com (case insensitive) The application follows the Yes branch if, for example, the profile has either of these email addresses: alex@forexo.com, ALEX@FOREXO.COM. It follows the No branch if, for example, the profile has alex.wheeler@forexo.com. |
Email is equal to:
(case sensitive) | If the profile's email address matches the specified letters/numbers/symbols exactly, the application takes the Yes branch. Letter case must match exactly. | Email is equal to alex@forexo.com (case sensitive) The application follows the Yes branch if, for example, the profile has the email address alex@forexo.com. It follows the No branch if, for example, the profile has either of these email addresses: ALEX@FOREXO.COM, alex.wheeler@forexo.com. |
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 application takes the Yes branch. Letter case must match exactly. | Email is one of alex@forexo.com The application follows the Yes branch if the profile has the email address alex@forexo.com. It follows the No branch if, for example, the profile has either of these email addresses: ALEX@FOREXO.COM, alex.wheeler@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 application takes the Yes branch. Letter case must match exactly. | Email is not one of alex@forexo.co.uk ALEX@FOREXO.CO.UK The application follows the Yes branch if the profile has either of these email addresses: alex@forexo.co.uk, ALEX@FOREXO.CO.UK. It follows the No branch if, for example, the profile has the email address alex@forexo.com. |
Nationality
The nationality of the individual.
The profile's Nationality is stored in their Profile data.
collected_data.personal_details.nationality.Matching rule | Behaviour | 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 application takes the Yes branch. | Nationality is one of Canada, United States The application follows the Yes branch when the individual is Canadian or American. It follows the No branch when the individual has another nationality or the individual's country of nationality is listed as No state. |
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 application takes the Yes branch. | Nationality is not one of No state The application follows the Yes branch when the profile has any country of nationality listed. It follows the No branch when the individual's country of nationality is listed as No state. |
Country of address
The country present in the individual's current address.
The profile's Address is stored in their Profile data.
collected_data.address_history.Matching rule | Behaviour | 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 application takes the Yes branch. | Is one of Canada, United States The application follows the Yes branch when the individual is currently living in Canada or the US. It follows the No branch when the individual is currently living in another country or the individual's country of address is listed as No state. |
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 application takes the Yes branch. | Is not one of No state The application follows the Yes branch when the profile has a current address with any country. It follows the No branch when the individual's address is listed as 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.
events.Matching rule | Behaviour | 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 application takes the Yes branch. | One or more confirmed matches are PEP, Sanction The 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 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 application takes the Yes branch. | One or more potential matches are PEP, Sanction The application follows the Yes branch when one or more potential PEPs or sanctions matches were returned. It follows the No branch when no potential PEPs or sanctions matches were returned. |
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 application takes the Yes branch. | Ignored matches, and potential or confirmed matches are PEP, Sanction The application follows the Yes branch when the profile has any PEP or sanctions matches. This happens whether the matches are potential, confirmed, or ignored. It follows the No branch if no potential or ignored PEP or sanctions matches were returned. |
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 application. It's displayed above the Initial Application Date.
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.
linked_to.roles. The API 3.5 field is applications.associated_role.Matching rule | Behaviour | Example |
Associate role is one of:
Note that you can select multiple associate roles. | If the profile holds any of the the specified roles, the application takes the Yes branch. | Associate role is one of Authorised person, Director The application follows the Yes branch when the company is an authorised person or a director. It follows the No branch when the company does not hold either of these roles. |
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 application takes the Yes branch. | Associate role is not one of Authorised person, Director The application follows the Yes branch when the company is not an authorised person or a director. It follows the No branch when the company holds either of these roles. |
Risk level
The risk level of the application.
In the portal, you can see the risk level by going to a profile's Application risk scores.
applications.risk.overall.level. To get a notification when a risk level changes, use the Risk level changed webhook.Matching rule | Behaviour | Example |
Risk level is one of:
Note that you can select multiple risk levels. | If the application has any of the specified risk levels, the application takes the Yes branch. | Risk level is one of High, Medium The application follows the Yes branch when the risk level is High or Medium. It follows the No branch when the risk level is Low. |
Risk level is not one of:
Note that you can select multiple risk levels. | If the application does not have any of the specified risk levels, the application takes the Yes branch. | Risk level is not one of High, Medium The application follows the Yes branch when the risk level is Low. It follows the No branch when the risk level is High or Medium. |
Risk score
The risk score of the application.
In the portal, you can see the risk score by going to a profile's Application risk scores.
applications.risk.overall.score.Matching rule | Behaviour | Example |
Risk score is less than:
| If the application's risk score is less than the specified number, the application takes the Yes branch. | Risk score is less than 100 The application follows the Yes branch when the risk score is 99 or less. It follows the No branch when the risk score is 100 or more. |
Risk score is less than or equal to:
| If the application's risk score is less than or equal to the specified number, the application takes the Yes branch. | Risk score is less than or equal to 100 The application follows the Yes branch when the risk score is 100 or less. It follows the No branch when the risk score is 101 or more. |
Risk score is greater than:
| If the application's risk score is greater than the specified number, the application takes the Yes branch. | Risk score is greater than 0 The application follows the Yes branch when the risk score is 1 or more. It follows the No branch when the risk score is 0 or less. |
Risk score is greater than or equal to:
| If the application's risk score is greater than or equal to the specified number, the application takes the Yes branch. | Risk score is greater than or equal to 0 The application follows the Yes branch when the risk score is 0 or more. It follows the No branch when the risk score is -1 or less. |
Risk score is in the range:
≤ value ≤
| If the application's risk score is within the specified range, including the start number and end number, the application takes the Yes branch. | Risk score is in the range 0 ≤ value ≤ 100 The application follows the Yes branch when it has a risk score of 0, 100, or anything in between. It follows the No branch when the risk score is -1 or less or 101 or more. |
Risk score is in the range:
< value <
| If the application's risk score is within the specified range, excluding the start number and end number, the application takes the Yes branch. | Risk score is in the range 0 < value < 100 The application follows the Yes branch when it has a risk score of 1, 99, or anything in between. It follows the No branch when the risk score is 0 or less or 100 or more. |
Risk score is in the range:
≤ value <
| If the application's risk score is within the specified range, including the start number and excluding the end number, the application takes the Yes branch. | Risk score is in the range 0 ≤ value < 100 The application follows the Yes branch when it has a risk score of 0, 99, or anything in between. It follows the No branch when the risk score is -1 or less or 100 or more. |
Risk score is in the range:
< value ≤
| If the application's risk score is within the specified range, excluding the start number and including the end number, the application takes the Yes branch. | Risk score is in the range 0 < value ≤ 100 The application follows the Yes branch when it has a risk score of 1, 100, or anything in between. It follows the No branch when the risk score is 0 or less or 101 or more. |
Company shares type
The type of company shares.
In the portal, the profile's Shares field is stored in Profile data.
collected_data.metadata.structured_company_type.is_public.Matching rule | Behaviour | Example |
Company share type is one of:
| If the profile's share type matches one of the specified types, the application takes the Yes branch. | Company share type is one of Publicly Traded The application follows the Yes branch when the company is public. It follows the No branch when the company is private. |
Company share type is not one of:
| If the profile's share type does not match one of the specified types, the application takes the Yes branch. | Company share type is not one of Publicly Traded The application follows the Yes branch when the company is private. It follows the No branch when the company is public. |
Company liability type
The type of company liability.
In the portal, the profile's Liability field is stored in Profile data.
collected_data.metadata.structured_company_type.is_limited.Matching rule | Behaviour | Example |
Company liability type is one of:
| If the company's liability type matches one of the specified types, the application takes the Yes branch. | Company liability type is one of Limited The application follows the Yes branch when the company has limited liability. It follows the No branch when the company has non limited liability. |
Company liability type is not one of:
| If the company's liability type does not match one of the specified types, the application takes the Yes branch. | Company liability type is not one of Limited The application follows the Yes branch when the company has non limited liability. It follows the No branch when the company has limited liability. |
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.
collected_data.metadata.structured_company_type.ownership_type.Matching rule | Behaviour | 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 application takes the Yes branch. | Company ownership type is one of Partnership, Association The application follows the Yes branch when the company's ownership type is a partnership or ownership. It follows the No branch when the company's ownership is of another type. |
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 application takes the Yes branch. | Company ownership type is not one of Other The application follows the Yes branch when the company's ownership type is a partnership, company, sole proprietorship, association, or trust. It follows the No branch when the company's ownership type is listed as 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.
collected_data.metadata.addresses.Matching rule | Behaviour | 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 application takes the Yes branch. | Is one of Canada, United States The application follows the Yes branch when the company is currently registered in Canada or the US. It follows the No branch when the company is currently registered in another country or the country of the company's registered address is listed as No state. |
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 application takes the Yes branch. | Is not one of No state The application follows the Yes branch when the profile has a current address with any country. It follows the No branch when the individual's address is listed as 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.
collected_data.metadata.country_of_incorporation.Matching rule | Behaviour | 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 application takes the Yes branch. | Is one of Canada, United States The application follows the Yes branch when the company was incorporated in Canada or the US. It follows the No branch when the company was incorporated in another country or the country of incorporation is listed as No state. |
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 application takes the Yes branch. | Is not one of No state The application follows the Yes branch when the company was incorporated in any country. It follows the No branch when the company's country of incorporation is listed as 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.
collected_data.metadata.incorporation_date.Matching rule | Behaviour | Example |
Years since incorporation is less than:
| If the profile's years since incorporation are less than the specified number, the application takes the Yes branch. | Years since incorporation is less than 25 The application follows the Yes branch when the company has been incorporated for 24 years or less. It follows the No branch when the company has been incorporated for 25 years or more. |
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 application takes the Yes branch. | Years since incorporation is less than or equal to 25 The application follows the Yes branch when the company has been incorporated for 25 years or less. It follows the No branch when the company has been incorporated for 26 years or more. |
Years since incorporation is greater than:
| If the profile's years since incorporation are greater than the specified number, the application takes the Yes branch. | Years since incorporation is greater than 5 The application follows the Yes branch when the company has been incorporated for 6 years or more. It follows the No branch when the company has been incorporated for 5 years or less. |
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 application takes the Yes branch. | Years since incorporation is greater than or equal to 5 The application follows the Yes branch when the company has been incorporated for 5 years or more. It follows the No branch when the company has been incorporated for 4 years or less. |
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 application takes the Yes branch. | Years since incorporation is in the range 5 ≤ value ≤ 25 The application follows the Yes branch when the years since incorporation is 5, 25, or anything in between. It follows the No branch when the years since incorporation is 4 or less or 26 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 end number, the application takes the Yes branch. | Years since incorporation is in the range 5 < value < 25 The application follows the Yes branch when the years since incorporation is 6, 24, or anything in between. It follows the No branch when the years since incorporation is 5 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, including the start number and excluding the end number, the application takes the Yes branch. | Years since incorporation is in the range 5 ≤ value < 25 The 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 application takes the Yes branch. | Years since incorporation is in the range 5 < value ≤ 25 The application follows the Yes branch when the years since incorporation is 6, 25, or anything in between. It follows the No branch when the years since incorporation is 5 or less or 26 or more. |
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.
events.Matching rule | Behaviour | 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 application takes the Yes branch. | One or more confirmed matches are PEP, Sanction The 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 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 application takes the Yes branch. | One or more potential matches are PEP, Sanction The application follows the Yes branch when one or more potential PEPs or sanctions matches were returned. It follows the No branch when no potential PEPs or sanctions matches were returned. |
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 application takes the Yes branch. | Ignored matches, and potential or confirmed matches are PEP, Sanction The application follows the Yes branch when the profile has any PEP or sanctions matches. This happens whether the matches are potential, confirmed, or ignored. It follows the No branch if no potential or ignored PEP or sanctions matches were returned. |
Tax codes
The ID the company uses for their tax code.
In the portal, the profile's Tax ID is stored in Profile data.
collected_data.metadata.tax_ids.value.Matching rule | Behaviour | 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 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 application takes the No branch. The letter case must match exactly. | Tax codes is equal to GB462793578 GB462793579 The application follows the Yes branch if the profile has both of these tax IDs: GB462793578 and GB462793579. It follows the No branch if, for example, the profile has all of these tax IDs: GB462793577 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 application takes the Yes branch. If the profile has any additional tax IDs not specified, the application takes the Yes branch. The letter case must match exactly. | Tax codes includes all of GB462793578 GB462793579 The application follows the Yes branch if the profile has all of these tax IDs: GB462793577, GB462793578, GB462793579. It follows the No branch if, for example, the profile has only this tax ID: GB462793578. |
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 application takes the Yes branch. The letter case must match exactly. | Tax codes includes any of GB462793578 GB462793579 The application follows the Yes branch if the profile has either of these tax IDs: GB462793578 or GB462793579. It follows the No branch if, for example, the profile only has this tax ID: GB462793577. |
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 application takes the Yes branch. The letter case must match exactly. | Tax codes excludes all of GB462793578 GB462793579 The application follows the Yes branch if the profile only has the GB462793578 tax ID, only has the GB462793579 tax ID, or doesn't have either tax ID. It follows the No branch if it has both of these tax IDs: GB462793578 and 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 application takes the Yes branch. The letter case must match exactly. | Tax codes excludes any of GB462793578 GB462793579 The application follows the Yes branch if the profile does not have the GB462793578 tax ID or the GB462793579 tax ID. It follows the No branch if it has either of these tax IDs: 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.
