> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dojah.io/llms.txt
> Use this file to discover all available pages before exploring further.

# UK eKYC

> Verify a British Identity across multiple sources

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

```http [GET] theme={null}
{{baseUrl}}/api/v1/uk/kyc
```

### Header

| Header        | Type   | Description                                                                                         |
| ------------- | ------ | --------------------------------------------------------------------------------------------------- |
| AppId         | string | Create an app to get your app ID on dashboard [here](https://app.dojah.io/developers/configuration) |
| Authorization | string | Private/secret key. Use `<key>` not `Bearer <key>`                                                  |

### Query Parameter

| Parameter          | Type   | Description | Required |
| ------------------ | ------ | ----------- | -------- |
| first\_name \*     | string |             | required |
| last\_name \*      | string |             | required |
| middle\_name       | string |             |          |
| date\_of\_birth \* | string |             | required |
| gender \*          | string | M,F         | required |
| country \*         | string | GBR         | required |
| street\_name \*    | string |             | required |
| house\_number \*   | string |             | required |
| post\_code \*      | string |             | required |

### Sample response

```json Response theme={null}
{
  "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

| Field                                | Type   | Description                                                     |
| ------------------------------------ | ------ | --------------------------------------------------------------- |
| entity                               | object | Contains the eKYC verification result                           |
| entity.interpretResult               | string | Overall verification outcome ("Pass" or "Fail")                 |
| entity.message                       | string | Description of the matching process and sources used            |
| entity.rawResponse                   | array  | Detailed match results from each data source                    |
| entity.rawResponse\[].AddressMatch   | string | Address match result (e.g., "NoMatch", "Full", "Partial")       |
| entity.rawResponse\[].DataSource     | string | Name of the data source used for verification                   |
| entity.rawResponse\[].DobMatch       | string | Date of birth match result (e.g., "Full", "Partial", "NoMatch") |
| entity.rawResponse\[].FirstNameMatch | string | First name match result (e.g., "Full", "Initial", "NoMatch")    |
| entity.rawResponse\[].SurnameMatch   | string | Surname match result (e.g., "Full", "Partial", "NoMatch")       |
| entity.transactionResult             | string | Transaction processing status (e.g., "Success")                 |