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

# Get browser session

> Retrieves the current status and results of a browser session. Poll this endpoint to detect completion or check verification results.



## OpenAPI

````yaml /api-reference/openapi.json get /partner/browser-session/{id}
openapi: 3.1.0
info:
  title: Cr3dentials Partner API
  description: >-
    Integrate account verification into your application. Users verify their
    accounts through an iframe-based browser session, and you receive
    cryptographically attested proof of data authenticity.
  version: 1.0.0
  contact:
    name: Cr3dentials Support
    url: https://cr3dentials.xyz
servers:
  - url: https://app.cr3dentials.xyz/v1
    description: Production
  - url: https://staging.cr3dentials.xyz/v1
    description: Staging
security:
  - apiKey: []
paths:
  /partner/browser-session/{id}:
    get:
      tags:
        - Sessions
      summary: Get browser session
      description: >-
        Retrieves the current status and results of a browser session. Poll this
        endpoint to detect completion or check verification results.
      operationId: getBrowserSession
      parameters:
        - name: id
          in: path
          required: true
          description: The `sessionId` returned from session creation.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Session details
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    $ref: '#/components/schemas/SessionDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    SessionDetail:
      type: object
      properties:
        sessionId:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/SessionStatus'
        progress:
          type: integer
          description: Verification progress (0–100).
          example: 100
        embedUrl:
          type: string
        streamUrl:
          type:
            - string
            - 'null'
          description: WebSocket stream URL when the session is active.
        platformId:
          type: integer
        platform:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
            displayName:
              type: string
            icon:
              type:
                - string
                - 'null'
            loginUrl:
              type: string
        expiresAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        completedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Only for terminal states.
        errorMessage:
          type:
            - string
            - 'null'
          description: Only when `status` is `ERROR`.
        errorCode:
          type:
            - string
            - 'null'
          description: Machine-readable error code, only when `status` is `ERROR`.
        hasAttestation:
          type: boolean
          description: '`true` when a cryptographic attestation exists for this session.'
        extractedData:
          type:
            - object
            - 'null'
          description: Verified account data, only when verification is complete.
          additionalProperties: true
    SessionStatus:
      type: string
      description: Lifecycle status of a verification session.
      enum:
        - CREATED
        - INITIALIZING
        - READY
        - CONNECTED
        - LOADING_TREE
        - RUNNING
        - AWAITING_USER
        - COLLECTING_DATA
        - VERIFYING
        - COMPLETED
        - PARTIAL_COMPLETE
        - ERROR
        - CANCELLED
        - TERMINATED
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          example:
            statusCode: 401
            message: Unauthorized
    NotFound:
      description: Session not found
      content:
        application/json:
          example:
            statusCode: 404
            message: Session not found
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: 'Your partner API key. Alternatively, pass `Authorization: Bearer <key>`.'

````