Skip to main content
GET
/
v1
/
api
/
auth
/
check-username
Check username availability
curl --request GET \
  --url http://localhost:3091/v1/api/auth/check-username \
  --header 'Authorization: Bearer <token>'
{
  "username": "<string>",
  "available": true,
  "message": "<string>",
  "suggestions": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

JWT access token from POST /v1/api/auth/login

Query Parameters

username
string
required
firstname
string
lastname
string

Response

Availability check result returned

username
string
available
boolean
message
string
suggestions
string[]