> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.idenfy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Address Verification

> Verify customer addresses against official records using the iDenfy address verification API endpoint with country and address parameters.

<Note>
  **Requirements**

  * **API** key pair
  * Finances to perform **address verification**
</Note>

***

## Verify Address

<Info>
  **Authorization:** `API key pair`
  **Method:** `POST`
  **Endpoint:** `https://ivs.idenfy.com/api/v2/address-verification`
</Info>

### Request Parameters

| Parameter | Type   | Required | Explanation                         |
| --------- | ------ | -------- | ----------------------------------- |
| `address` | String | Yes      | Address for verification            |
| `country` | String | No       | 2-digit ISO country code, e.g. "LT" |

### Response Values

| Key        | Type    | Explanation                                                                                                                                                                                             |
| ---------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `address`  | String  | Address that was used to perform address verification.                                                                                                                                                  |
| `country`  | String  | Country that was passed during the address verification process.                                                                                                                                        |
| `status`   | String  | Status of the address. Possible values: `VERIFIED`, `PARTIALLY_VERIFIED`, `UNVERIFIED`.                                                                                                                 |
| `quality`  | String  | Quality score of the address. Possible values: `EXCELLENT`, `GOOD`, `AVERAGE`, `POOR`, `BAD`.                                                                                                           |
| `accuracy` | Integer | Accuracy of the address information. Maximum value is `100`. A lower value is returned if, for example, the postcode in the request differs from the actual postcode derived from the provided address. |

### Request Example

```json theme={"system"}
{
  "address": "Baršausko g. 59, LT-51423 Kaunas",
  "country": "LT"
}
```

### Response Example

```json theme={"system"}
{
  "address": "Baršausko g. 59, LT-51423 Kaunas",
  "country": "LT",
  "status": "VERIFIED",
  "quality": "GOOD",
  "accuracy": 99
}
```
