Address Verification
To perform address verification the functionality has to be enabled for the environment that you use.
Our sales@idenfy.com team will help you include new functionalities in your contract and the technical support team will help with enabling these new features and assist throughout the implementation. Please contact our technical support team via Dashboard using your account.
To make the API calls, all of the requests will require basic auth, where API key is username, and API secret is password.
Address Verification
To perform address verification, construct a POST request to the following endpoint:
https://ivs.idenfy.com/api/v2/address-verification
Request structure:
Parameter | Type | Required | Explanation |
---|---|---|---|
address | String | Yes | Address for verification |
country | String | No | 2-digit ISO country code, e.g. "LT" |
Examples
- Request example
- Response example
{
"address": "Baršausko g. 59, LT-51423 Kaunas",
"country": "LT"
}
{
"address": "Baršausko g. 59, LT-51423 Kaunas",
"country": "LT",
"status": "VERIFIED",
"quality": "GOOD",
"accuracy": 99
}
Response explanation:
Value | Meaning |
---|---|
address | Address that was used to perform address verification. |
country | Country that was passed during address verification process. |
status | Status of the address, possible values: VERIFIED , PARTIALLY_VERIFIED , UNVERIFIED |
quality | Quality score of address, possible values: EXCELLENT , GOOD , AVERAGE , POOR , BAD |
accuracy | Accuracy of the address information, possible maximum value is 100. Lower value will be returned if, for example, postcode used in request differs from the actual postcode which is dedicated with provided address . |