Skip to main content
This is an Identity verification service for the UK, It uses Electoral Roll, CreditLendersFull(CAIS, Insight), CCJ(Country Court Judgements), BT OSIS, Mortality.. The 2+2 Matching uses Name+Address and Name+DOB in various combination to reach a Pass or Fail.

​
Request

[GET]
{{baseUrl}}/api/v1/uk/kyc
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

​
Query Parameter

ParameterTypeDescriptionRequired
first_name *stringrequired
last_name *stringrequired
middle_namestring
date_of_birth *stringrequired
gender *stringM,Frequired
country *stringGBRrequired
street_name *stringrequired
house_number *stringrequired
post_code *stringrequired

​
Sample response

Response
{
  "entity": {
    "interpretResult": "Pass",
    "message": "Matching performed using 11,8 sources as per profile",
    "rawResponse": [
      {
        "AddressMatch": "NoMatch",
        "DataSource": "Resident Roll",
        "DobMatch": "Partial",
        "FirstNameMatch": "Initial",
        "SurnameMatch": "Full"
      }
    ],
    "transactionResult": "Success"
  }
}

​
Response Fields

FieldTypeDescription
entityobjectContains the eKYC verification result
entity.interpretResultstringOverall verification outcome (“Pass” or “Fail”)
entity.messagestringDescription of the matching process and sources used
entity.rawResponsearrayDetailed match results from each data source
entity.rawResponse[].AddressMatchstringAddress match result (e.g., “NoMatch”, “Full”, “Partial”)
entity.rawResponse[].DataSourcestringName of the data source used for verification
entity.rawResponse[].DobMatchstringDate of birth match result (e.g., “Full”, “Partial”, “NoMatch”)
entity.rawResponse[].FirstNameMatchstringFirst name match result (e.g., “Full”, “Initial”, “NoMatch”)
entity.rawResponse[].SurnameMatchstringSurname match result (e.g., “Full”, “Partial”, “NoMatch”)
entity.transactionResultstringTransaction processing status (e.g., “Success”)