API Reference
Explore SandboxPartner PortalMerchant Portal

Username Availability

post
https://sandbox.nmi.com/api/v4/usernames/search

Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

Usage This is optional, but you can check to make sure a username is available before submitting your merchant creation request.

This can be useful if you want to do form validation on your website to prevent the user from entering a username that has already been taken.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

String representing the username to check.

string
required

String representing the type of account to check the username availability.

Headers
string
required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

string
required

Your v4 API key that was generated in the Partner portal.

Response

Updated 6 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago