Risk Signal: eKYC Checks

eKYC Checks provide a comprehensive global check on individual data elements such as name, address, date of birth, phone number or national ID (if provided). Checks provide a match/partial/no match response. This supports account onboarding use cases such as opening a bank account or a gaming account where you need to verify that the name, address, DOB, ID, and/or phone number are valid.

eKYC Checks supports both 1+1 and 2+2 checks. A 1+1 check looks for a single match of the input data against sources per country. A 2+2 checks and looks for two matches of the input data against different sources within the same country. See eKYC Checks Supported Countries for additional information.

Prerequisite

The Creating or Updating Accounts request body may include an optional ekycCheck object that includes a searchType value. Allowed values are:

one if requesting a 1+1 check
two if requesting a 2+2 check

If the object is not included in the request body the default value is one.

Example Account Request Body

{
    "customerInternalReference": "myCompany",
    "workflowDefinition": {
        "key": 10148,
        "capabilities": {
            "ekycCheck": {
                "searchType": "one"
            }
        }
    },
    ...
}

Supported Credentials

The following values can be uploaded as Prepared Data. Alternatively, they can be extracted by an upstream capability in a workflow.

To use Prepared Data with eKYC Checks as a standalone capability use workflow key 10148.

Key	Type	Mandatory	Description
firstName	string	yes	First name of the subject.
lastName	string	yes	Last name of the subject.
dob	string	no	Date of birth, in yyyy/mm/dd format.
address	Object	yes
address.line1	string	yes
address.line2	string	no
address.city	string	yes	City of residence as it appears on the Id.
address.postalCode	string	yes	Postal or zip code.
address.subdivision	string	no	City subdivision of residence as it appears on the Id.
address.country	string	yes	Country in ISO-3166-1 Alpha-3 Code or ISO-3166-1 Alpha-2 Code format.
phoneNumber	String	no	Phone number of the subject in E.164 format. Country code is required.
email	String	no	Optimal to include.
id	Object	no	See next row.
id.idNumber	string	no	National ID number.
id.type	string	no	Type of national ID.

Example: Prepared Data Body

{
  "firstName": "B***",
  "lastName": "S****",
  "email": "b***j@gmail.com",
  "dob": "1977/01/01",
  "phoneNumber": "+91-9880001234",
  "id": {
    "idNumber": "VIMK98**27MDFLN***",
    "type": "ID_CARD
  },
  "address": {
    "line1": "34",
    "postalCode": "560029",
    "city": "",
    "state": "",
    "subdivision": "",
    "country": "MEX"
  }
}

Example Response

"ekycCheck": [
      {
        "id": "f5b4ef7b-bbf4-4c89-89d0-5dcd868d6bbf",
        "credentials": [
          {
            "id": "1da85c03-7c5f-4865-ab88-698197defbc7",
            "category": "DATA",
            "label": "DATA"
          }
        ],
        "decision": {
          "type": "PASSED",
          "details": {
            "label": "LOW_RISK"
          }
        },
        "data": {
          "completeNameMatch": "MATCH",
          "initialNameMatch": "MATCH",
          "firstNameMatch": "MATCH",
          "lastNameMatch": "MATCH",
          "nationalIdMatch": "MATCH",
          "addressMatch": "MATCH",
          "addressLine1Match": "MATCH",
          "addressLine2Match": "MATCH",
          "cityMatch": "MATCH",
          "zipOrPinCodeMatch": "MATCH",
          "dateOfBirthMatch": "MATCH",
          "dateOfBirthDayMatch": "MATCH",
          "dateOfBirthMonthMatch": "MATCH",
          "dateOfBirthYearMatch": "MATCH",
          "phoneMatch": "MATCH",
          "datasourceType": "United_States Postal,United_States Telco,United_States Commercial",
          "searchType": "2+2"
        }

Decision Details Labels

Decision Type	Label	Description
PASSED	LOW_RISK
REJECTED	HIGH_RISK
WARNING	MEDIUM_RISK
NOT_EXECUTED	VALIDATION_FAILED
NOT_EXECUTED	NOT_ENOUGH_DATA
NOT_EXECUTED	PRECONDITION_NOT_FULFILLED
NOT_EXECUTED	TECHNICAL_ERROR

Data

Parameter	Type	Description
completeNameMatch	string	"MATCH" "NO_MATCH" The match status of the combined first and last name values.
initialNameMatch	string	"MATCH" "NO_MATCH" The match status of the middle initial .
firstNameMatch	string	"MATCH" "NO_MATCH" The match status of the first name.
lastNameMatch	string	"MATCH" "NO_MATCH" The match status of the last name.
nationalIdMatch	string	"MATCH" "NO_MATCH" The match status of the ID.
addressMatch	string	"MATCH" "NO_MATCH" The match status of the complete address.
addressLine1Match	string	"MATCH" "NO_MATCH" The match status of the address first line.
addressLine2Match	string	"MATCH" "NO_MATCH" The match status of the address second line.
cityMatch	string	"MATCH" "NO_MATCH" The match status of the address city.
zipOrPinCodeMatch	string	"MATCH" "NO_MATCH" The match status of the address zip or PIN code.
dateOfBirthMatch	string	"MATCH" "NO_MATCH" The match status of the entire date of birth.
dateOfBirthDayMatch	string	"MATCH" "NO_MATCH" The match status of the date of birth day.
dateOfBirthMonthMatch	string	"MATCH" "NO_MATCH" The match status of the date of birth month.
dateOfBirthYearMatch	string	"MATCH" "NO_MATCH" The match status of the date of birth year.
phoneMatch	string	The match status of the phone number.
datasourceType	string	The country and the type of data source. The country name is spelled out with underscores replacing spaces. The possible types are: Credit Government Commercial Consumer Utility Proprietary Telco Postal Multiple sources may be listed, separated by a comma.
searchType	string	"2+2" "1+1" Whether a MATCH must be found in 1 database or two databases.