# Submit Address Verification

{% hint style="warning" %}
Please note that you are required to have a webhook set for address verification requests to be successful. If they are not set, you will not get notified when the verification has been completed.
{% endhint %}

## Submit Address for Verification

<mark style="color:green;">`POST`</mark> `https://vapi.verifyme.ng/v1/verifications/addresses`

This endpoint allows you to create address verifications

#### Headers

| Name           | Type   | Description          |
| -------------- | ------ | -------------------- |
| Authentication | string | Authentication Token |

#### Request Body

| Name                | Type   | Description                                                 |
| ------------------- | ------ | ----------------------------------------------------------- |
| reference           | string | Unique reference for identifying request                    |
| city                | string | city name                                                   |
| lga                 | string | Local government area                                       |
| landmark            | string | Address landmark                                            |
| state               | string | State name                                                  |
| street              | string | Street Name e.g "270 Murtala Muhammed Way, Alagomeji. Yaba" |
| applicant.firstname | string | Applicants first name                                       |
| applicant.lastname  | string | Applicants last name                                        |
| applicant.dob       | string | Applicants date of birth                                    |
| applicants.phone    | string | Applicants phone No                                         |
| applicant.idType    | string | Applicants Id type ( "BVN", "NIN", "KYC" )                  |
| applicant.idNumber  | string | Applicants Identity Number ("BVN", "NIN" , "Phone No")      |

{% tabs %}
{% tab title="201 Address verification created." %}

```
{
"status": "success",
"data": {
    id: 1,
    applicant: {
        firstname: "John",
        lastname: "Doe",
        phone:"08000000000",
        idType: "bvn",
        idNumber: "10000000001",
        middlename: "Cameron',
        photo: "https://images.verifyme.ng/278783775/fjjjjler7834.jpg",
        gender: "Male",
        birthdate: '17/01/1988',
    },
    createdAt: "",
    completedAt: "",
    lattitude: "9.081999",
    longitude: "8.675277",
    photos: ["https://picsum.photos/id/768/200/300.jpg", "https://picsum.photos/id/768/200/300.jpg"],
    neighbor: {
        name: "Tunde Adetunji",
        comment: "Very friendly",
        phone: "080900000000",
    },
    status: {
        status: "In Progress",
        subStatus: "In Progress",
        state: "In Progress",
    },
    city: "oshodi",
    street: "270 Murtala Muhammed Way, Alagomeji. Yaba",
    lga: "lagos mainland",
    state: "Lagos",
    country: "Nigeria",
    reference: "VMN_asksdjsjd"
}
```

{% endtab %}

{% tab title="401 Unauthorized" %}

```
{
    "status": "error",
    "message": "string",
    "code": "ACCESS_DENIED"
}
```

{% endtab %}
{% endtabs %}

#### Sample Request

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

```
{
    "street": "270 Murtala Muhammed Way, Alagomeji. Yaba",
    "lga": "surulere",
    "state": "lagos",
    "landmark": "Beside GTbank",
    "applicant": {
        "idType": "NIN",
        "idNumber": "10000000001",
        "firstname": "john",
        "lastname": "doe",
        "phone": "08121234567",
        "dob":"04-04-1944"
    }
}
```

{% endtab %}

{% tab title="CURL" %}

```
curl --verbose  
--header "Authorization: Bearer <token>"
--data '{"street": "270 Murtala Muhammed Way, Alagomeji. Yaba", "lga": "sululere", "city": "lagos","landmark": "Beside GTbank","applicant": {    "idType": "NIN",    "idNumber": "10000000001",    "firstname": "john",    "lastname": "doe",    "phone": "08121234567",    "dob":"04-04-1944"}}' 
--request "POST" "https://vapi.verifyme.ng/v1/verifications/addresses"
```

{% endtab %}
{% endtabs %}