Address Validation

Last changes: 08-07-2023

We provide an API for real time address validation to verify and to get address correction suggestions. It validates addresses for its correctness and instantly offers corrections and standardizes and appends addresses.

The address validation is performed in two steps:

Supporting the customer after entering place and street and sending the data by using “suggestion” mechanisms,
Final check/validation of the address (incl. house number), i.e. “Is this address correct?”

The end customer can accept or ignore the suggested address. For this, a corresponding front-end feature should be implemented by the acceptance point / market place operator.

Perform an Address Validation

You can easily perform an address validation by sending the API request 1.105 Perform Address Check with all necessary address information such as the city, street, etc.

Address Validation Request

Path:: POST {baseURL}/compliance/addressCheck
Header:: Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
  "partnerReference": "ADDRESS-CHECK-D4CE1ABB1676E3DF5BB44",
  "programCode": "COMPANY123",
  "street": "ANystreet.",
  "house": "321",
  "postalCode": "12345",
  "city": "Anycity",
  "line2": null,
  "line3": null,
  "countryCode": "DE",
  "localDate": "2018-11-21",
  "localTime": "163835"
}

Address Validation Response

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "partnerReference": "ADDRESS-CHECK-D4CE1ABB1676E3DF5BB44",
    "programCode": "COMPANY123",
    "addressCheckData":
    {
        "archiveId": "4742000025020093",
        "decision": "HOUSE_CONFIRMED",
        "postalCodeCorrect": true,
        "normalizedAddress":
        {
            "street": "Anystreet",
            "house": "321",
            "houseExtension": "",
            "postalCode": "12345",
            "city": "Anycity",
            "countryCode": "DE"
        },
        "foundAddress":
        {
            "street": "Anystreet",
            "house": "321",
            "houseExtension": "",
            "postalCode": "12345",
            "city": "Anycity",
            "countryCode": "DE"
        }
    },
    "localDate": "2018-11-21",
    "localTime": "163835",
    "sysDate": "2018-11-21",
    "sysTime": "153837",
    "responseCode": "0000",
    "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

The “foundAddress” shows the best match found for the provided address information.

The result of the address check is summarized in the response parameter “decision” and allows the following options:

Value	Explanation
“HOUSE_CONFIRMED”	The address could be confirmed. Perfect match between provided address and “foundAddress”.
“STREET_CONFIRMED_HOUSE_NOT_IDENTIFIED”	The address could be confirmed all the way down to the street, but the provided house number could not be identified.
“STREET_CONFIRMED_HOUSE_NOT_PROVIDED”	The address could be confirmed all the way down to the street, but no house number was provided in the API request.
“CITY_CONFIRMED_STREET_NOT_IDENTIFIED”	The address could be confirmed all the way down to the city, but the provided street could not be identified.
“NOT_CONFIRMED”	The address could not be confirmed.

Previous

Next