riverty logo

Docs

Get Started Login

Validate Address

Check the delivered customer addresses as well as a phonetic and associative identification of duplicates. Additionally, checks of client-specific negative or positive lists can be processed. Usually, the AddressCheck is used for the pure verification of the address data e.g. for registration processes.

Path

POST /api/v3/validate/address

Request Body

application/json

required
object
The person initiating the checkout, typically the buyer who places the order. May also receive the order.

Responses

Successful Request

Request Example

    
        {
 "customer": {
  "address": {
   "street": "Gütersloher Straße",
   "streetNumber": "123",
   "postalCode": "33415",
   "postalPlace": "Berlin",
   "countryCode": "DE"
  },
  "riskData": {
   "ipAddress": "123.123.123.123"
  },
  "firstName": "Astrid",
  "lastName": "Svensson",
  "email": "astrid.svensson@example.com",
  "birthDate": "1999-01-02",
  "customerCategory": "Person"
 }
}
    

Response Example

    
        {
 "isValid": true,
 "correctedAddress": {
  "street": "Gütersloher Str.",
  "streetNumber": "123",
  "postalCode": "33415",
  "postalPlace": "Verl",
  "countryCode": "DE"
 }
}