---
title: UK Residential KYC
slug: us-apis/uk-residential-kyc
createdAt: 2024-10-30T14:04:26.339Z
---

## Overview

The UK Residential KYC API for Great Britain provides an automated way to verify the personal and residential details of UK citizens. This API is designed to confirm the accuracy of provided information against authoritative databases, aiding in identity verification and compliance with regulatory standards.

## Usecase

This API is particularly valuable for:

- **Financial Services:** Banks and other financial institutions can use this API to verify identity details during account opening, loan applications, or customer record updates.
- **Employment Background Checks:** Companies performing pre-employment screening can verify the personal details of potential hires.
- **Government Services:** Government agencies can verify citizen details for program eligibility or document issuance.

# API Details

## Request Body

:::CodeblockTabs
PreProduction

```json
curl --location 'https://api-preproduction.signzy.app/api/v3/global-kyc/verify/gb/residential-check' \
--header 'Content-Type: application/json' \
--header 'Authorization:  <----Auth Token---->' \
--data-raw '{
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1962-01-10",
    "addressLine1": "",
    "addressLine2": "Conon Bridge",
    "addressLine3": "Dingwall",
    "addressLine4": "ROSS-SHIRE",
    "addressLine5": "",
    "emailAddress": "MARTIN-@XYZ.COM",
    "landlineNo": "4401461600849",
    "phoneNo": "4401461600549",
    "consent": true
}'
```

Production

```json
curl --location 'https://api.signzy.app/api/v3/global-kyc/verify/gb/residential-check' \
--header 'Content-Type: application/json' \
--header 'Authorization:  <----Auth Token---->' \
--data-raw '{
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1962-01-10",
    "addressLine1": "",
    "addressLine2": "Conon Bridge",
    "addressLine3": "Dingwall",
    "addressLine4": "ROSS-SHIRE",
    "addressLine5": "",
    "emailAddress": "MARTIN-@XYZ.COM",
    "landlineNo": "4401461600849",
    "phoneNo": "4401461600549",
    "consent": true
}'
```
:::

## Request Body Parameters

| Parameter    | Type    | Description                                                                                                                  | Required                                              |
| ------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| firstName    | String  | First name of the individual                                                                                                 | Yes                                                   |
| lastName     | String  | Last name of the individual                                                                                                  | Yes                                                   |
| dateOfBirth  | Date    | Date of birth (format: YYYY-MM-DD)                                                                                           | DOB or anyone of the address lines is mandatory       |
| addressLine1 | String  | Primary residential address line                                                                                             | DOB or anyone of the address lines is mandatory       |
| addressLine2 | String  | Sub-locality, village, hamlet, or a more specific area within the main town/city.                                            | DOB or anyone of the address lines is mandatory       |
| addressLine3 | String  | City or locality part of the address                                                                                         | DOB or anyone of the address lines is mandatory       |
| addressLine4 | String  | County                                                                                                                       | DOB or anyone of the address lines is mandatory       |
| addressLine5 | String  | Postal code<br /><br />Regex :- <br />Postcodes range from 5 to 7 characters in length and include both letters and numbers. | DOB or anyone of the address lines is mandatory<br /> |
| emailAddress | String  | Email address of the individual                                                                                              | No                                                    |
| landlineNo   | String  | Landline number of the individual<br /><br />Regex :- <br />It must be 10-13 digits with the country code (e.g., +44 or 44)  | No                                                    |
| phoneNo      | String  | Mobile number of the individual<br /><br />Regex :- <br />It must be 10-13 digits with the country code (e.g., +44 or 44)    | No                                                    |
| consent      | Boolean | Consent from the individual for verification                                                                                 | No                                                    |

:::CodeblockTabs
Successful Response

```json
{
    "result": {
        "nameMatchScore": "1.00",
        "addressMatchScore": "0.25",
        "verificationResult": {
            "firstName": "true",
            "lastName": "true",
            "dateOfBirth": "true",
            "addressLine1": "",
            "addressLine2": "true",
            "addressLine3": "true",
            "addressLine4": "true",
            "addressLine5": "false",
            "phoneNo": "false",
            "landlineNo": "true",
            "emailAddress": "false"
        }
    },
    "reason": "Request Successful",
    "code": "S001"
}
```
:::

## Response Body Parameter

| Parameter          | Type   | Description                                         |
| ------------------ | ------ | --------------------------------------------------- |
| nameMatchScore     | String | Name Match Score                                    |
| addressMatchScore  | String | Address Match Score                                 |
| verificationResult | Object | Container for detailed results of the verification. |
| firstName          | String | Result of the first name verification.              |
| lastName           | String | Result of the last name verification.               |
| dateOfBirth        | String | Result of the date of birth verification.           |
| addressLine1       | String | Result of the address line1 verification.           |
| addressLine2       | String | Result of the address line2 verification.           |
| addressLine3       | String | Result of the address line3 verification.           |
| addressLine4       | String | Result of the address line4 verification.           |
| addressLine5       | String | Result of the address line5 verification.           |
| phoneNo            | String | Result of the phone number verification.            |
| landlineNo         | String | Result of the landline number verification.         |
| emailAddress       | String | Result of the email address verification.           |
| reason             | String | Explanation of the verification results.            |
| code               | String | Response Code                                       |

### Sample Error

:::CodeblockTabs
E601 Internal Server Error

```json
{
    "result": {},
    "reason": "Internal Server Error",
    "code": "E601"
}
```

E003 Invalid regex&#x20;

```json
{
    "result": {},
    "reason": "Landline number must be between 10-13 digits, including the country code (e.g., +44 or 44)",
    "code": "E003"
}

----

{
    "result": {},
    "reason": "Phone number must be between 10-13 digits, including the country code (e.g., +44 or 44)",
    "code": "E003"
}

----

{
    "result": {},
    "reason": "Please provide a valid email address.",
    "code": "E003"
}

----

{
    "result": {},
    "reason": "Invalid date. Please use a valid date.",
    "code": "E003"
}
```

E003 Empty Required field

```json
{
    "result": {},
    "reason": "DOB or Address is mandatory",
    "code": "E003"
}
```

E401 Upstream Failure

```json
{
    "result": {},
    "reason": "Upstream error",
    "code": "E401"
}
```
:::

### Error Response Parameters

| **Parameter** | **Description**        |
| ------------- | ---------------------- |
| result        | Empty result object    |
| reason        | Reason for error       |
| status        | Status of the api      |
| code          | Error code from Signzy |

### Error Codes

| HTTP Status Code | Error Code | Description           |
| ---------------- | ---------- | --------------------- |
| 400              | E001       | Bad Request           |
| 401              | E1001      | Unauthorized Access   |
| 403              | E201       | Forbidden             |
| 404              | E301       | Data Not Found        |
| 409              | E401       | Upstream error        |
| 429              | E501       | Rate Limit Exceeded   |
| 500              | E601       | Internal Server Error |
| 503              | E701       | Service Unavailable   |
| 504              | E801       | Timeout               |

### Success Codes

| HTTP Status Code | Success Code | Description         |
| ---------------- | ------------ | ------------------- |
| 200              | S001         | Request Successful. |

:::hint{type="info"}
### Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [help@signzy.com](#). We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
:::

