Skip to main content
POST
/
address
/
verify
Verify Address
curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/address/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "<string>",
  "address": {
    "street": "<string>",
    "number": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "province": "<string>"
  },
  "identity": {
    "firstname": "<string>",
    "lastname": "<string>",
    "dob": "2001/10/25"
  }
}
'
{
  "finalAddress": "<string>",
  "addressStatus": "corrected",
  "matchQuality": "EXACT",
  "score": 50,
  "globalResult": {
    "overall": "OK",
    "totalScore": 50
  },
  "inputAddress": "<string>",
  "correctedAddress": "<string>",
  "addressComponents": {
    "street": "<string>",
    "number": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "province": "<string>",
    "country": "<string>"
  },
  "identity": {
    "fullName": "<string>",
    "dob": "<string>"
  },
  "extendedMessage": "addressCorrected"
}
For a usage description of the Address Verification Service, please refer to the Address Verification page.

​
Endpoint

POST /address/verify

​
Swagger

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).

Required string length: 2 - 3
​
address
object
required
​
identity
object
required

Response

Successfully verified address.

​
finalAddress
string
required

Final confirmed address.

​
addressStatus
enum<string>
required

Status after verification.

Available options:
corrected,
unchanged
​
matchQuality
enum<string>
required

Match level.

Available options:
EXACT,
HOUSEHOLD_MATCH,
PARTIAL_MATCH,
HOUSENUMBER_MATCH,
STREET_MATCH,
CITY_MATCH,
IDENTITY_MISMATCH,
NO_MATCH
​
score
integer<int32>
required

Confidence score (0-100).

Required range: 0 <= x <= 100
​
globalResult
object
required
​
inputAddress
string

Raw address provided.

​
correctedAddress
string

Corrected version of the address.

​
addressComponents
object

Detailed components of the final address.

​
identity
object

Details of the identity as found in the search.

​
extendedMessage
enum<string>

Detailed feedback.

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