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

customer

required

object

Checkout customer. Can be remitter or receiver of the order.

identificationNumber

string

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

address

object

Customer address

legalForm

string

Type of business. Required for Austria, Germany and Switzerland.

riskData

object

existingCustomer

boolean

Is customer an existing customer for merchant

verifiedCustomerIdentification

boolean

Is identification verified

marketingOptIn

boolean

Shows if merchant is allowed to send marketing information to customer

customerSince

string

Since when customer has been merchant's client

customerClassification

string

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Customer acquisition channel

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string

The date when the loyalty card was issued to the customer

customerCardClassification

string

Specifies the level of the loyalty card (e.g Gold member). For DE, AT, CH, this must be an integer from 1 to 5, where 5 is the highest VIP level.

profileTrackingId

string

Unique Id of the device for profile tracking

ipAddress

string

Customer’s IP address

numberOfTransactions

integer

Total number of successful purchases that have been made by the specific consumer

customerIndividualScore

string

The customer's individual risk score provided by the merchant. Accepts a number from -10000 to 10000 (can be encased in quotation marks or not), or a single case-insensitive letter from 'a' to 'z'.

userAgent

string

UserAgent of this specific consumer

amountOfTransactions

number

Amount of paid orders last 12 months

otherPaymentMethods

boolean

Other payment method than MI in wallet

customerNumber

string

Customer number has to be unique, if no customer number available please leave empty

salutation

string

Salutation

firstName

string

First name. Everything over 50 characters will be truncated

lastName

string

Last name. Everything over 255 characters will be truncated

companyName

string

Purchasing company name. Everything over 255 characters will be truncated. This field is mandatory for processing B2B transactions in Austria, Belgium, Germany, the Netherlands and Switzerland.

string

phone

string

Phone

mobilePhone

string

Mobile phone

birthDate

required

string

Date of birth. Not required if customerCategory is 'Company'.

customerCategory

required

string

Customer category

conversationLanguage

string

Language code

distributionType

string

How information (invoices, notices, etc.) will be distributed to customer.

vatId

string

VAT registration number, the unique number that identifies a business. This field is mandatory for processing B2B transactions in Austria, Germany and Switzerland.

Responses

Successful Request

Response Example

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

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"
 }
}