> ## 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.

# United Kingdom eKYC

> Verify a UK individual against multiple identity data sources and return an aggregated match result.

GET
`/api/v1/uk/kyc`

Verify a UK individual against multiple identity data sources and return an aggregated match result.

## Headers

| Header | Required | Description |
| - | - | - |
| `Authorization` | Yes | Your app's secret key, sent as-is — *not* `Bearer`. |
| `AppId` | Yes | The App ID from your dashboard. |

## Query parameters

| Parameter | Type | Required | Description |
| - | - | - | - |
| `first_name` | string | Yes | First name. |
| `last_name` | string | Yes | Last name. |
| `middle_name` | string | No | Middle name. |
| `date_of_birth` | string | Yes | Date of birth (YYYY-MM-DD). |
| `gender` | string | Yes | `M` or `F`. |
| `country` | string | Yes | Country code — `GBR`. |
| `street_name` | string | Yes | Street name. |
| `house_number` | string | Yes | House number. |
| `post_code` | string | Yes | Post code. |

## Response

Returns an `entity` with an `interpretResult` plus the per-source `rawResponse` matches.

## Errors

| Code | Meaning |
| - | - |
| `400` | Bad request — a required parameter is missing or malformed. |
| `401` | Unauthorized — check your key and `AppId` (no `Bearer` prefix). |
| `402` | Insufficient wallet balance. [Fund your wallet](https://docs.dojah.io/api-reference/core-concepts/wallet-billing.md). |
| `404` | No record found for the supplied identifier. |
| `424` | The upstream source was unavailable — retry shortly. |
| `429` | Too many requests — back off and retry. |

```bash cURL theme={null}
curl --request GET \
  "https://api.dojah.io/api/v1/uk/kyc?first_name=John&last_name=Musa&date_of_birth=1969-12-12&gender=M&country=GBR&street_name=Baker Street&house_number=221&post_code=NW1 6XE" \
  -H "Authorization: {{secret_key}}" \
  -H "AppId: {{app_id}}"
```

```js Node.js theme={null}
const params = new URLSearchParams({
  "first_name": "John",
  "last_name": "Musa",
  "date_of_birth": "1969-12-12",
  "gender": "M",
  "country": "GBR",
  "street_name": "Baker Street",
  "house_number": "221",
  "post_code": "NW1 6XE",
});

const url = "https://api.dojah.io/api/v1/uk/kyc?" + params;
const res = await fetch(url, {
  headers: {
    Authorization: process.env.DOJAH_SECRET_KEY,
    AppId: process.env.DOJAH_APP_ID,
  },
});
const data = await res.json();
```

```python Python theme={null}
import os, requests

res = requests.get(
    "https://api.dojah.io/api/v1/uk/kyc",
    headers={
        "Authorization": os.environ["DOJAH_SECRET_KEY"],
        "AppId": os.environ["DOJAH_APP_ID"],
    },
    params={ "first_name": "John", "last_name": "Musa", "date_of_birth": "1969-12-12", "gender": "M", "country": "GBR", "street_name": "Baker Street", "house_number": "221", "post_code": "NW1 6XE" },
)
data = res.json()
```

```json GET /api/v1/uk/kyc 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"
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.