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

# Username Availability

`POST /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.
<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.net/nmi/apis/embedded-components-api.md) · [All operations](https://skmtc.net/nmi/apis/embedded-components-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmi/embedded-components-api/versions/45c2ecda3685/schema)