Address History

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

GET {{baseurl}}/v2/api/addresses/history

Path Parameters

Name	Type	Description
page	String	Page number of the requested page. Default value: 1
limit	String	Number of addresses to return. Default value: 20 Maximum Value: 100

Headers

Name	Type	Description
token*	String	API secret token

Response

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": "[e-mail]",
                            "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": "[e-mail]",
                            "mobile": "[phone]",
                            "countryCode": "NG",
                            "id": "615c2deb203b96532838418c"
                        }
                    }
                ],
                "pagination": {
                    "totalDocs": 11,
                    "perPage": 1,
                    "totalPages": 11,
                    "currentPage": 1,
                    "serialNo": 1,
                    "hasPrevPage": false,
                    "hasNextPage": true,
                    "prevPage": null,
                    "nextPage": 2
                }
            },
            "links": []
        }