> ## 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 combined filing check status

> Latest attempt for each check in the most recent full-review lineage, including single-check reruns. Each result retains its execution ID and timestamp; results may cover different filing versions. Up to five previous attempts per check are included. Earlier full-review lineages are excluded. This is not an assertion that the current package passes review. No work is started.



## OpenAPI

````yaml /openapi.json get /insurance/managed-filings/{filingId}/pre-review-status
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-review-status:
    get:
      tags:
        - Managed Filing Checks
      summary: Read combined filing check status
      description: >-
        Latest attempt for each check in the most recent full-review lineage,
        including single-check reruns. Each result retains its execution ID and
        timestamp; results may cover different filing versions. Up to five
        previous attempts per check are included. Earlier full-review lineages
        are excluded. This is not an assertion that the current package passes
        review. No work is started.
      operationId: getManagedFilingPreReviewStatus
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: filingId
          in: path
      responses:
        '200':
          description: Combined check status, or null before the first review.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2FilingPreReviewStatus'
        '400':
          description: Invalid request or input limits exceeded.
          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:
    V2FilingPreReviewStatus:
      type: object
      properties:
        preReview:
          type: object
          nullable: true
          properties:
            runId:
              type: string
              format: uuid
              description: >-
                Latest full-review lineage root. Each check identifies its
                actual execution.
            filingId:
              type: string
              format: uuid
            captainSessionId:
              type: string
              nullable: true
              format: uuid
            sessionUrl:
              type: string
              format: uri
            status:
              type: string
              enum:
                - queued
                - running
                - completed
                - failed
            createdAt:
              type: string
              format: date-time
            completedAt:
              type: string
              nullable: true
              format: date-time
            activeRunId:
              type: string
              nullable: true
              format: uuid
            checks:
              type: array
              items:
                type: object
                properties:
                  checkId:
                    type: string
                    format: uuid
                  versionId:
                    type: string
                    format: uuid
                    description: Published check revision captured for this attempt.
                  name:
                    type: string
                  status:
                    type: string
                    enum:
                      - queued
                      - assessing
                      - running
                      - passed
                      - findings
                      - not_applicable
                      - failed
                    description: >-
                      passed: no issues found; findings: comments published;
                      not_applicable: skipped with a reason; failed: incomplete
                      analysis or publication. Inspect summary and commentIds.
                  summary:
                    type: string
                    nullable: true
                  commentIds:
                    type: array
                    items:
                      type: string
                      format: uuid
                    description: >-
                      New or reused finding comments, including any published
                      before failure. Passing a rerun does not resolve earlier
                      discussions.
                  agentSessionId:
                    type: string
                    nullable: true
                    format: uuid
                    description: Actual check-agent chat session; null before dispatch.
                  sessionUrl:
                    type: string
                    nullable: true
                    format: uri
                  runId:
                    type: string
                    format: uuid
                  createdAt:
                    type: string
                    format: date-time
                  completedAt:
                    type: string
                    nullable: true
                    format: date-time
                  previousAttempts:
                    type: array
                    items:
                      type: object
                      properties:
                        checkId:
                          type: string
                          format: uuid
                        versionId:
                          type: string
                          format: uuid
                          description: Published check revision captured for this attempt.
                        name:
                          type: string
                        status:
                          type: string
                          enum:
                            - queued
                            - assessing
                            - running
                            - passed
                            - findings
                            - not_applicable
                            - failed
                          description: >-
                            passed: no issues found; findings: comments
                            published; not_applicable: skipped with a reason;
                            failed: incomplete analysis or publication. Inspect
                            summary and commentIds.
                        summary:
                          type: string
                          nullable: true
                        commentIds:
                          type: array
                          items:
                            type: string
                            format: uuid
                          description: >-
                            New or reused finding comments, including any
                            published before failure. Passing a rerun does not
                            resolve earlier discussions.
                        agentSessionId:
                          type: string
                          nullable: true
                          format: uuid
                          description: >-
                            Actual check-agent chat session; null before
                            dispatch.
                        sessionUrl:
                          type: string
                          nullable: true
                          format: uri
                        runId:
                          type: string
                          format: uuid
                        createdAt:
                          type: string
                          format: date-time
                        completedAt:
                          type: string
                          nullable: true
                          format: date-time
                      required:
                        - checkId
                        - versionId
                        - name
                        - status
                        - summary
                        - commentIds
                        - agentSessionId
                        - sessionUrl
                        - runId
                        - createdAt
                        - completedAt
                    maxItems: 5
                    description: Up to five earlier attempts in this lineage, newest first.
                  hasEarlierAttempts:
                    type: boolean
                required:
                  - checkId
                  - versionId
                  - name
                  - status
                  - summary
                  - commentIds
                  - agentSessionId
                  - sessionUrl
                  - runId
                  - createdAt
                  - completedAt
                  - previousAttempts
                  - hasEarlierAttempts
          required:
            - runId
            - filingId
            - captainSessionId
            - sessionUrl
            - status
            - createdAt
            - completedAt
            - activeRunId
            - checks
      required:
        - preReview
    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.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          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.