# United Kingdom

United Kingdom eKYB validates the legitimacy of British businesses by checking their tax ID, business name, address, UBOs, and directors against UK government sources of truth.

## Source

| Country        | Source                         | Description                                                                       |
| -------------- | ------------------------------ | --------------------------------------------------------------------------------- |
| United Kingdom | UK government sources of truth | Verifies submitted business details against records maintained in UK registries.  |

## Direct API approach

For general integration notes and shared response semantics, see the [eKYB API Reference](https://developer.incode.com/docs/ekyb-api-reference).

### Request parameters

| Parameter      | Required  | Description                                                                                                |
| -------------- | --------- | ---------------------------------------------------------------------------------------------------------- |
| `plugins`      | Mandatory | Array. Must be `["ekyb"]`.                                                                                 |
| `businessName` | Mandatory | String. Name of the business.                                                                              |
| `country`      | Mandatory | String. Two-letter Alpha-2 country code. Must be `GB`.                                                     |
| `taxId`        | Mandatory | String. Accepts Registration Number or VAT Number. See [Tax ID formats](#tax-id-formats) for details.      |
| `street`       | Optional  | String. Street name of the business.                                                                       |
| `houseNo`      | Optional  | String. Building or house number.                                                                          |
| `addressLine2` | Optional  | String. Second line of the business address.                                                               |
| `city`         | Optional  | String. City in the business address.                                                                      |
| `state`        | Optional  | String. State in the business address.                                                                     |
| `postalCode`   | Optional  | String. UK postal code (5-7 alphanumeric characters).                                                      |
| `uboNames`     | Optional  | Array. Full legal names of Unique Beneficial Owners to check against records associated with the business. |
| `directors`    | Optional  | Array. Full legal names of directors to check against records associated with the business.                |

### Tax ID formats

| Tax ID Type         | Format                                                        |
| ------------------- | ------------------------------------------------------------- |
| Registration Number | 8 digits (or 7 digits, in which case a leading zero is added) |
| VAT Number          | `GB` + 9 digits                                               |

### Sample request

```json
{
  "plugins": ["ekyb"],
  "businessName": "SOUTHAMPTON FOOTBALL CLUB LIMITED",
  "street": "S STADIUM ST MARY Kemp House",
  "addressLine2": "BRITANNIA ROAD",
  "city": "SOUTHAMPTON",
  "postalCode": "SO14 0AA",
  "country": "GB",
  "taxId": "XXXXXXXXX",
  "uboNames": ["ST MARY'S FOOTBALL GROUP LTD", "Sarah Smith"],
  "directors": ["Andrew Martin", "Sarah Schrader"]
}
```

### Sample response

```json
{
  "kyb": [
    { "key": "name", "sub_label": "Verified" },
    { "key": "tin", "sub_label": "Verified", "reasonCodes": ["REGNO"] },
    { "key": "address_verification", "sub_label": "Verified" },
    { "key": "cityMatch", "sub_label": "Verified" },
    { "key": "postalCodeMatch", "sub_label": "Verified" },
    { "key": "registrationStatus", "sub_label": "Active" },
    {
      "key": "entityType",
      "entityType": { "entityType": "Private limited with Share Capital" }
    },
    { "key": "ubo_name_match", "sub_label": "Verified", "uboName_input": "ST MARY'S FOOTBALL GROUP LTD" },
    { "key": "ubo_name_match", "sub_label": "Unverified", "uboName_input": "Sarah Smith" },
    { "key": "directors_name_match", "sub_label": "Verified", "directorsName_input": "Andrew Martin" },
    { "key": "directors_name_match", "sub_label": "Unverified", "directorsName_input": "Sarah Schrader" }
  ]
}
```

### Response fields

| Key                    | Status                                        | Description                                                                                                          |
| ---------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `name`                 | `Verified`, `Approximate Match`, `Unverified` | Submitted business name against the business name associated with the tax ID.                                        |
| `tin`                  | `Verified`, `Unverified`                      | Submitted tax ID against the government database.                                                                    |
| `address_verification` | `Verified`, `Approximate Match`, `Unverified` | Submitted address against the address associated with the tax ID.                                                    |
| `cityMatch`            | `Verified`, `Approximate Match`, `Unverified` | Submitted city against the city associated with the tax ID.                                                          |
| `postalCodeMatch`      | `Verified`, `Unverified`                      | Submitted postal code against the postal code associated with the tax ID.                                            |
| `registrationStatus`   | `Active`, `Inactive`, `Unknown`               | Registration status of the business. `Inactive` includes suspended businesses and those no longer in operation.      |
| `entityType`           | Legal entity type of the business             | The legal entity type of the company, if available. If not available, displays `Unknown`.                            |
| `ubo_name_match`       | `Verified`, `Approximate Match`, `Unverified` | Submitted UBO against UBOs associated with the business. Distinguished by the `uboName_input` field on each entry.   |
| `directors_name_match` | `Verified`, `Approximate Match`, `Unverified` | Submitted director against directors associated with the business. Distinguished by the `directorsName_input` field. |

### Error responses

See the [eKYB API Reference](https://developer.incode.com/docs/ekyb-api-reference) for standard error responses.

## Single Session Dashboard results

View eKYB results on the Business tab in [single Session view](https://developer.incode.com/docs/single-session-view).