Configuring Onfido v1 and 2

Note

Maxsight supports Onfido Classic. Onfido Studio is not yet supported.

Onfido is a data provider you can use to run identity checks.

In Maxsight, Onfido v1 and v2 is labeled as Onfido in the web interface. You can use Onfido v1 and v2 for Electronic identity checks only. For ID verification, use Configuring Onfido v3. Configuring Onfido v3 offers additional capabilities, including:

Additional configuration options
Improved MRZ verification
ID verification (Maxsight collects documents)
ID verification (service collects documents)

Learn more about configuring Onfido v3.

How it works

This is the default behavior for a variant of the Electronic identity check with Onfido as the data provider.

The check is performed by searching for the individual’s details (name, date of birth, address, and, in some cases, national identity number) in the sources supplied by Onfido.

The check passes when a 2+2 result is achieved, which happens when either of these conditions are true:

The individual’s full name and address are matched in one source. and the individual’s full name and are matched in a second source.
The individual’s full name and address are matched in two distinct sources.

If a 2+2 result cannot be achieved, the check looks for a 1+1 result.

The check returns a partial match when a 1+1 result is achieved, which happens when either of these conditions are true:

The individual’s full name, date of birth, and address are matched in one source.
The individual’s full name and address are matched in one source.

If the conditions are not met for a 2+2 result or a 1+1 result, the check fails.

If the individual’s profile doesn’t have data for the required fields, an error is displayed.

If the country of address in the individual’s profile isn’t covered by Onfido, an error is displayed.

Although the individual's national identity number can be used to search the Onfido's data in some cases, this check variant does not confirm the validity of the national identity number. For more information about how Onfido handles this check variant, see Onfido’s documentation.

Configuration options

You have the following configuration options:

Configure custom matching rules: When this option is selected, you can input your own rules. Note that the custom rules that you configure here will override the data provider result and the default Maxsight rules.
Custom matching rules
To configure a new custom matching rule:
Click the Add custom rule button, then click the down arrow to expand your new custom rule fields.
Give your rule a meaningful name.
Click in the Result field and select a result from the menu.
Fail: The individual's details were not matched.
1+1: The individual's details were matched in one source.
2+2: The individual's details were matched in at least two sources.
Enter the Database type to search. You can start typing the name of a database type or click into the field and select from the menu that appears. Select the database types that you need.
Click into the Requires field and select the requirements that you need from each database. For example, you can specify that Forename, Surname, and DOB are required from one database and Forename, Surname, and Address are required from another database.
Note
Note that a match in a mortality database will return a fail result.
If needed, select the Distinct sources checkbox. This checkbox applies when you have two or more lines of requirements. Selecting this checkbox means that each line of requirements must come from a different database.
You can add more custom rules, the first rule whose requirements are met will become the active rule. Reorder these at any time by clicking on and holding the grab bar, then, drag the rules into the order you want them.
If you are using mortality checks, Maxsight recommends setting up Fail rules first in order of precedence.

Date of birth must match in one source to achieve a 1+1 or 2+2 result: When this option is selected, it’s only possible for the check to achieve a 2+2 result or a 1+1 result when the individual’s date of birth is matched in Onfido’s sources.
In other words, a 2+2 result is only achieved if the individual’s full name and address are matched in one source and the individual’s full name and date of birth are matched in a second source. A 1+1 result is only achieved when the individual’s full name, date of birth, and address are matched in one source.
Fail the check if a mortality result is found: The individual’s full name and date of birth is searched in Onfido’s mortality lists. If a match is found, the check fails.
Use the most recent previous address if the result isn’t 2+2: When this option is selected, the individual’s most recent address is used when the check is run. With this option, if the check fails or a partial match is returned, the check is run again automatically using the next most recent address. The check is only run again automatically once.
With this configuration option, any time the check is run again automatically, you are charged for a second check. If the addresses provided on the individual’s profile do not include dates, the addresses used for this check are selected at random.

Testing your configuration

Once the check variant is configured, follow these steps in your demo environment to test whether it's working as expected.

When the check variant is configured to pass on 2+2 results (default):

Does the check pass when a 2+2 result is achieved?
To run the test, create any individual profile and run the check variant. If the check passes, it’s working as expected.
Does the check return a partial match when a 1+1 result is achieved?
To run the test, create an individual profile with "1+1" as a given name or surname, such as Alex 1+1 Wheeler, and run the check variant. If the check returns a partial match, it’s working as expected.
Does the check fail when the conditions are not met for a 2+2 result or a 1+1 result?
To run the test, create an individual profile with FAIL as a given name or surname, such as Alex FAIL Wheeler, and run the check variant. If the check fails, it’s working as expected.

When the check variant is configured to pass on 1+1 results:

Does the check pass when a 1+1 result is achieved?
To run the test, create an individual profile with "1+1" as a given name or surname, such as Alex 1+1 Wheeler, and run the check variant. If the check passes, it’s working as expected.
Does the check fail when the conditions are not met for a 1+1 result?
To run the test, create an individual profile with FAIL as a given name or surname, such as Alex FAIL Wheeler, and run the check variant. If the check fails, it’s working as expected.

In the live environment, an error is displayed when the check variant is run on a profile with a country of address that isn't covered by Onfido. This error is not displayed in the demo environment. The test words are not case-sensitive.

What we’ll need

Let us know that you’d like to add a variant of the Electronic identity check with Onfido and which configuration options you’d like to use. We’ll set it up for you.

We’ll also need your Sandbox API token and your Live API token.

Profile fields

These are the profile details searched in Onfido’s sources:

Name	Description
First name(s) (`personal_details.name.given_names`) *Required	The individual’s first and, if applicable, middle names.
Surname (`personal_details.name.family_name`) *Required	The individual’s last name.
Date of birth (`personal_details.dob`) *Required	The individual’s date of birth. Note that you must provide the full date of birth.
Addresses (`address_history`) *Required	The individual’s address history.
National identity number (`personal_details.national_identity_number`) Optional (US social security numbers only)	The individual’s national identity number for their registered country.

In this section: