These docs are for v2024.01.01. Click to read the latest docs for v2025.03.01.

Checks if a username is available to be used.

Checks if the supplied username is available to be used or if it is already linked to an existing customer.

Response CodeFault CodeFaultSuggested User Message
50090061SystemFailureFaultSystem Failure, please try again later
Body Params

The username being checked to see if it is available.

string
required
length ≤ 200

The username value to check.

Headers
uuid

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

uuid

The ID of the user requesting the operation. This will be automatically generated during the authentication process.

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
Choose an example:
application/json