# Proof of Address Verification

## Proof of Address Verification

<mark style="color:green;">`POST`</mark> `{{baseurl}}/v2/api/identity/za/poa`

#### Headers

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

#### Request Body

| Name                                                  | Type    | Description                                                                        |
| ----------------------------------------------------- | ------- | ---------------------------------------------------------------------------------- |
| id<mark style="color:red;">\*</mark>                  | String  | Users identity number                                                              |
| addressDetails<mark style="color:red;">\*</mark>      | Object  | Address detail data object                                                         |
| proofOfAddressImage<mark style="color:red;">\*</mark> | String  | Proof of address image                                                             |
| address1<mark style="color:red;">\*</mark>            | String  | Address line 1                                                                     |
| address2<mark style="color:red;">\*</mark>            | String  | Address line 2                                                                     |
| suburb<mark style="color:red;">\*</mark>              | String  | Suburban area                                                                      |
| isSubjectConsent<mark style="color:red;">\*</mark>    | Boolean | Indicate subject has given consent. <mark style="color:red;">`Must be true`</mark> |
| houseNumber<mark style="color:red;">\*</mark>         | String  | House number of candidate                                                          |
| street<mark style="color:red;">\*</mark>              | String  | Street name of candidate                                                           |
| buildingName<mark style="color:red;">\*</mark>        | String  | Candidates building name                                                           |
| unitName<mark style="color:red;">\*</mark>            | String  | Candidates unit name                                                               |
| personalInformation<mark style="color:red;">\*</mark> | Object  | Validation data object                                                             |
| lastName<mark style="color:red;">\*</mark>            | String  | Candidates last name                                                               |
| province<mark style="color:red;">\*</mark>            | String  | Candidates province                                                                |
| city<mark style="color:red;">\*</mark>                | String  | Candidates city                                                                    |
| postalCode<mark style="color:red;">\*</mark>          | String  | Candidates postal code                                                             |
| stateCode<mark style="color:red;">\*</mark>           | String  | Candidates city code                                                               |
| duration<mark style="color:red;">\*</mark>            | String  | Duration of stay                                                                   |
| propertyType<mark style="color:red;">\*</mark>        | String  | Candidates property type                                                           |
| country<mark style="color:red;">\*</mark>             | String  | Candidates country                                                                 |
| firstName<mark style="color:red;">\*</mark>           | String  | Candidates first name                                                              |
| gender<mark style="color:red;">\*</mark>              | String  | Candidates gender                                                                  |
| email<mark style="color:red;">\*</mark>               | String  | Candidates email address                                                           |
| idType<mark style="color:red;">\*</mark>              | String  | Candidates ID type                                                                 |

### <mark style="color:yellow;">Proof of Address Verification</mark>

With this endpoint, you have access to the verification of the client's proof of address in South Africa.

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

```json
{
    "personalInformation": {
        "firstName": "JONAH",
        "lastName": "PILLAY",
        "gender": "M",
        "email": "XXXXX@XXXXX.com"
    },
    "addressDetails": {
        "proofOfAddressImage": "{{Base64String}}",
        "imageName": "image.jp",
        "address1": "Body Corporate of Cohiba",
        "address2": "Stand NO: 433",
        "suburb": "Radiokop",
        "houseNumber": "1",
        "street": "2",
        "buildingName": "2",
        "unitName": "2",
        "province": "2",
        "city": "Radiokop",
        "postalCode": "1752",
        "stateCode": "GP",
        "duration": "13",
        "propertyType": "O  ",
        "country": "ZA"
    },
    "id": "2502161858090",
    "idType": "SAID",
    "isSubjectConsent": true
}
```

{% endtab %}
{% endtabs %}

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

```json
{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "645bca7cd80de606cd7e5ad3",
        "validations": {
            "data": {
                "phoneNumber": {
                    "validated": false,
                    "value": "0795030317"
                },
                "fullName": {
                    "validated": true,
                    "value": "CONCO"
                },
                "email": {
                    "validated": false,
                    "value": "bonisiwez466@gmail.com"
                }
            },
            "validationMessages": "Email does not match, Phone Number does not match"
        },
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": true,
        "identityNumberValid": "No",
        "accountTypeValid": "Yes",
        "accountStatus": "Open",
        "acceptsDebits": "Yes",
        "acceptsCredits": "Yes",
        "accountNumberValid": "Yes",
        "{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "64cc3994d0ae9481b885e518",
        "parentId": null,
        "status": "found",
        "reason": null,
        "businessId": "62c2a4868d319373a6280152",
        "requestedAt": "2023-08-03T23:34:44.712Z",
        "requestedById": "62c2a4868d3193700828014e",
        "country": "ZA",
        "type": "zaPOA",
        "riskOutcome": "High",
        "isConsent": true,
        "metadata": {},
        "personalInformation": {
            "firstName": "JONAH",
            "lastName": "PILLAY",
            "gender": "M",
            "email": "XXXXX@XXXXX.com"
        },
        "addressDetails": {
            "proofOfAddressImage": "{{Base64String}}",
            "imageName": "image.jp",
            "address1": "Body Corporate of Cohiba",
            "address2": "Stand NO: 433",
            "suburb": "Radiokop",
            "houseNumber": "1",
            "street": "2",
            "buildingName": "2",
            "unitName": "2",
            "province": "2",
            "city": "Radiokop",
            "postalCode": "1752",
            "stateCode": "GP",
            "duration": "13",
            "propertyType": "O  ",
            "country": "ZA"
        },
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "62c2a4868d3193700828014e"
        }
    },
    "links": []
}
```

{% endtab %}
{% endtabs %}

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

```json
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}
```

{% 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/id-data-matching-eidv/south-africa/proof-of-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.