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

# Read session status

> Read a session's live consent status; poll this until it reports ``succeeded``.



## OpenAPI

````yaml /suite/api-reference/openapi.json get /digilocker-simple/v1/sessions/{session_id}/status
openapi: 3.1.0
info:
  title: Privue API Suite
  description: >-
    Identity and account verification against government and banking sources.


    **Authentication.** Every request takes your API key as a bearer token:
    `Authorization: Bearer <your-key>`. A successful call to a billed endpoint
    deducts one credit; a call that fails is not charged.


    **Versioning.** Each endpoint is versioned on its own, directly in its path.
    A new version of one endpoint never moves another, so no release requires
    migrating every integration at once.


    **Retention.** Nothing you send and nothing we return is stored. Documents
    are returned as the issuer's own download links, and the response is the
    only copy, so retrieve what you need when you receive it. We record that a
    call happened, for billing and audit, never what it was about.
  version: 1.0.0
servers:
  - url: https://api.privue.ai
    description: Production
security: []
paths:
  /digilocker-simple/v1/sessions/{session_id}/status:
    get:
      tags:
        - DigiLocker Simple
      summary: Read session status
      description: >-
        Read a session's live consent status; poll this until it reports
        ``succeeded``.
      operationId: digilocker_session_status
      parameters:
        - name: session_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{8,64}$
            description: session_id from the initiate-session response
            title: Session Id
          description: session_id from the initiate-session response
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionStatusResponse'
        default:
          description: The request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    SessionStatusResponse:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code of the response
        timestamp:
          type: integer
          title: Timestamp
          description: Unix millisecond timestamp of when the response was produced
        transaction_id:
          type: string
          title: Transaction Id
          description: Identifier for this call. Quote it when raising a query about one
        data:
          $ref: '#/components/schemas/SessionStatus'
      type: object
      required:
        - code
        - timestamp
        - transaction_id
        - data
      title: SessionStatusResponse
      description: Response to reading a session's status.
    ErrorResponse:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code of the response
        timestamp:
          type: integer
          title: Timestamp
          description: Unix millisecond timestamp of when the response was produced
        message:
          type: string
          title: Message
          description: What went wrong, in one sentence
        transaction_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Transaction Id
          description: >-
            Identifier for the call, present when it reached the source. Quote
            it when raising a query
      type: object
      required:
        - code
        - timestamp
        - message
      title: ErrorResponse
      description: Why a request failed.
    SessionStatus:
      properties:
        id:
          type: string
          title: Id
          description: The session this status is for
        created_at:
          type: integer
          title: Created At
          description: Unix millisecond timestamp of when the session was created
        status:
          type: string
          title: Status
          description: >-
            ``created`` until the user finishes granting consent, ``succeeded``
            once they have
      type: object
      required:
        - id
        - created_at
        - status
      title: SessionStatus
      description: >-
        Live state of a consent session.


        ``status`` is ``created`` until the user finishes granting consent and
        ``succeeded`` once they

        have; read the documents only after it reports ``succeeded``.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````