> ## Documentation Index
> Fetch the complete documentation index at: https://docs.docksys.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Stream verification session status

> Opens a Server-Sent Events stream for a verification session. The stream emits `session` events and closes when the session reaches a terminal state or after 30 seconds.



## OpenAPI

````yaml /api/openapi-v2.json get /v2/sessions/{id}/stream
openapi: 3.1.0
info:
  title: Dock API v2
  version: 2.0.0
  summary: >-
    Discord to Roblox verification, account linking, alt detection, API key
    management, and bot configuration.
  description: >-
    API v2 is the recommended Dock API for new integrations. It uses consistent
    response envelopes, stable error codes, request IDs, rate-limit metadata,
    and first-class bulk endpoints.


    Use the API only for legitimate verification, moderation, analytics, and
    automation workflows. Do not scrape, bypass rate limits, rotate keys or IPs
    to avoid limits, resell the service, or use detection outputs as definitive
    proof of wrongdoing. By using Dock, you agree to the Terms of Service and
    Privacy Policy.
  termsOfService: https://docksys.xyz/terms
  contact:
    name: Dock Support
    url: https://docksys.xyz/discord
  license:
    name: Dock Terms of Service
    url: https://docksys.xyz/terms
servers:
  - url: https://api.docksys.xyz
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Lookups
    description: >-
      Read account links, verification status, and Premium alt detection
      results.
  - name: Bulk
    description: Run ordered batch lookups with per-item results.
  - name: Verification Sessions
    description: Create hosted verification sessions and read completion state.
  - name: Writes
    description: Create, update, or delete account-link data in the current API-key scope.
externalDocs:
  description: Privacy Policy
  url: https://docksys.xyz/privacy
paths:
  /v2/sessions/{id}/stream:
    get:
      tags:
        - Verification Sessions
      summary: Stream verification session status
      description: >-
        Opens a Server-Sent Events stream for a verification session. The stream
        emits `session` events and closes when the session reaches a terminal
        state or after 30 seconds.
      operationId: getV2SessionStream
      parameters:
        - $ref: '#/components/parameters/SessionIdPath'
      responses:
        '200':
          description: SSE stream opened.
          content:
            text/event-stream:
              schema:
                type: string
                example: |+
                  event: session
                  data: {"id":"vsn_X8m2pLq9Tn4bR6sYzA0wQ1","status":"pending"}

        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    SessionIdPath:
      name: id
      in: path
      required: true
      description: Verification session ID.
      schema:
        type: string
        example: vsn_X8m2pLq9Tn4bR6sYzA0wQ1
  responses:
    BadRequest:
      description: The request is missing required input or contains invalid input.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2ErrorEnvelope'
    Unauthorized:
      description: The API key is missing, invalid, expired, revoked, or suspended.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2ErrorEnvelope'
          example:
            status: 401
            error:
              code: INVALID_API_KEY
              message: Invalid API key.
              details: null
            meta:
              requestId: req_9d7b8c6a5f4e
              version: 2.0.0
              rateLimit:
                limit: null
                remaining: null
                resetAt: null
                retryAfter: null
                scope: null
            timestamp: '2026-05-07T16:30:00.000Z'
    NotFound:
      description: >-
        The requested link, session, key, config item, or guild resource was not
        found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2ErrorEnvelope'
    InternalError:
      description: Dock could not complete the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2ErrorEnvelope'
  schemas:
    V2ErrorEnvelope:
      type: object
      required:
        - status
        - error
        - meta
        - timestamp
      properties:
        status:
          type: integer
          example: 429
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              example: RATE_LIMITED
            message:
              type: string
              example: Too many requests. Please retry after 1 seconds.
            details:
              nullable: true
              additionalProperties: true
        meta:
          $ref: '#/components/schemas/V2Meta'
        timestamp:
          type: string
          format: date-time
    V2Meta:
      type: object
      required:
        - requestId
        - version
        - rateLimit
      properties:
        requestId:
          type: string
          example: req_9d7b8c6a5f4e
        version:
          type: string
          example: 2.0.0
        rateLimit:
          $ref: '#/components/schemas/RateLimitMeta'
        tier:
          type: string
          enum:
            - free
            - premium
          description: Present on API-key authenticated developer endpoints.
      additionalProperties: true
    RateLimitMeta:
      type: object
      required:
        - limit
        - remaining
        - resetAt
        - retryAfter
        - scope
      properties:
        limit:
          type: integer
          nullable: true
        remaining:
          type: integer
          nullable: true
        resetAt:
          type: string
          format: date-time
          nullable: true
        retryAfter:
          type: integer
          nullable: true
        scope:
          type: string
          nullable: true
          example: api_key
        bucket:
          type: string
          nullable: true
          example: sessions_create
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Dock API key. Send `Authorization: Bearer <api key>`.'

````