Skip to main content
POST
https://api.docksys.xyz
/
v2
/
sessions
Create a verification session
curl --request POST \
  --url https://api.docksys.xyz/v2/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pid": "PID-AB12CD34",
  "clientId": "checkout-session-8842",
  "guildId": "987654321098765432"
}
'
{
  "status": 200,
  "data": {
    "id": "<string>",
    "pid": "<string>",
    "clientId": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "verifyUrl": "<string>",
    "reusedExisting": true,
    "guildId": "<string>",
    "statusReason": "<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>.

Headers

Idempotency-Key
string

Unique key for safely retrying session creation requests.

Maximum string length: 128

Body

application/json
pid
string
required
Example:

"PID-AB12CD34"

clientId
string
required

Developer-defined identifier for the user or flow you are verifying.

guildId
string | null

Response

Verification session created or existing pending session reused.

status
integer
required
Example:

200

data
object
required

Endpoint-specific response payload.

meta
object
required
timestamp
string<date-time>
required