Locate customer.

post

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

Search for a customer. This search matches the exact terms in the request and returns a single result if a match is located.

Response Code	Fault Code	Fault	Suggested User Message
tbc	tbc	New API created for 1.5	tbc

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The search details used to locate the customer.

Minimal customer details used when searching.

customerId

uuid

The unique customer identifier.

externalUniqueIdentifier

string

length ≤ 200

The unique external customer identifier.

string

length ≤ 200

The customers email address.

referAFriendCode

string

length ≤ 8

The customers Refer a Friend code.

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

enum

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.

Allowed:

Responses

200OK

400Bad request

404No customer found