Home > API > Common > Customer lookup

Customer lookup

Returns address based on input (Social security number, mobile number, Organization number).

PATH:

/api/v3/lookup/customer

REQUEST BODY SCHEMA:

email

string <= 255 characters

Customer email address

mobilePhone

string <= 20 characters

Phone number

countryCode

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

postalCode

string <= 15 characters

Postal code

identificationNumber

string <= 20 characters

Social security number / Organization number

customerNumber

string <= 100 characters

Customer number

customerCategory

string

Enum: Company Person

Customer category

RESPONSES:

200 OK

RESPONSE SCHEMA:

userProfiles

array of userProfiles

List of user profiles matching to lookup parameters

Array () [
firstName

string <= 50 characters

First name

lastName

string <= 50 characters

Last name

mobileNumber

string <= 20 characters

Mobile number

eMail

string <= 255 characters

Email address

maskedFirstName

string <= 50 characters

Masked First name

maskedLastName

string <= 50 characters

Masked Last name

maskedMobileNumber

string <= 20 characters

Masked Mobile number

maskedEmail

string <= 255 characters

Masked Email address

languageCode

string

Enum: NO SV SE FI DA DK EN DE NL FR

Language code

addressList

array of addressList

Array of LookupAddress objects

Array () [
street

string <= 200 characters

street2

string <= 200 characters

street3

string <= 200 characters

street4

string <= 200 characters

streetNumber

string <= 200 characters

flatNo

string <= 200 characters

entrance

string <= 200 characters

city

string <= 200 characters

postalCode

string <= 15 characters

postalCode will not be provided when doing lookup on Organization number

country

string <= 10 characters

countryCode

string

Enum: NO SE FI DK DE AT CH NL BE

companyName

string

maskedStreet

string <= 200 characters

maskedStreet2

string <= 200 characters

maskedStreet3

string <= 200 characters

maskedStreet4

string <= 200 characters

maskedPostalCode

string <= 200 characters

maskedCompanyName

string


]

]
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

post

/api/v3/lookup/customer

Request samples

  • {
    • "email": "string",
    • "mobilePhone": "string",
    • "countryCode": "string",
    • "postalCode": "string",
    • "identificationNumber": "string",
    • "customerNumber": "string",
    • "customerCategory": "string"
  • }

Response samples

200400
  • {
    • "userProfiles": [ ...
      • {
        • "firstName": "string",
        • "lastName": "string",
        • "mobileNumber": "string",
        • "eMail": "string",
        • "maskedFirstName": "string",
        • "maskedLastName": "string",
        • "maskedMobileNumber": "string",
        • "maskedEmail": "string",
        • "languageCode": "string",
        • "addressList": [ ...
          • {
            • "street": "string",
            • "street2": "string",
            • "street3": "string",
            • "street4": "string",
            • "streetNumber": "string",
            • "flatNo": "string",
            • "entrance": "string",
            • "city": "string",
            • "postalCode": "string",
            • "country": "string",
            • "countryCode": "string",
            • "companyName": "string",
            • "maskedStreet": "string",
            • "maskedStreet2": "string",
            • "maskedStreet3": "string",
            • "maskedStreet4": "string",
            • "maskedPostalCode": "string",
            • "maskedCompanyName": "string"
            }
          ]
        }
      ]
    }
  • [
      ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
    ]