Customer lookup
PATH:
/api/v3/lookup/customer
REQUEST BODY SCHEMA:
string <= 255 characters Customer email address | |
mobilePhone | string <= 20 characters Phone number |
countryCode | string Enum:NOSEFIDKDEATCHNLBE 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:CompanyPerson Customer category |
RESPONSES:
RESPONSE SCHEMA:
array of userProfiles List of user profiles matching to lookup parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array () [
|
RESPONSE SCHEMA:
type | string Enum:BusinessErrorTechnicalErrorNotificationMessage 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:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify Possible next action to make |
fieldReference | string <= 100 characters Reference to field that caused an error |
Path
/api/v3/lookup/customer
Request samples
- {
- "email": "string",
- "mobilePhone": "string",
- "countryCode": "string",
- "postalCode": "string",
- "identificationNumber": "string",
- "customerNumber": "string",
- "customerCategory": "string"
Response samples
- {
- "userProfiles": [ { ... } ]
- {
- "type": "string",
- "code": "string",
- "message": "string",
- "customerFacingMessage": "string",
- "actionCode": "string",
- "fieldReference": "string"