Skip to content
Last updated

Database screening

Our system sends the "Database screening" callback when the applicant is found in one of the connected databases during a database check.

This callback includes the databases parameters indicating where the match was found, and the accuracy parameter indicating the match confidence.

The callback must be enabled in the form's settings in the Dashboard before use.

Schema

typestring
Example:"DATABASE_SCREENING"
full_namestring or null, (name), [ 2 .. 100 ] characters^[a-zA-Z ,.''-]{1,100}$

The full name of a person, which includes a first and last name

Example:"Josh Coffey"
first_namestring or null, (name), [ 2 .. 64 ] characters^[a-zA-Z ,.''-]{2,64}$

The first name of a person

Example:"Josh"
last_namestring or null, (name), [ 2 .. 64 ] characters^[a-zA-Z ,.''-]{2,64}$

The last name of a person

Example:"Coffey"
middle_namestring or null, (name), [ 2 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$

The middle name of a person

Example:"David"
dobstring or null, (date)

The date of birth of a person, formatted as “YYYY-MM-DD” according to ISO 8601

Example:"1976-02-21"
residence_countrystring or null, = 2 characters

A residence country of an object. A two-letter country code according to ISO 3166-2

Example:"GB"
genderstring or null

The gender of a person. M indicates male; F indicates female

Enum:"M""F"
Example:"M"
name_match_thresholdnumber
Example:0.75
name_match_weightnumber
Example:0.7
dob_match_enabledboolean
Example:true
dob_match_weightnumber
Example:0.1
residence_country_match_enabledboolean
Example:true
residence_country_match_weightnumber
Example:0.05
gender_match_enabledboolean
Example:true
gender_match_weightnumber
Example:0.05
bdb_typesArray of strings

A type of blacklist databases to make a check

  • SANCTIONS: Global and local sanctions databases
  • PEP: Databases of politically exposed persons (PEP)
  • WANTED: Databases of persons being searched for by the police
  • EXPIRED: Databases of stolen or lost documents
Items Enum:"INTERNAL""SANCTIONS""PEP""WANTED""EXPIRED"
Example:
[
  "SANCTIONS"
]

Example

{
   "full_name": "Josh Coffey",
   "first_name": "Josh",
   "last_name": "Coffey",
   "middle_name": "David",
   "dob": "1976-02-21",
   "residence_country": "GB",
   "gender": "M",
   "name_match_threshold": 0.75,
   "name_match_weight": 0.7,
   "dob_match_enabled": true,
   "dob_match_weight": 0.1,
   "residence_country_match_enabled": true,
   "residence_country_match_weight": 0.05,
   "gender_match_enabled": true,
   "gender_match_weight": 0.05,
   "bdb_types": [
     "SANCTIONS"
   ]
}

BDB_types:

See the full list of supported database types below.

Array of strings

A type of blacklist databases to make a check

  • SANCTIONS: Global and local sanctions databases
  • PEP: Databases of politically exposed persons (PEP)
  • WANTED: Databases of persons being searched for by the police
  • EXPIRED: Databases of stolen or lost documents
Enum:"INTERNAL""SANCTIONS""PEP""WANTED""EXPIRED"

Overview

Document expired