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:
- 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.
Request
Header Parameters
Must be application/json
Must be be en-US
The origin of the request
The client making the request
- application/json
Body
required
Possible values: <= 127 characters
The first line of the address.
Possible values: <= 10 characters
The house number of the address.
Possible values: <= 10 characters
The postal code of the address.
Possible values: <= 64 characters
The city of the address.
Possible values: <= 2 characters
The country code of the address (ISO 3166-1 alpha-2 format).
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Successful response with address validation results.
- application/json
- Schema
- Example (from schema)
- Example
Schema
HOUSE_CONFIRMED
: The address could be confirmed. Perfect match between provided address andfoundAddress
.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.
addressCheckData
object
The archive ID of the address check.
Possible values: [HOUSE_CONFIRMED
, STREET_CONFIRMED_HOUSE_NOT_IDENTIFIED
, STREET_CONFIRMED_HOUSE_NOT_PROVIDED
, CITY_CONFIRMED_STREET_NOT_IDENTIFIED
, NOT_CONFIRMED
]
The decision made on the address validation. Possible values:
Indicates if the postal code is correct.
normalizedAddress
object
Possible values: <= 60 characters
Street name.
Possible values: <= 60 characters
Apartment, suite, unit, building, floor or other secondary address information.
Possible values: <= 60 characters
Specific delivery instructions, department names, or additional floor information.
Possible values: <= 50 characters
The city or localitly of the address.
Possible values: >= 3 characters
and <= 3 characters
ISO-3 code of the address country (e.g., DEU for Germany).
Possible values: <= 10 characters
The house or building number corresponding to the street address.
Possible values: <= 10 characters
The postal or ZIP code of the address.
Possible values: <= 3 characters
3-letter code of the address state. Mandatory when countryCode
corresponds to Canada or USA.
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
.
Possible values: <= 60 characters
Street name.
Possible values: <= 60 characters
Apartment, suite, unit, building, floor or other secondary address information.
Possible values: <= 60 characters
Specific delivery instructions, department names, or additional floor information.
Possible values: <= 50 characters
The city or localitly of the address.
Possible values: >= 3 characters
and <= 3 characters
ISO-3 code of the address country (e.g., DEU for Germany).
Possible values: <= 10 characters
The house or building number corresponding to the street address.
Possible values: <= 10 characters
The postal or ZIP code of the address.
Possible values: <= 3 characters
3-letter code of the address state. Mandatory when countryCode
corresponds to Canada or USA.
The date and time of the request.
The response code of the request.
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.
The unique request ID.
{
"addressCheckData": {
"archiveId": "string",
"decision": "HOUSE_CONFIRMED",
"postalCodeCorrect": true,
"normalizedAddress": {
"addressLine1": "Max-Planck-Straße",
"addressLine2": "string",
"addressLine3": "string",
"city": "Berlin",
"countryCode": "DEU",
"number": 30,
"postCode": 14473,
"state": "string"
},
"foundAddress": {
"addressLine1": "Max-Planck-Straße",
"addressLine2": "string",
"addressLine3": "string",
"city": "Berlin",
"countryCode": "DEU",
"number": 30,
"postCode": 14473,
"state": "string"
}
},
"requestDateTime": "2024-07-29T15:51:28.071Z",
"responseCode": "string",
"responseDescription": "string",
"additionalInformation": {
"requestId": "string"
}
}
{
"addressCheckData": {
"archiveId": "4614062516381318",
"decision": "HOUSE_CONFIRMED",
"postalCodeCorrect": true,
"normalizedAddress": {
"addressLine1": "Leopoldstr.",
"number": "244",
"houseExtension": "",
"postCode": "80807",
"city": "München",
"countryCode": "DEU"
},
"foundAddress": {
"addressLine1": "Leopoldstr.",
"number": "244",
"houseExtension": "",
"postCode": "80807",
"city": "München",
"countryCode": "DEU"
}
},
"requestDateTime": "2023-06-02T15:46:59.000Z",
"responseCode": "0000",
"responseDescription": "Successful execution.",
"additionalInformation": {
"requestId": "3cc82a300ea140a48132c9852f749e2c"
}
}
Bad Request
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "Value out of bounds. Value must be between 1 and 100",
"code": "value_out_of_bounds",
"property": "someField",
"context": {
"minimum": 1,
"maximum": 100
}
}
]
}
Unauthenticated
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "You are not authenticated to perform this request.",
"code": "unauthorized"
}
]
}
Forbidden
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "You do not have permissions to perform this request.",
"code": "forbidden"
}
]
}
Not Found
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "Resource not found.",
"code": "not_found"
}
]
}
Internal Server Error
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "Internal server error."
}
]
}