Skip to main content

Address Verification

Requirements
  • API key pair
  • Finances to perform address verification

Verification​

address verification

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/address-verification

Request parameters​

ParameterTypeRequiredExplanation
addressStringYesAddress for verification
countryStringNo2-digit ISO country code, e.g. "LT"

Response values:​

address| Type: String
Explanation:

Address that was used to perform address verification.

country| Type: String
Explanation:

Country that was passed during address verification process.

status| Type: String
Explanation:

Status of the address.

Possible values: VERIFIED, PARTIALLY_VERIFIED, UNVERIFIED.

quality| Type: String
Explanation:

Quality score of the address.

Possible values: EXCELLENT, GOOD, AVERAGE, POOR, BAD.

accuracy| Type: Integer
Explanation:

Accuracy of the address information. Maximum value is 100.

Lower value will be returned if, for example, postcode used in request differs from the actual postcode derived from the provided address.

Request example​

{
  "address": "Baršausko g. 59, LT-51423 Kaunas",
  "country": "LT"
}

Response example​

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