Using the Policy Builder

The Policy Builder in PassFort Connect is where you can manage your smart policies, including adding and editing data providers and checks as well as publishing new policy versions.

This article refers to the new draft policies in Connect which is currently in testing with our feedback partners. If you're interested in becoming a feedback partner, please get in touch with your Customer Success Manager.

Getting started with the Policy Builder

A policy is the combination of data providers and checks that can be used on your account.

Data providers are the third-party services to help you onboard customers (e.g. Experian, Companies House, or Onfido).

Checks are automated processes used to replace manual work that would otherwise be needed to:

  1. Get information from data providers (e.g. gather all company filings from a corporate registry); and/or
  2. Perform actions using data providers (e.g. run an electronic identity check).

When you run a check from PassFort, the profile details are sent to the data provider, which performs the check and returns the result. 

Choosing data providers and checks

Before you start building your policy, you should take some time to decide which checks you want to run and which data providers you want to use to run them.

To get a list of all the check types and the data providers for each one, see What are PassFort's checks?

Each data provider has its own way of performing checks, which means the available configuration options depend on the data providers you choose. To learn more about the specific behaviour of a provider, see its configuration article.

Once you know which ones you want to use, follow the steps below to add your data providers and checks, then review and publish the policy.

Working with your demo and production environments

You'll be provided with two environments: 

  • Demo environment: This is a special account just for testing. It does not run live checks (with the exception of ones that use free data providers like Companies House), so you can run as many tests as you like. 
  • Production environment: This is the environment that your system(s) will use to run live checks. This means you'll see real check results from your data providers and you'll be charged for any checks you run. 

We recommend building your policy initially in your demo environment where you can test every check and data provider combination, then replicating your configuration in the production environment.

If there are any differences between the configuration in your demo environment and production environment, your policy will behave differently. We recommend double-checking the configuration in your production environment before publishing the policy.
Running tests in your demo environment

Since live checks are not run with paid providers in the demo environment, PassFort provides a series of tests you can use to simulate these results. To get the tests:

  1. Find the articles for your data providers.
  2. In the articles, go to the section called Testing your configuration. All the steps to run the tests are there.

You can combine test words into a single profile.

For example, if you're testing the Electronic identity check with Experian Prove-ID and the PEPs and sanctions screening with RDC, you could run these tests by creating profiles with the following names:

Test

Keyword(s) required

Profile name for test

What happens to customers with no PEPs matches and a 2+2 result?

To test no PEPs matches:

No keywords are required

To test a 2+2 result:

No keywords are required

Alex Wheeler

What happens to customers with no PEPs matches and a fail result?

To test no PEPs matches:

No keywords are required

To test a fail result:

fail

Alex Wheeler fail

What happens to customers with some PEPs matches and a 2+2 result?

To test some PEPs matches:

PEP

To test a 2+2 result:

No keywords are required

Alex Wheeler PEP

What happens to customers with some PEPs matches and a fail result?

To test some PEPs matches:

PEP

To test a fail result:

fail

Alex Wheeler PEP fail

This is only an example of a test you may want to run. See the data provider articles for more keywords you can use.
Some tests can return different results based on your configuration options. Every data provider article includes a section called Configuration options which lists the options you can use for that check variant.
Running tests in your production environment

When you're happy with the behaviour of your demo environment, you should replicate the exact same configuration in your production environment. 

You may want to run tests on a small set of individuals (e.g. employees or family members) to make sure your checks have been configured correctly and your systems are integrated properly. Remember that you'll see real check results from your data providers and you'll be charged for any checks you run.

Before running any live checks on a real person, you must get their permission. Note that some checks (e.g. the Electronic identity check) run a soft credit check and may appear on the person's credit report.

Data providers

Each instance of a data provider is considered a new data provider variant

The variant is the combination of the data provider, check type, commercial agreement details, and configuration options. 

It's possible to add multiple variants for the same provider.

To get a list of all the check types and which data providers you can use for each one, see What are PassFort's checks?

Add a data provider

To add a new data provider variant:

  1. Log into the PassFort Portal and go to Policy Builder > Data providers.
  2. Click New data provider. A drop-down is displayed.
  3. If the provider will be used to run checks on individuals, select Individual provider. If the provider will be used to run checks on companies, select Company provider. The New provider dialog is displayed.
If the provider will be used to run checks on individuals and companies, you should add two variants - one as an Individual provider and one as a Company provider.
  1. Under Provider type, select the provider name and check type. If the provider supports multiple check types, it will be listed multiple times in the drop-down.
  2. Under Variant name, type a name for this configuration. Users will see this name in the Portal. 
  3. Click Create. The provider variant is added to the data providers list and the variant details are displayed.
Once you add a new variant, a banner is displayed at the bottom of the page to show which version of the draft policy this will be added to. To learn more, see Review and publish the draft policy.
  1. Under Commercial agreement, select PassFort reselling if you are paying for checks with PassFort credit or Direct agreement if you are paying your data provider directly.
You want to use Global Data Consortium with a reseller agreement, our Support team will need to do some additional configuration. Contact support@passfort.com to get started.
  1. Complete any other information under Commercial agreement
To learn more about your commercial agreement details, please contact your data provider account manager if you have a direct agreement or support@passfort.com if you have a resellers agreement.
  1. Under Configuration options, select the options you would like to use for this variant. To learn more about configuration options, see the article for your data provider.
The data provider articles list all configuration options under the Configuration option headings, including those for check variants. If you read about a configuration option that isn't displayed in the data provider variant, you'll have the opportunity to configure it later when you set up the check variant.
All changes are saved in real time to the latest version of your draft policy.

Edit a data provider

To edit an existing data provider variant:

  1. Log into the PassFort Portal and go to Policy Builder > Data providers.
  2. By default, the data provider variants for individuals are displayed. To see the variants for companies, click Company.
  3. Click the name of the data provider variant. The variant details are displayed.
  4. Edit the details. Your changes are saved automatically to the latest version of your draft policy.

Delete a data provider

To delete an existing data provider variant:

  1. Log into the PassFort Portal and go to Policy Builder > Data providers.
  2. By default, the data provider variants for individuals are displayed. To see the variants for companies, click Company.
  3. Click the name of the data provider variant. The variant details are displayed.
  4. Click Delete data provider. A confirmation message is displayed.
If the Delete data provider button is grayed out, it's because the data provider is currently in use on another check. Hover your cursor over the Delete data provider button to see which check it's used on, then edit the check to remove the data provider from the list.
  1. Click Yes, delete provider. The data provider variant is removed from the current version of your draft policy and is no longer displayed under the data providers list.

Checks

As with data providers, each instance of a check is considered a new check variant

The variant is the combination of the check type and configuration options as well as the data provider variants used to run the check. 

It is possible to add multiple check variants for the same check type.

To get a list of all the check types and which data providers you can use for each one, see What are PassFort's checks?

Add a check

To add a new check variant:

  1. Log into the PassFort Portal and go to Policy Builder > Checks.
  2. Click New check configuration. A drop-down is displayed.
  3. If the check will be run on individuals, select Individual check. If the check will be run on companies, select Company check. The New check dialog is displayed.
If the check will be run on individuals and companies, you should add two variants - one as an Individual check and one as a Company check.
  1. Under Check type, select the type of check.
  2. Under Check name, type a name for this variant. Users will see this name in the Portal. 
  3. Click Create. The check variant is added to the checks list and the variant details are displayed.
  4. Optionally, under Alias, write a name that will be used when making calls to the API. The name should not include any spaces (e.g. "basic_peps"). Learn more about aliases.
  5. Under Check logic configuration, click Add data providers to the list. A drop-down is displayed with the name of every data provider variant that matches the check type.
  6. Select one or more data providers from the list. The data provider(s) are displayed under Order priority of check providers.
    If you add more than one data provider variant, the variant at the top of the list will be tried first when the check is run. If the check does not pass with the first variant, the next variant in the list is tried, and so on. This behaviour is called waterfalling.

    To change the waterfall order, click the Reorder icon next to the provider and drag the provider into the new position.

    If the expected check outcome is more complex than Pass/Fail (e.g. in the case of a PEPs and sanctions screening), an additional section is displayed called Check failover configuration. This section determines which result will cause the next data provider variant to be tried.

    For example, in the image above, Refinitiv World-Check One will be tried first. If the check errors, ComplyAdvantage will be tried. If Refinitiv World-Check One returns any other match (including a full match, a partial match, or a failed match), the waterfall will stop and ComplyAdvantage will not be tried.
  7. To use specific data providers based on the profile's country:
    1. Under Country-based configuration, click Add country configuration.
    2. If the check is for individuals, under Country of residence (individuals) or Country of incorporation (companies), type the name of a country.
    3. Click Add data providers to the list and select one or more data provider variants that match the check type. For more information about selecting data provider variants and configuring the waterfall, see step 9. To add specific data providers for another country, follow these steps again.
To remove an entire country configuration, click Remove.

Edit a check

To edit an existing check variant:

  1. Log into the PassFort Portal and go to Policy Builder > Checks.
  2. By default, the check variants for individuals are displayed. To see the variants for companies, click Company.
  3. Click the name of the check variant. The variant details are displayed.
  4. Edit the details. Your changes are saved automatically to the latest version of your draft policy.

Delete a check

To delete an existing check variant:

  1. Log into the PassFort Portal and go to Policy Builder > Checks.
  2. By default, the check variants for individuals are displayed. To see the variants for companies, click Company.
  3. Click the name of the check variant. The variant details are displayed.
  4. Click Delete check. A confirmation message is displayed.
  5. Click Yes, delete check. The check variant is removed from the current version of your draft policy and is no longer displayed under the checks list.

Policy versions

A policy is the combination of checks and data providers that can be used on your account.

When you first add data providers and checks, a new draft policy is created automatically so your changes are saved. 

You can keep editing until you're ready to publish the policy version. Once the policy version is published, you'll be able to use the data providers and checks.

If you want to make changes after your policy is published, a new draft will be created again automatically as soon as you start making changes. When you publish the new version, it becomes the active policy version and the other version is archived.

Even if you have many policy versions, there will only ever be one active policy version and one draft policy version. All other versions are archived.

See policy versions

To see all versions of your policy, go to Policy Builder > Policy versions.

All policy versions are displayed:

  • Draft policy: If available, your draft policy is displayed at the top and listed as (draft).
  • Active policy: If available, your active policy is displayed directly under the draft policy or, if you don't have a draft policy, it's displayed at the top. 
  • Archived policies: Any archived policies are displayed below the active policy.

The columns in the table show the following information:

  • Version name: The name of the policy version. This is created automatically.
  • Published by: The name of the user who published the version. In the case of the draft policy, there is no publisher (since it's not published yet).
  • Updated on: The date when the policy version was published. In the case of the draft policy, this shows when the draft was last updated.
  • Actions: The actions you can take on the policy. Currently, you can only take action on the draft policy, which is to review changes.

Review and publish the draft policy

To review and publish the draft policy:

  1. Go to Policy Builder > Policy versions.
  2. In the Actions column next to the draft policy, click Review changes. The policy details are displayed.
You can also get here by clicking Review changes in the banner that's displayed at the bottom of every page when you make changes to data providers and checks.
  1. If there are any issues with the draft:
    1. A message is displayed at the top to let you know the current state of the policy: "You can't publish this draft" or "There are issues with this draft". 
    2. A Validation issues section is displayed next to Changes to the policy so you can review each issue.

      If there are any issues with the Error severity, you must resolve them now. If there are any issues with the Warning severity, you should review them, but you don't have to take action. If there are no issues, the banner and Validation issues area are not displayed and no action is needed.
  2. Click Changes to the policy and confirm that these are the changes you would like to make.
  3. When you're ready to publish your draft, click Publish. The published policy is displayed at the top of the list of policy versions.

Discard the draft policy changes

To discard all changes to your draft policy:

  1. Go to Policy Builder > Policy versions.
  2. In the Actions column next to the draft policy, click Review changes. The policy details are displayed.
  3. Click Discard changes. A confirmation message is displayed.
  4. Click Discard changes. The draft policy is removed from the list of policy versions.


How did we do?


Powered by HelpDocs (opens in a new tab)