# Digital Address Verification Service

Digital Address Verification is used to verify the address of a candidate using the last address the candidate purchased utilities for.

## Digital Address Verification

<mark style="color:green;">`POST`</mark> `{{baseurl}}` [/v2/api/digital-addresses/lookup](https://address.svc.youverify.co/v2/api/digital-addresses/lookup)

#### Headers

| Name  | Type   | Description      |
| ----- | ------ | ---------------- |
| token | String | API secret token |
|       |        |                  |

#### Request Body

| Name                                      | Type    | Description                                                                        |
| ----------------------------------------- | ------- | ---------------------------------------------------------------------------------- |
| phone<mark style="color:red;">\*</mark>   | String  | Phone number of candidate                                                          |
| consent<mark style="color:red;">\*</mark> | Boolean | Indicate subject has given consent. <mark style="color:red;">`Must be true`</mark> |

{% tabs %}
{% tab title="Digital Address Verification Sample Request" %}

```json
{
    "phone": "08000000000",
    "consent": true
}
```

{% endtab %}
{% endtabs %}

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

```json
{
"success": true,
"statusCode": 200,
"message": "Address verification request successful!",
"data": {
    "_id": "6452959fbcae029b5908b26d",
    "parentId": "628b38f03ae28a14f52d4bf7",
    "businessType": "organization",
    "businessId": "6401c96e055bc4df85ac7753",
    "userId": "6401c96f055bc49bdaac7755",
    "fullName": "Solomon Olaleye",
    "phoneNumber": "08000000000",
    "addresses": [
        {
            "reference": "88888888880",
            "address": "Fake Address, Fake City, Fake State, Fake Country",
            "facility": "PREPAID_METER",
            "owner": "Fake Name",
            "lastUsedOn": "2023-04-28T16:55:38.000Z"
        },
        {
            "reference": "12345678910",
            "address": "Fake Address, Fake City, Fake State, Fake Country",
            "facility": "PREPAID_METER",
            "owner": "Fake Name",
            "lastUsedOn": "2023-05-03T11:50:42.000Z"
        }
    ],
    "status": "found",
    "reasons": null,
    "subjectConsent": "true",
    "type": "digital_address",
    "reportId": "645295a1bcae029b5908b26e",
    "metadata": {},
    "apiVersion": "v2",
    "requestedById": "6401c96f055bc49bdaac7755",
    "requestedAt": "Wed May 03 2023 18:10:57 GMT+0100 (West Africa Standard Time)",
    "country": "NG",
    "createdAt": "2023-05-03T17:10:57.187Z",
    "lastModifiedAt": "2023-05-03T17:10:57.187Z",
    "requestedBy": {
        "firstName": "Prosper",
        "lastName": "Erawuvieke",
        "id": "6401c96f055bc49bdaac7755"
    }
},
"links": []
}
```

{% endtab %}

{% tab title="Not Found Response" %}

```json
{
    "success": true,
    "statusCode": 200,
    "message": "Address verification request successful!",
    "data": {
        "parentId": null,
        "businessType": "business",
        "businessId": "628b38f03ae28a14f52d4bf7",
        "userId": "628b38f03ae28a5a122d4bf3",
        "fullName": null,
        "phoneNumber": null,
        "addresses": [],
        "status": "not_found",
        "reasons": "Addresses not found.",
        "subjectConsent": "true",
        "type": "digital_address",
        "reportId": "64632f904600d166af3e80ac",
        "referenceId": "64632f904600d112183e80ad",
        "verificationId": "64632f904600d112183e80ad",
        "metadata": {},
        "apiVersion": "v2",
        "requestedById": "628b38f03ae28a5a122d4bf3",
        "requestedAt": "Tue May 16 2023 07:24:00 GMT+0000 (Coordinated Universal Time)",
        "country": "NG",
        "createdAt": "2023-05-16T07:24:00.909Z",
        "lastModifiedAt": "2023-05-16T07:24:00.909Z",
        "id": "64632f904600d147d33e80ab",
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "id": "628b38f03ae28a5a122d4bf3"
        }
    },
    "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/digital-address-verification-service.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.