Skip to main content
GET
Check if a username is already registered

Headers

x-signature
string
required

Required for API-key authenticated requests. HMAC-SHA256(secretKey, timestamp + METHOD + path + body) as lowercase hex. Omit only for JWT/OAuth session tokens or public routes.

x-timestamp
string
required

Required with x-signature. Epoch milliseconds; rejected if drift exceeds 5 minutes. Omit only for JWT/OAuth session tokens or public routes.

Query Parameters

username
string
required

Username to check.

Example:

"alice_bob"

Response

Whether the username is already taken.

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload