Verify whether a username already exists within the membership database before creating a new member profile.
Membership Administration - Check Username
Overview
The Check Username operation checks a username against the membership database to determine whether it is already in use. The lookup is performed using a case-insensitive search, making this function useful when validating the uniqueness of a username prior to creating a new membership profile.
Request Parameters
Account Credentials
| Variable | Requirement | Type | Max Size | Possible Values / Example | Description |
|---|---|---|---|---|---|
publisher-name |
Mandatory | string | N/A | — | Gateway account username issued to you. |
publisher-password |
Mandatory | string | N/A | — | Remote Client Password. This is different than the password used to log in to the gateway. |
mode |
Mandatory | string | N/A | passwrdtest |
Value must be set to passwrdtest. |
Username Information
| Variable | Requirement | Type | Max Size | Possible Values / Example | Description |
|---|---|---|---|---|---|
username |
Mandatory | string | 12 | — | Customer username to validate. |
Response Parameters
The following response values are returned after the username validation request has been processed.
| Variable | Value | Description |
|---|---|---|
FinalStatus |
success, problem |
success indicates the username is available and may be used.problem indicates the username already exists and another username should be selected. |
MErrMsg |
string | Error message when applicable. |
Notes
Case-Insensitive Matching
Username comparisons are performed using a case-insensitive search. For example, the usernames JohnDoe, johndoe, and JOHNDOE are considered identical.
Username Availability
This function is commonly used during account registration workflows to verify username availability before submitting an add_member request.