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

Response

200
application/json
Successfully verified address.

The response is of type object.