Customer LookUp

Returns address based on input (Social security number, mobile number, Organization number). Customer LookUp is only supported in the Nordics. Please see Customer LookUp for more details.

Path

POST /api/v3/lookup/customer

Request Body

application/json

string

Max length: 255

Customer email address

mobilePhone

string

Max length: 20

Phone number

countryCode

string

Enum:

Country code

postalCode

string

Max length: 15

Postal code

identificationNumber

string

Max length: 20

Social security number / Organization number

customerNumber

string

Max length: 100

Customer number

customerCategory

string

Enum:

Company

Person

Customer category

Responses

array

List of user profiles matching to lookup parameters

firstName

string

Max length: 50

First name

lastName

string

Max length: 50

Last name

mobileNumber

string

Max length: 20

Mobile number

string

Max length: 255

Email address

maskedFirstName

required in

string

Max length: 50

Masked First name

maskedLastName

required in

string

Max length: 50

Masked Last name

maskedMobileNumber

required in

string

Max length: 20

Masked Mobile number

maskedEmail

required in

string

Max length: 255

Masked Email address

languageCode

string

Enum:

The language code used for client communication. If not provided, the system will default to the language configured for the client.

array

Array of LookupAddress objects

street

string

Max length: 200

street2

string

Max length: 200

street3

string

Max length: 200

street4

string

Max length: 200

streetNumber

string

Max length: 200

flatNo

string

Max length: 200

entrance

string

Max length: 200

city

string

Max length: 200

postalCode

string

Max length: 15

postalCode will not be provided when doing lookup on Organization number

country

string

Max length: 10

countryCode

string

Enum:

Country code

companyName

string

maskedStreet

required in

string

Max length: 200

maskedStreet2

required in

string

Max length: 200

maskedStreet3

required in

string

Max length: 200

maskedStreet4

required in

string

Max length: 200

maskedPostalCode

required in

string

Max length: 200

maskedCompanyName

required in

string

Successful Request

Request Example

    
        {
 "identificationNumber": "12345678900",
 "customerCategory": "Person"
}

Response Example

    
        {
 "userProfiles": [
  {
   "firstName": "Astrid",
   "lastName": "Svensson",
   "mobileNumber": "01234567",
   "eMail": "astrid.svensson@example.com",
   "maskedFirstName": "Ast***",
   "maskedLastName": "Sve*****",
   "maskedMobileNumber": "*****567",
   "maskedEmail": "astri*************@example.com",
   "addressList": [
    {
     "street": "Gütersloher Straße",
     "streetNumber": "123",
     "city": "Berlin",
     "postalCode": "33415",
     "country": "Germany",
     "countryCode": "DE",
     "maskedStreet": "G**** Straß*",
     "maskedPostalCode": "415"
    }
   ]
  }
 ]
}