DocumentationAPI Reference
General reference · eKYC Reference / eKYC Coverage

United Kingdom

United Kingdom eKYC verification matches submitted individual data against UK sources of truth. See the eKYC API Reference for common response semantics that apply across all sources.

Available sources

Source API source string Description
UK VOTER REGISTER UK_Voter_Register Verifies submitted data against the United Kingdom's Voter Register.
UK CREDIT BUREAU 1 {/* TODO: source string unknown */} Verifies submitted data against UK credit bureau records.

{/* TODO: Confirm with PM — no existing API documentation is available for UK CREDIT BUREAU 1. Provide source string, request parameter list, response schema, and overallLevel calculation. Also confirm the customer-facing description covering which credit bureau it verifies against and the typical customer use case, particularly the difference between choosing UK CREDIT BUREAU 1 and UK VOTER REGISTER. */}

UK VOTER REGISTER

Request parameters

Parameter Required Description
source Mandatory Must be UK_Voter_Register.
country Mandatory Must be GB.
firstName Mandatory First name of the individual.
middleName Optional Middle name of the individual.
surName Mandatory Last name of the individual.
street Optional Street name and house number.
city Optional City of the individual's address.
postalCode Optional Postal code. Five to seven characters, letters and digits only, no special characters.
dateOfBirth Optional Format: yyyy-mm-dd.
phone Optional Phone number. Ten or eleven digits, most commonly eleven.
gender Optional Accepted values are M or F.

{/* TODO: Confirm with PM — existing API documentation lists firstName, surName, country, and source as mandatory, but the Dashboard UI does not lock any field as required for UK VOTER REGISTER. Confirm which set of requirements is accurate. */}

Response fields

UK VOTER REGISTER anchors verification on the source-of-truth register. See the eKYC API Reference for common match field definitions and status values.

Field Statuses Description
firstNameMatch exact, fuzzy, nomatch Matches first name submitted against the value in the source of truth.
middleNameMatch exact, fuzzy, nomatch, unknown Matches middle name submitted against the value in the source of truth.
lastNameMatch exact, fuzzy, nomatch Matches last name submitted against the value in the source of truth.
fullNameMatch exact, fuzzy, nomatch Matches full name submitted against the value in the source of truth.
dobMatch exact, fuzzy, nomatch, unknown Matches date of birth submitted against the value in the source of truth.
genderMatch exact, fuzzy, nomatch, unknown Matches gender submitted against the value in the source of truth.
streetMatch exact, fuzzy, nomatch, unknown Matches street submitted against the value in the source of truth.
cityMatch exact, fuzzy, nomatch, unknown Matches city submitted against the value in the source of truth.
zipcodeMatch exact, nomatch, unknown Matches postal code submitted against the value in the source of truth.
addressMatch exact, fuzzy, nomatch Matches full address submitted against the value in the source of truth.
phoneMatch exact, fuzzy, nomatch, unknown Matches phone submitted against the value in the source of truth.
overallLevel low, medium, high Overall risk level. See below for calculation logic.

overallLevel calculation

overallLevel is calculated based on the risk associated with the submitted full name and address:

  • low when fullNameMatch is a match AND (addressMatch is a match OR addressMatch is fuzzy).
  • high when fullNameMatch and addressMatch are both nomatch.
  • medium for all other combinations.

Contact your Incode representative to customize the overallLevel calculation for your use case.

Sample response

{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "fuzzy" },
        { "key": "fullNameMatch", "status": "fuzzy" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "genderMatch", "status": "exact" },
        { "key": "phoneMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "zipcodeMatch", "status": "exact" },
        { "key": "addressMatch", "status": "exact" },
        { "key": "overallLevel", "status": "low" }
    ]
}

UK CREDIT BUREAU 1

{/* TODO: No existing API documentation is available for this source. Request source string, request parameter list, response schema, and overallLevel calculation from PM. */}

Documentation for this source is forthcoming. Contact your Incode representative for details in the meantime.

Was this page helpful?