Skip to main content

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.

Requirements
  • API key pair
  • Finances to perform address verification

​
Verify Address

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

KeyTypeExplanation
addressStringAddress that was used to perform address verification.
countryStringCountry that was passed during the address verification process.
statusStringStatus of the address. Possible values: VERIFIED, PARTIALLY_VERIFIED, UNVERIFIED.
qualityStringQuality score of the address. Possible values: EXCELLENT, GOOD, AVERAGE, POOR, BAD.
accuracyIntegerAccuracy 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

{
  "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
}