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

# Read filing pre-review progress

> Read persisted status for every check and links to its session and comments. Requires filing read access. No agent transcript parsing is required.



## OpenAPI

````yaml /openapi.json get /insurance/managed-filings/{filingId}/pre-reviews/{sessionId}
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/managed-filings/{filingId}/pre-reviews/{sessionId}:
    get:
      tags:
        - Managed Filing Checks
      summary: Read filing pre-review progress
      description: >-
        Read persisted status for every check and links to its session and
        comments. Requires filing read access. No agent transcript parsing is
        required.
      operationId: getManagedFilingPreReview
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: filingId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: sessionId
          in: path
      responses:
        '200':
          description: Current execution and per-check progress.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2FilingPreReview'
        '400':
          description: Invalid filing or pre-review identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            Filing read access denied or credential scope is insufficient.
            Requires Reader access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Filing or pre-review not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: A dependency is unavailable. Retry this GET request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2FilingPreReview:
      type: object
      properties:
        filingId:
          type: string
          format: uuid
        sessionId:
          type: string
          format: uuid
          description: >-
            Pre-review identity and coordinating session ID. The session is
            provisioned asynchronously.
        sessionUrl:
          type: string
          format: uri
          description: >-
            Open the coordinating session. Session access permissions also
            apply.
        status:
          type: string
          enum:
            - queued
            - running
            - completed
            - failed
          description: >-
            completed means all checks finished, including findings and
            not_applicable. failed means at least one check could not finish.
        createdAt:
          type: string
          format: date-time
        completedAt:
          type: string
          nullable: true
          format: date-time
        checks:
          type: array
          items:
            type: object
            properties:
              checkId:
                type: string
                format: uuid
              versionId:
                type: string
                format: uuid
                description: >-
                  Published check version captured when this execution was
                  created.
              name:
                type: string
              status:
                type: string
                enum:
                  - queued
                  - assessing
                  - running
                  - passed
                  - findings
                  - not_applicable
                  - failed
                description: >-
                  queued: awaiting a worker; assessing: JEV applicability
                  assessment underway; running: check agent reviewing evidence;
                  passed: no issues found; findings: comments posted;
                  not_applicable: skipped with a reason; failed: execution
                  incomplete.
              summary:
                type: string
                nullable: true
                description: >-
                  Result, non-applicability reason, or execution failure. Null
                  until available.
              commentIds:
                type: array
                items:
                  type: string
                  format: uuid
                description: >-
                  Comments created by this execution, including any posted
                  before a failure. Resolving them does not change the check
                  result.
              sessionId:
                type: string
                nullable: true
                format: uuid
                description: Check agent session, null before dispatch.
              sessionUrl:
                type: string
                nullable: true
                format: uri
            required:
              - checkId
              - versionId
              - name
              - status
              - summary
              - commentIds
              - sessionId
              - sessionUrl
      required:
        - filingId
        - sessionId
        - sessionUrl
        - status
        - createdAt
        - completedAt
        - checks
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.