GET
https://api.stableyard.fi
/
sdk
/
v1
/
check-username
curl -X GET "https://api.stableyard.fi/sdk/v1/check-username?username=alice" \
  -H "x-sdk-key: YOUR_API_KEY"

{
  "success": true,
  "data": {
    "message": "Username is available",
    "userNameExists": false
  },
  "requestId": "req_xyz789"
}
Verify if a username is available for registration. Always call this before /register to prevent conflicts.

​
Authentication

​
x-sdk-key
string
required
Your API authentication key

​
Query Parameters

​
username
string
required
The username to check availability for
​
partnerId
string
Partner namespace to check within
​
userId
string
Exclude this user from the check (for username updates)

​
Response

​
success
boolean
Indicates if the request was successful
​
data
object
Availability check result
curl -X GET "https://api.stableyard.fi/sdk/v1/check-username?username=alice" \
  -H "x-sdk-key: YOUR_API_KEY"

{
  "success": true,
  "data": {
    "message": "Username is available",
    "userNameExists": false
  },
  "requestId": "req_xyz789"
}

​
Username Rules

RuleRequirement
Length3-20 characters
CharactersAlphanumeric and underscores only
CaseCase-insensitive (Alice = alice)
UniquenessUnique within partner namespace