username-available.md

username-available

API Example

{% swagger method="get" path="/username-available" baseUrl="https://api.brickverse.co/v2/user" summary="Information" %} {% swagger-description %} API used to check avaliablity of a username on registration & username changes. {% endswagger-description %}

{% swagger-parameter in="path" name="username" type="String" required="true" %}

{% endswagger-parameter %}

{% swagger-response status="200: OK" description="Response" %}

{"status": "ok", "available": boolean}

{% endswagger-response %}

{% swagger-response status="403: Forbidden" description="" %}

{"status": "error"}

{% endswagger-response %}

{% swagger-response status="429: Too Many Requests" description="" %}

{"status": "error", "message": "Rate limited", "ratelimited": true, "time": "seconds_string"}

{% endswagger-response %} {% endswagger %}

Bad Reference ID (bad_ref_id)

bad_ref_id	reason
1	Invalid username length or not alphanumberic.
2	Username taken
3	Username blacklisted