Create customer.

post https://virtserver.swaggerhub.com/customers/v1/customer

Registers a new customer in the system.

Response Code	Fault Code	Fault	Suggested User Message
400	90038	MandatoryContactMethodMissingFault	Contact Method Required
400	90026	InvalidPostcodeFault	Postcode provided is incorrect
400	90075	UsernameRequiredFailureFault	No Username provided
400	90044	PasswordRequiredFault	No Password provided
400	90073	UnsafePasswordScoreFault	Provided Password does not meet minimum secure requirements
404	90066	UnknownConsentFault	ConsentId provided does not exist
404	90019	InvalidCurrencyCodeFault	Currency code provided does not exist
404	90067	UnknownContactMethodFault	Contact Method provided does not exist
400	90030	InvalidUsernameFailureFault	Username provided is invalid
500	90061	SystemFailureFault	System Failure, please try again later
400	90037	MandatoryConsentMissingFault	Consent Method Required
400	90074	UsernameExistsFailureFault	Username Provided already exists
400	90055	RegistrationFailureFault	Registration cannot be completed at this time
400	90020	InvalidDateOfBirthFault	Date of Birth provided is incorrect

Body Params

The customer information to store.

externalUniqueIdentifier

string

length ≤ 200

The unique external customer identifier.

username

string

required

length ≤ 200

The customers username.

password

string

length ≤ 200

The customers password.

string

required

length ≤ 200

The customers email address.

title

string

required

length ≤ 20

The customers title.

firstName

string

length ≤ 50

The customers forename.

lastName

string

required

length ≤ 50

The customers surname.

dateOfBirth

date

The customers date of birth, format must be [YYYY-MM-DD].

phone

string

length ≤ 20

The customers phone number.

mobile

string

length ≤ 20

The customers mobile phone number.

addresses

array of objects

length ≤ 1

The list of addresses associated with the customer.

addresses

consents

object

The entities that have been provided with consent to process the customers data.

customAttributes

array of objects

The bespoke client fields associated with the customer.

customAttributes

displayName

string

The name to be displayed for this customer

customerType

string

Indicates the type of customer, normally Standard or VIP but additional types may be available if configured.

defaultCurrency

string

The currency in which the customer will purchase.

gender

string

The customer's optionally declared gender

nationality

string

The customer's nationality.

Headers

tenantId

string

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

userId

string

The ID of a user who is performing the operation. This will be automatically generated during the authentication process.

source

string

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://virtserver.swaggerhub.com/customers/v1/customer \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

201Create customer request successful.

400Bad request

422Unable to create customer.