Skip to main content
GET
https://api.docksys.xyz
/
v2
/
sessions
/
{id}
Get verification session status
curl --request GET \
  --url https://api.docksys.xyz/v2/sessions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "data": {
    "id": "<string>",
    "pid": "<string>",
    "clientId": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "verifyUrl": "<string>",
    "reusedExisting": true,
    "guildId": "<string>",
    "statusReason": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "terminalAt": "2023-11-07T05:31:56Z",
    "result": {
      "discordId": "<string>",
      "robloxId": "<string>",
      "verifiedAt": "2023-11-07T05:31:56Z",
      "linkChanged": true,
      "previousRobloxId": "<string>",
      "linkVersion": 123,
      "linkHash": "<string>"
    }
  },
  "meta": {
    "requestId": "req_9d7b8c6a5f4e",
    "version": "2.0.0",
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetAt": "2023-11-07T05:31:56Z",
      "retryAfter": 123,
      "scope": "api_key",
      "bucket": "sessions_create"
    }
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Dock API key. Send Authorization: Bearer <api key>.

Path Parameters

id
string
required

Verification session ID.

Example:

"vsn_X8m2pLq9Tn4bR6sYzA0wQ1"

Query Parameters

wait
integer
default:0

Optional long-poll wait in seconds. Maximum is 25 seconds.

Required range: 0 <= x <= 25

Response

Verification session status returned.

status
integer
required
Example:

200

data
object
required

Endpoint-specific response payload.

meta
object
required
timestamp
string<date-time>
required