Skip to main content

Address Validation

POST 

/compliance/address-validation

This endpoint performs address validation. It validates addresses for correctness, offers corrections, and standardizes and appends addresses.

The address validation is performed in two steps:

  1. Supporting the customer after entering place and street and sending the data by using "suggestion" mechanisms.
  2. 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.

Request​

Header Parameters

    Content-Type stringrequired

    Must be application/json

    Accept-Language stringrequired

    Must be be en-US

    Origin stringrequired

    The origin of the request

    User-Agent stringrequired

    The client making the request

Bodyrequired

    addressLine1stringrequired

    The first line of the address.

    Possible values: <= 127 characters

    numberstringrequired

    The house number of the address.

    Possible values: <= 10 characters

    postCodestringrequired

    The postal code of the address.

    Possible values: <= 10 characters

    citystringrequired

    The city of the address.

    Possible values: <= 64 characters

    countryCodestringrequired

    The country code of the address (ISO 3166-1 alpha-2 format).

    Possible values: <= 2 characters

Responses​

Successful response with address validation results.

Schema
    addressCheckData object
    archiveIdstring

    The archive ID of the address check.

    decisionstring


    The decision made on the address validation. Possible values:

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

    Possible values: [HOUSE_CONFIRMED, STREET_CONFIRMED_HOUSE_NOT_IDENTIFIED, STREET_CONFIRMED_HOUSE_NOT_PROVIDED, CITY_CONFIRMED_STREET_NOT_IDENTIFIED, NOT_CONFIRMED]

    postalCodeCorrectboolean

    Indicates if the postal code is correct.

    normalizedAddress object
    addressLine1stringrequired

    Street name.

    Possible values: <= 60 characters

    Example: Max-Planck-Straße
    addressLine2string

    Apartment, suite, unit, building, floor or other secondary address information.

    Possible values: <= 60 characters

    addressLine3string

    Specific delivery instructions, department names, or additional floor information.

    Possible values: <= 60 characters

    citystringrequired

    The city or localitly of the address.

    Possible values: <= 50 characters

    Example: Berlin
    countryCodestringrequired

    ISO-3 code of the address country (e.g., DEU for Germany).

    Possible values: >= 3 characters and <= 3 characters

    Example: DEU
    numberstring

    The house or building number corresponding to the street address.

    Possible values: <= 10 characters

    Example: 30
    postCodestringrequired

    The postal or ZIP code of the address.

    Possible values: <= 10 characters

    Example: 14473
    statestring

    3-letter code of the address state. Mandatory when countryCode corresponds to Canada or USA.

    Possible values: <= 3 characters

    foundAddress object

    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.

    addressLine1stringrequired

    Street name.

    Possible values: <= 60 characters

    Example: Max-Planck-Straße
    addressLine2string

    Apartment, suite, unit, building, floor or other secondary address information.

    Possible values: <= 60 characters

    addressLine3string

    Specific delivery instructions, department names, or additional floor information.

    Possible values: <= 60 characters

    citystringrequired

    The city or localitly of the address.

    Possible values: <= 50 characters

    Example: Berlin
    countryCodestringrequired

    ISO-3 code of the address country (e.g., DEU for Germany).

    Possible values: >= 3 characters and <= 3 characters

    Example: DEU
    numberstring

    The house or building number corresponding to the street address.

    Possible values: <= 10 characters

    Example: 30
    postCodestringrequired

    The postal or ZIP code of the address.

    Possible values: <= 10 characters

    Example: 14473
    statestring

    3-letter code of the address state. Mandatory when countryCode corresponds to Canada or USA.

    Possible values: <= 3 characters

    requestDateTimestring<date-time>

    The date and time of the request.

    responseCodestring

    The response code of the request.

    responseDescriptionstring

    Description of the response.

    additionalInformation object

    Contains diagnostic or tracking metadata returned with the API response. It is primarily used for support, logging and troubleshooting purposes.

    requestIdstring

    The unique request ID.