# Request an Individual Address Verification

This endpoint request an individual address verification report.

<mark style="color:red;">`POST`</mark>

```http
{{baseurl}}/v1/candidates/:candidateId/live_photo
```

### Header

| Field | Type   | Description      |
| ----- | ------ | ---------------- |
| token | String | Secret API token |

### Parameter

| Field                                                     | Type    | Description                                                       |
| --------------------------------------------------------- | ------- | ----------------------------------------------------------------- |
| subject\_consent                                          | Boolean | Candidate consent. <mark style="color:red;">`Must be true`</mark> |
| description <mark style="color:red;">`optional`</mark>    | String  | Description or any information for the agent                      |
| address                                                   | Object  | Candidate address object                                          |
| flat\_number <mark style="color:red;">`optional`</mark>   | String  | Address flat number                                               |
| building\_name <mark style="color:red;">`optional`</mark> | String  | Address building name                                             |
| building\_number                                          | String  | Address building number                                           |
| landmark                                                  | String  | Address landmark                                                  |
| street                                                    | String  | Address street                                                    |
| sub\_street <mark style="color:red;">`optional`</mark>    | String  | Address sub street                                                |
| state                                                     | String  | Address state                                                     |
| city                                                      | String  | Address city                                                      |
| postcode <mark style="color:red;">`optional`</mark>       | String  | Address postcode                                                  |
| images                                                    | Array   | An array containing the candidate image either in base64 or URL   |

{% tabs %}
{% tab title="Sample Request" %}

```json
{
    "description": "",
    "address": {
        "flat_number": "",
        "building_name": "",
        "building_number": "13b",
        "landmark": "Police Station",
        "street": "Bishop street",
        "sub_street": "",
        "nipost_address": "",
        "state": "Lagos",
        "city": "Ilupeju",
        "postcode": "",
        "country": "Nigeria"
    },
    "images": [
        "https://cdns.com/images/1568622087748-5d7f460788daaf0f54673efb.jpg"
    ]
}
```

{% endtab %}
{% endtabs %}

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

```json
HTTP/1.1 201 CREATED
 {
        "message": "Successful",
        "data": {
            "id": "reports_0f2d654b-3cf8-4f26-8302-60ba517dab10",
            "reference_id": "61f9a4a07f861",
            "subject_consent": true,
            "candidate": {
                "id": "e4f7320c-527b-471b-9670-725958a633e3",
                "reference_id": "YV61f9097146dfe3308",
                "name": "Ehichioya Prior Famous",
                "first_name": "Famous",
                "last_name": "Ehichioya",
                "middle_name": "Prior",
                "email": "famous@youverify.co",
                "mobile": "08030000000",
                "has_live_photo": true,
                "live_photo_path": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-01/photo_61f9a49e5d1123653.jpg"
            },
            "start_time": "2022-02-01",
            "end_time": "2022-02-01",
            "execution_date": "",
            "submitted_at": "",
            "completed_at": null,
            "accepted_at": null,
            "revalidation_date": "2022-05-01",
            "status": "unassigned",
            "task_status": "PENDING",
            "reason": null,
            "task_created_by": "Chinook Devops",
            "package": "live_photo",
            "download_url": null,
            "description": "",
            "package_name": "Live Photo Address Verification",
            "details": {
                "uuid": "f1da6820-9e3c-4b4f-9595-93599e5ea97f",
                "address_id": 20287,
                "candidate_id": 4734567,
                "photo_url": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-01/photo_61f9a4115d5f23653.jpg",
                "status": "PENDING",
                "reason_for_fail": null,
                "deleted_at": null,
                "created_at": "2022-02-01 22:22:38",
                "updated_at": "2022-02-01 22:22:38",
                "images": [
                    {
                        "id": 5243,
                        "uuid": "7bb935c1-2fab-4dbe-9c33-c5875d830ed3",
                        "live_photo_id": 5237,
                        "candidate_id": 4734567,
                        "image_type": "image/jpeg",
                        "image_extension": "jpg",
                        "path": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-01/photo_61f9a49e5d1123653.jpg",
                        "image_name": "photo_61f9a49b94fbc5563.jpg",
                        "deleted_at": null,
                        "created_at": "2022-02-01 22:22:40",
                        "updated_at": "2022-02-01 22:22:40",
                        "image_path": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-01/photo_61f9a49e5d1123653.jpg"
                    }
                ],
                "address": {
                    "uuid": "6cf9eff6-1f33-425d-b52a-fd3d550d1558",
                    "user_id": 1,
                    "user_type": "user",
                    "candidate_id": 4734567,
                    "flat_number": null,
                    "building_name": null,
                    "building_number": "13b",
                    "sub_street": null,
                    "street": "Bishop street",
                    "landmark": "Police Station",
                    "state": "lagos",
                    "city": "Ilupeju",
                    "post_code": null,
                    "country": "Nigeria",
                    "longitude": null,
                    "latitude": null,
                    "what3words": "",
                    "what3words_map": "",
                    "agent_geo": null,
                    "start_date": null,
                    "end_date": null,
                    "status": "PENDING",
                    "reason_for_fail": null,
                    "item_id": "0",
                    "item_type": "live_photo",
                    "created_at": "2022-02-01 22:22:32",
                    "updated_at": "2022-02-01 22:22:32",
                    "formatted": "Flat Number , , 13b, Sub Street , Bishop  Street, Police Station, Ilupeju, Lagos, Nigeria, ",
                    "map_format": "13b Bishop Street, Ilupeju , Lagos, Nigeria",
                    "map_address_url": null,
                    "map_geolocation_url": null
                },
                "live_photos": {
                    "photo_url": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-01/photo_61f9a4911d5f23653.jpg"
                }
            },
            "has_address": true,
            "notes": [],
            "signature": [],
            "is_flagged": 0,
            "awaiting_qa": false,
            "reportable_id": "f1da6820-9e3c-4b4f-9595-93599e5ea97f",
            "created_at": "2022-02-01 22:22:40",
            "last_updated_at": "2022-02-01 22:22:40",
            "what3words": null,
            "what3words_map_link": null,
            "digital_address_code": null,
            "digital_address_url": null,
            "map_address_url": null,
            "map_geolocation_url": null,
            "report_geolocation_url": null,
            "report_longitude": null,
            "report_latitude": null,
            "can_view_report": true,
            "business": "Youverify",
            "reasons_for_failure": [
                "Address does not exist",
                "Address not accessible",
                "Candidate does not live there",
                "Incorrect Address",
                "Nobody to confirm candidate lives at the address"
            ],
            "submission_distance_in_meters": 0,
            "building_type": null,
            "building_color": null,
            "gate_present": null,
            "gate_color": null,
            "availability_confirmed_by": null,
            "closest_landmark": null,
            "additional_info": null,
            "report_agent_access": null,
            "incident_report": null,
            "images": {
                "data": []
            }
        },
        "status_code": 201
    }
```

{% endtab %}

{% tab title="Error Response" %}

```json
HTTP/1.1 402 Payment Required
  {
    "success": false,
    "statusCode": 402,
    "message": "Insufficient fund",
    "name": "PaymentRequiredError",
    "data": {}
}


HTTP/1.1 500 Internal Server Error
{
    "success": false,
    "statusCode": 500,
    "message": "Service unavailable",
    "name": "Error",
    "data": {}
}

HTTP/1.1 403 Forbidden
{
    "success": false,
    "statusCode": 403,
    "message": "Permission denied",
    "name": "UnauthorizedError",
    "data": {}
}
```

{% endtab %}
{% endtabs %}

<br>


---

# 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/our-legacy-api-and-sdk/address-verification/request-an-individual-address-verification.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.
