This API allows you to check the availability of a user in the system by providing a username. The API requires authentication via an API key passed in the request headers.
All API requests must include the X-API-KEY header with your valid API key.
Check if a user exists in the system by username.
| Parameter | Type | Required | Description |
|---|---|---|---|
| username | string | Required | The username to check for availability |
| Header | Type | Required | Description |
|---|---|---|---|
| X-API-KEY | string | Required | Your API key for authentication |
| Status Code | Description | Response Body |
|---|---|---|
| 200 | User exists |
{
"Success": true,
"message": "User exists"
}
|
| 404 | User not found |
{
"Success": false,
"message": "User not found"
}
|
| 401 | Unauthorized |
{
"detail": "Unauthorized"
}
|
| 500 | Internal Server Error |
{
"detail": "Internal Server Error"
}
|
The API returns standard HTTP status codes to indicate success or failure:
| Status Code | Meaning | Possible Reasons |
|---|---|---|
| 200 | OK | Request was successful |
| 401 | Unauthorized | Missing or invalid API key |
| 404 | Not Found | User does not exist |
| 500 | Internal Server Error | Server encountered an unexpected condition |