v6 documentation is incomplete, want to contribute?

Check User Exists

Checks if a user by a given username, displayName or email exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the excludeUserId is used to exclude oneself, otherwise the result would always be true.

It is REQUIRED to include AT LEAST username, displayName or email query parameter. Although they can be combined - in addition with excludeUserId (generally to exclude yourself) - to further fine-tune the search.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

GET
/auth/exists

Query Parameters

email?string

Filter by email.

displayName?string

Filter by displayName.

username?string

Filter by Username.

excludeUserId?string

Exclude by UserID.

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/auth/exists?email=string&displayName=string&username=string&excludeUserId=string"
{
  "userExists": false,
  "nameOk": false
}

{
  "error": {
    "message": "\"username, email, or displayName required\"",
    "status_code": 400
  }
}