# Address History

This endpoint allows the user to retrieve their verified address verification history.

<mark style="color:blue;">`GET`</mark> `{{baseurl}}/v2/api/addresses/history`

#### Path Parameters

| Name  | Type   | Description                                                                                                                                                                      |
| ----- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| page  | String | <p>Page number of the requested page.</p><p>Default value: <mark style="color:red;"><code>1</code></mark></p>                                                                    |
| limit | String | <p>Number of addresses to return.</p><p>Default value: <mark style="color:red;"><code>20</code></mark></p><p>Maximum Value: <mark style="color:red;"><code>100</code></mark></p> |

#### Headers

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

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

```json
HTTP/1.1 200 OK
{
            "success": true,
            "statusCode": 200,
            "message": "Addresses retrieved successfully!",
            "data": {
                "docs": [
                    {
                        "candidate": {
                            "candidateId": "618e7f4b48fe5f0ee26d5667",
                            "firstName": "Famous",
                            "middleName": "Prior",
                            "lastName": "Ehichioya",
                            "photo": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2021-11-12/photo_618e7f54be210c9056.jpg",
                            "email": "famous@youverify.co",
                            "mobile": "08030000000"
                        },
                        "address": {
                            "latlong": {
                                "lat": null,
                                "lon": null
                            },
                            "flatNumber": "1st floor",
                            "buildingName": "Sum house",
                            "buildingNumber": "350",
                            "subStreet": "Hughes avenue",
                            "street": "Borno way",
                            "landmark": "Police Station",
                            "state": "Lagos",
                            "city": "Yaba",
                            "country": "Nigeria",
                            "lga": "Lagos Mainland"
                        },
                        "referenceId": "618e7f5cb9c42",
                        "status": "pending",
                        "taskStatus": "PENDING",
                        "businessType": "admin",
                        "businessId": "615c2deb203b96532838418b",
                        "userId": "615c2deb203b96532838418c",
                        "type": "individual",
                        "createdAt": "2021-11-12T14:51:19.525Z",
                        "lastModifiedAt": "2021-11-12T14:51:19.525Z",
                        "_createdAt": "2021-11-12T15:51:1919+01:00",
                        "_lastModifiedAt": "2021-11-12T15:51:1919+01:00",
                        "verificationId": "618e7f5cb9c42",
                        "id": "618e7f6748fe5f0ee26d5668",
                        "user": {
                            "firstName": "Famous",
                            "lastName": "Ehichioya",
                            "middleName": "Prior",
                            "email": "test@gmail.com",
                            "mobile": "+2348036000000",
                            "countryCode": "NG",
                            "id": "615c2deb203b96532838418c"
                        }
                    }
                ],
                "pagination": {
                    "totalDocs": 11,
                    "perPage": 1,
                    "totalPages": 11,
                    "currentPage": 1,
                    "serialNo": 1,
                    "hasPrevPage": false,
                    "hasNextPage": true,
                    "prevPage": null,
                    "nextPage": 2
                }
            },
            "links": []
        }
```

{% 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/address-verification-service-for-individuals/address-history.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.