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

eMail

string
Max length: 255

Email address

maskedFirstName

string
Max length: 50

Masked First name

maskedLastName

string
Max length: 50

Masked Last name

maskedMobileNumber

string
Max length: 20

Masked Mobile number

maskedEmail

string
Max length: 255

Masked Email address

languageCode

string

Enum:
NO
SV
FI
DA
EN
DE
NL
FR

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:
NO
SE
FI
DK
DE
AT
CH
NL
BE

Country code

companyName

string

maskedStreet

string
Max length: 200

maskedStreet2

string
Max length: 200

maskedStreet3

string
Max length: 200

maskedStreet4

string
Max length: 200

maskedPostalCode

string
Max length: 200

maskedCompanyName

string
type

string

Enum:
BusinessError
TechnicalError
NotificationMessage
code

string
Max length: 100

Confirmation or error code

message

string
Max length: 4096

Message content

customerFacingMessage

string
Max length: 4096

Message to display to customer
actionCode

string

Enum:
Unavailable
AskConsumerToConfirm
AskConsumerToReEnterData
OfferSecurePaymentMethods
RequiresSsn
AskConsumerToIdentify
ManualReview

Action codes
fieldReference

string
Max length: 100

Reference to field that caused an error
401 Authorization has been denied for this request.
413 Request body too large.
429 Too many requests.
500 Internal server error.

Successful Request

Request Example

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

Response Example

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