# 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

```json
{
  "$ref": "#/components/schemas/database-screening-api",
  "components": {
    "schemas": {
      "full_name": {
        "type": [
          "string",
          "null"
        ],
        "format": "name",
        "pattern": "^[a-zA-Z ,.''-]{1,100}$",
        "minLength": 2,
        "maxLength": 100,
        "example": "Josh Coffey",
        "description": "The full name of a person, which includes a first and last name"
      },
      "first_name": {
        "title": "First name",
        "type": [
          "string",
          "null"
        ],
        "format": "name",
        "minLength": 2,
        "maxLength": 64,
        "pattern": "^[a-zA-Z ,.''-]{2,64}$",
        "example": "Josh",
        "description": "The first name of a person"
      },
      "last_name": {
        "title": "Last name",
        "type": [
          "string",
          "null"
        ],
        "format": "name",
        "minLength": 2,
        "maxLength": 64,
        "pattern": "^[a-zA-Z ,.''-]{2,64}$",
        "example": "Coffey",
        "description": "The last name of a person"
      },
      "middle_name": {
        "title": "Middle name",
        "type": [
          "string",
          "null"
        ],
        "format": "name",
        "minLength": 2,
        "maxLength": 64,
        "pattern": "^[a-zA-Z ,.''-]{1,64}$",
        "example": "David",
        "description": "The middle name of a person"
      },
      "dob": {
        "type": [
          "string",
          "null"
        ],
        "format": "date",
        "example": "1976-02-21",
        "description": "The date of birth of a person, formatted as “YYYY-MM-DD” according to ISO 8601"
      },
      "residence_country": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 2,
        "maxLength": 2,
        "example": "GB",
        "description": "A residence country of an object. A two-letter country code according to ISO 3166-2"
      },
      "gender": {
        "type": [
          "string",
          "null"
        ],
        "enum": [
          "M",
          "F"
        ],
        "example": "M",
        "description": "The gender of a person. `M` indicates male; `F` indicates female"
      },
      "bdb_type": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "INTERNAL",
            "SANCTIONS",
            "PEP",
            "WANTED",
            "EXPIRED"
          ]
        },
        "example": [
          "SANCTIONS"
        ],
        "description": "A type of blacklist databases to make a check\n- `SANCTIONS`: Global and local sanctions\ndatabases\n- `PEP`: Databases of politically exposed persons (PEP)\n- `WANTED`: Databases of persons being searched for by the police\n- `EXPIRED`: Databases of stolen or lost documents\n"
      },
      "database-screening-api": {
        "type": "object",
        "title": "DATABASE_SCREENING",
        "properties": {
          "type": {
            "type": "string",
            "example": "DATABASE_SCREENING"
          },
          "full_name": {
            "$ref": "#/components/schemas/full_name"
          },
          "first_name": {
            "$ref": "#/components/schemas/first_name"
          },
          "last_name": {
            "$ref": "#/components/schemas/last_name"
          },
          "middle_name": {
            "$ref": "#/components/schemas/middle_name"
          },
          "dob": {
            "$ref": "#/components/schemas/dob"
          },
          "residence_country": {
            "$ref": "#/components/schemas/residence_country"
          },
          "gender": {
            "$ref": "#/components/schemas/gender"
          },
          "name_match_threshold": {
            "type": "number",
            "example": 0.75
          },
          "name_match_weight": {
            "type": "number",
            "example": 0.7
          },
          "dob_match_enabled": {
            "type": "boolean",
            "example": true
          },
          "dob_match_weight": {
            "type": "number",
            "example": 0.1
          },
          "residence_country_match_enabled": {
            "type": "boolean",
            "example": true
          },
          "residence_country_match_weight": {
            "type": "number",
            "example": 0.05
          },
          "gender_match_enabled": {
            "type": "boolean",
            "example": true
          },
          "gender_match_weight": {
            "type": "number",
            "example": 0.05
          },
          "bdb_types": {
            "$ref": "#/components/schemas/bdb_type"
          }
        }
      }
    }
  }
}
```

## Example

```json
{
   "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.

```json
{
  "$ref": "#/components/schemas/bdb_type",
  "components": {
    "schemas": {
      "bdb_type": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "INTERNAL",
            "SANCTIONS",
            "PEP",
            "WANTED",
            "EXPIRED"
          ]
        },
        "example": [
          "SANCTIONS"
        ],
        "description": "A type of blacklist databases to make a check\n- `SANCTIONS`: Global and local sanctions\ndatabases\n- `PEP`: Databases of politically exposed persons (PEP)\n- `WANTED`: Databases of persons being searched for by the police\n- `EXPIRED`: Databases of stolen or lost documents\n"
      }
    }
  }
}
```