Branch elements

Branches are only used in the new smart policies.

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:

  1. 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.
  2. Choose an application or profile property (e.g. Country of address). Properties are different for smart policies for individuals and companies.
  3. 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.

If an application goes into a Requires data state when it reaches a branch element, any tasks added to the application previously remain on the application.
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 the Associated role for individuals and the Associated role for companies.

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.

The API 4.0 field for Associate role is linked_to.roles. The API 3.5 field is applications.associated_role.

Matching rule

Behaviour

Example

Associate role is one of:

  • Authorised person
  • Director
  • Company secretary
  • Shareholder
  • Partner
  • Trustee
  • Beneficial owner
  • Other
  • None

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:

  • Authorised person
  • Director
  • Company secretary
  • Shareholder
  • Partner
  • Trustee
  • Beneficial owner
  • Other
  • None

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.

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

Behaviour

Example

Risk level is one of:

  • Low
  • Medium
  • High

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:

  • Low
  • Medium
  • High

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.

This property is only available if you're using the Risk module. Contact us to learn more.

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.

The API field for the risk score is applications.risk.overall.score.

Matching rule

Behaviour

Example

Risk score is less than:

  • A number

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:

  • A number

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:

  • A number

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:

  • A number

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:

  • A number

value

  • A number

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:

  • A number

<

value

<

  • A number

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:

  • A number

value

<

  • A number

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:

  • A number

<

value

  • A number

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.

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

Behaviour

Example

Age is less than:

  • A number

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:

  • A number

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:

  • A number

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:

  • A number

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:

  • A number

value

  • A number

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:

  • A number

<

value

<

  • A number

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:

  • A number

value

<

  • A number

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:

  • A number

<

value

  • A number

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.

Email

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

Behaviour

Examples

Email starts with:

  • Any combination of letters, numbers, and symbols

(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:

  • Any combination of letters, numbers, and symbols

(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:

  • Any combination of letters, numbers, and symbols

(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:

  • Any combination of letters, numbers, and symbols

(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:

  • Any combination of letters, numbers, and symbols

(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:

  • Any combination of letters, numbers, and symbols

(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:

  • Any combination of letters, numbers, and symbols

(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:

  • Any combination of letters, numbers, and symbols

(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:

  • Any number of email addresses

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:

  • Any number of email addresses

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.

The API field for Nationality is collected_data.personal_details.nationality.

Matching rule

Behaviour

Example

Nationality is one of:

  • Any country (e.g. Aruba, Afghanistan, Angola, etc)
  • No state

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:

  • Any country (e.g. Aruba, Afghanistan, Angola, etc)
  • No state

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.

The API field for Address is collected_data.address_history.

Matching rule

Behaviour

Example

Is one of:

  • Any country (e.g. Aruba, Afghanistan, Angola, etc)
  • No state

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:

  • Any country (e.g. Aruba, Afghanistan, Angola, etc)
  • No state

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.

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.

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.

The API 4.0 field for Associate role is linked_to.roles. The API 3.5 field is applications.associated_role.

Matching rule

Behaviour

Example

Associate role is one of:

  • Authorised person
  • Director
  • Company secretary
  • Shareholder
  • Partner
  • Trustee
  • Beneficial owner
  • Other
  • None

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:

  • Authorised person
  • Director
  • Company secretary
  • Shareholder
  • Partner
  • Trustee
  • Beneficial owner
  • Other
  • None

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.

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 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

Behaviour

Example

Risk level is one of:

  • Low
  • Medium
  • High

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:

  • Low
  • Medium
  • High

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.

This property is only available if you're using the Risk module. Contact us to learn more.

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.

The API field for the risk score is applications.risk.overall.score.

Matching rule

Behaviour

Example

Risk score is less than:

  • A number

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:

  • A number

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:

  • A number

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:

  • A number

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:

  • A number

value

  • A number

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:

  • A number

<

value

<

  • A number

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:

  • A number

value

<

  • A number

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.

I t follows the No branch when the risk score is -1 or less or 100 or more.

Risk score is in the range:

  • A number

<

value

  • A number

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.

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

Behaviour

Example

Company share type is one of:

  • Publicly Traded
  • Private

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:

  • Publicly Traded
  • Private

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.

While it is possible to select both share types for the matching rule, this is not recommended because it creates a situation where 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

Behaviour

Example

Company liability type is one of:

  • Limited
  • Non Limited

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:

  • Limited
  • Non Limited

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.

While it is possible to select both liability types for the matching rule, this is not recommended because it creates a situation where 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.entity_type.

Matching rule

Behaviour

Example

Company ownership type is one of:

  • Partnership
  • Company
  • Sole proprietorship
  • Association
  • Trust
  • Other

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:

  • Partnership
  • Company
  • Sole proprietorship
  • Association
  • Trust
  • Other

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.

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.


How did we do?


Powered by HelpDocs