POST
/
address
/
verify
curl --request POST \
  --url https://api-umbrella.io/api/services/address/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "country": "PL",
  "address": {
    "street": "Doktora Jana Piltza",
    "number": "41",
    "zip": "30-392",
    "city": "Kraków",
    "province": ""
  },
  "identity": {
    "firstname": "Pawel",
    "lastname": "Ramski",
    "dob": "2001/10/25"
  }
}'
{
  "inputAddress": "Doktora Jana Piltza 41 30-392 Kraków",
  "correctedAddress": "Piltza 41, 30-392 Kraków, Polska",
  "finalAddress": "Doktora Jana Piltza 41 30-392 Kraków",
  "addressStatus": "corrected",
  "addressComponents": {},
  "matchQuality": "CITY_MATCH",
  "score": 50,
  "globalResult": {
    "overall": "REVIEW",
    "totalScore": 50
  },
  "identity": {
    "fullName": "Pawel Ramski",
    "dob": "2001/10/25"
  },
  "extendedMessage": "cityMatch"
}

For a usage description of the Address Verification Service, please refer to the Address Verification page.

​
Endpoint

POST /address/verify

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
country
string
required

ISO 3166-1 Alpha-2/Alpha-3 country code (e.g., DE, AT, ES).

Example:

"PL"

​
address
object
required
​
identity
object
required

Response

200
application/json
Successfully verified address.
​
inputAddress
string

Raw address provided.

Example:

"Doktora Jana Piltza 41 30-392 Kraków"

​
correctedAddress
string

Corrected version of the address.

Example:

"Piltza 41, 30-392 Kraków, Polska"

​
finalAddress
string

Final confirmed address.

Example:

"Doktora Jana Piltza 41 30-392 Kraków"

​
addressStatus
enum<string>

Status after verification (corrected, unchanged).

Available options:
corrected,
unchanged
Example:

"corrected"

​
addressComponents
object

Detailed components of the final address.

​
matchQuality
enum<string>

Match level (EXACT, HOUSEHOLD_MATCH, etc.).

Available options:
EXACT,
HOUSEHOLD_MATCH,
PARTIAL_MATCH,
HOUSENUMBER_MATCH,
STREET_MATCH,
CITY_MATCH,
IDENTITY_MISMATCH,
NO_MATCH
Example:

"CITY_MATCH"

​
score
integer

Confidence score (0-100).

Required range: 0 <= x <= 100
Example:

50

​
globalResult
object
​
identity
object
​
extendedMessage
enum<string>

Detailed feedback.

Available options:
addressCorrected,
postCodeMatch,
localityMatch,
cityMatch,
districtMatch,
previousAddress,
incorrectAddress,
identityNotFound,
deceased,
addressFakeSuspicion,
noMatch,
skippedDOB,
dobPartial,
dobFailedFull,
lastNameOnly,
firstNameOnly,
NoCity,
NoStreet,
NoPostCode,
addressFound
Example:

"cityMatch"