---
title: "Username Availability"
method: POST
path: "/v4/usernames/search"
tags: ["Gateway Features", "Users"]
---

# Username Availability

`POST /v4/usernames/search`

## Request

- Base URL: `https://sandbox.nmi.com/api`
- URL: `https://sandbox.nmi.com/api/v4/usernames/search`
- Auth: none required

<details>
<summary>Usage</summary>
This is optional, but you can check to make sure a username is available before submitting your merchant creation request.<br><br>
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.
</details>

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Request body

- CheckUsernameAvailabilityRequest
  - `username` string, required: String representing the username to check.
  - `type` string, required: String representing the type of account to check the username availability.

## Response `200`

Success

- CheckUsernameAvailabilityResponse
  - `username` string: String representing the username to check.
  - `available` boolean: Boolean representing if the username is available.

---

[API](https://skmtc.dev/nmi/apis/payments-api.md) - [All operations](https://skmtc.dev/nmi/apis/payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmi/apis/payments-api/revisions/c03727f27e27?raw)