Skip to main content
GET
/
me
/
username
/
check
Check Username Availability
curl --request GET \
  --url https://api.veryfront.com/me/username/check \
  --header 'Authorization: Bearer <token>'
{
  "available": true,
  "username": "<string>",
  "reason": "invalid",
  "validation_error": "<string>",
  "suggestions": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Query Parameters

username
string
required

The username to check

Required string length: 1 - 39

Response

Username availability result

available
boolean
required
username
string
required
reason
enum<string>
Available options:
invalid,
reserved,
taken
validation_error
string
suggestions
string[]