# Verify Address Information

## Address Information Verification

<mark style="color:green;">`POST`</mark> `{{baseurl}}/v2/api/identity/ke/address`

#### Headers

| Name                                    | Type   | Description      |
| --------------------------------------- | ------ | ---------------- |
| token<mark style="color:red;">\*</mark> | String | API secret token |

#### Request Body

| Name                                               | Type    | Description                                                                                                      |
| -------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
| id<mark style="color:red;">\*</mark>               | String  | Candidates identity number                                                                                       |
| isSubjectConsent<mark style="color:red;">\*</mark> | Boolean | Indicate subject has given consent. <mark style="color:red;">`Must be true`</mark>                               |
| idtype<mark style="color:red;">\*</mark>           | String  | Identity number type this can be one of the following <mark style="color:red;">`national-id and passport`</mark> |

### <mark style="color:purple;">Address Information Verification</mark>

Address information verification retrieves the addressing information on a provided Kenyan National ID or Passport number.

{% tabs %}
{% tab title="Address Information Verification Sample Request (National ID)" %}

```json
{
    "id": "1234567",
    "idType": "national-id"|"passport",
    "isSubjectConsent": true
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Address Information Verification Sample Response (National ID)" %}

```json
{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "64f843f1304e30c0c965dc2f",
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": false,
        "selfieValidation": false,
        "dateOfBirth": "1999-12-31",
        "identityType": "national-id",
        "isConsent": true,
        "idNumber": "1234567",
        "businessId": "62c2a4868d319373a6280152",
        "firstName": "Kangethe",
        "middleName": "Kariuki",
        "lastName": "Simon",
        "fullName": "Kangethe Kariuki  Simon",
        "gender": "Male",
        "maritalStatus": "Married",
        "mainAddress": {
            "address": "NYAHURURU  KCC",
            "country": "KE",
            "town": "Nyahururu"
        },
        "secondaryAddress": {
            "address": "NAKURU-CENTRE",
            "country": "KE",
            "town": "NYAHURURU",
            "postalCode": "20300"
        },
        "type": "keCreditInfoAddress",
        "allValidationPassed": true,
        "requestedAt": "2023-09-06T09:18:41.706Z",
        "requestedById": "62c2a4868d3193700828014e",
        "country": "KE",
        "createdAt": "2023-09-06T09:18:41.746Z",
        "lastModifiedAt": "2023-09-06T09:18:41.746Z",
        "metadata": {},
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "62c2a4868d3193700828014e"
        }
    },
    "links": []
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Error Response" %}

```json
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.youverify.co/know-your-customer-services-kyc/id-data-matching-eidv/kenya/verify-address-information.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.