API docs by Redocly

rbhopdog verify (1.0)

Download OpenAPI specification:Download

Description

This API verifies Discord users to Roblox users. This allows one to link their Discord account to their Roblox account. You can then retrieve verified accounts via the API.

Response Structure

Every response has the following:

Attribute Description
code The status code
errorCode A custom error code (refer to table below)
messages If there is an error, this is a list of messages describing what went wrong
result This contains data based on the request
status Either "ok" or "error"

API Keys

To retrieve users from the API via GET /v1/users/{discordId}, no API key is required. The other endpoints require an API key.

To include one, put it in the headers as api-key

Error Codes

errorCode is included in every response. It is an integer corresponding to an enum:

Value Title Description result
0 None No error occurred. Refer to endpoint documentation
1 Default An error occurred. This is a catch all. empty
2 Already Verified Tried to verify a user that was already verified. robloxId
3 Phrase Not Found Could not verify a user because their verification phrase was missing. phrase, expiresIn, robloxDescription, robloxId, robloxUsername
4 Verification Inactive Could not verify a user because they do not have verification active. empty

Get Roblox User From Discord

Retrieve a verified user's Roblox ID from their Discord ID. This endpoint has a rate limit of up to 300 per hour, and up to 3000 per day.

path Parameters
discordId
required
integer <int64>
Example: 161981786354745340

A discord user's ID (snowflake)

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "errorCode": 0,
  • "messages": [
    ],
  • "result": {
    },
  • "status": "ok"
}

Get Discord Users From Roblox

Retrieve a list of Discord user IDs that are linked to the given Roblox user ID.

Authorizations:
api-key
path Parameters
robloxId
required
integer <int64>
Example: 20005988

A roblox user's ID

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "errorCode": 0,
  • "messages": [
    ],
  • "result": {
    },
  • "status": "ok"
}

Begin Verification For A User

Begin the verification process for a user. Creates a unique phrase that users put into their About section on Roblox. POST /v1/verify/users/{discordId} can be used to verify that they have the phrase. Can give error code 2.

Authorizations:
api-key
path Parameters
discordId
required
integer <int64>

A discord user's ID (snowflake)

query Parameters
robloxId
required
integer <int64>

The roblox ID that the user wants to authenticate

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "errorCode": 0,
  • "messages": [
    ],
  • "result": {
    },
  • "status": "ok"
}

Try To Verify A User

Try to verify a user. The user must have had verification started via GET /v1/verify/users/{discordId}. This will check if their description contains the phrase needed for verification, and register them if so. Can give error codes 2-4.

Authorizations:
api-key
path Parameters
discordId
required
integer <int64>

A discord user's ID (snowflake)

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "errorCode": 0,
  • "messages": [
    ],
  • "result": {
    },
  • "status": "ok"
}

Remove A Verified User

Authorizations:
api-key
path Parameters
discordId
required
integer <int64>

A discord user's ID (snowflake)

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "errorCode": 0,
  • "messages": [
    ],
  • "result": {
    },
  • "status": "ok"
}