> ## 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 a filing check

> Read published Markdown instructions, or a previous immutable version belonging to this check. A version from another check is not accepted.



## OpenAPI

````yaml /openapi.json get /insurance/managed-filings/checks/{checkId}
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://canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/managed-filings/checks/{checkId}:
    get:
      tags:
        - Managed Filing Checks
      summary: Read a filing check
      description: >-
        Read published Markdown instructions, or a previous immutable version
        belonging to this check. A version from another check is not accepted.
      operationId: getManagedFilingCheck
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: checkId
          in: path
        - schema:
            type: string
            format: uuid
            description: >-
              Read an immutable previous revision. Omit for the current
              published revision.
          required: false
          description: >-
            Read an immutable previous revision. Omit for the current published
            revision.
          name: versionId
          in: query
      responses:
        '200':
          description: Check instructions and revision.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ManagedFilingCheck'
        '400':
          description: Invalid request or expired cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            An organization member credential is required. Writes require Tenant
            Admin; global writes require Super Admin.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Check or published version not found in the visible catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Versioned storage or pagination is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2ManagedFilingCheck:
      allOf:
        - $ref: '#/components/schemas/V2ManagedFilingCheckSummary'
        - type: object
          properties:
            markdown:
              type: string
              description: >-
                Markdown instructions, applicability guidance, examples, and
                sources.
          required:
            - markdown
          additionalProperties: false
    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
    V2ManagedFilingCheckSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          description: Human-readable check name, fixed when created.
        scope:
          type: string
          enum:
            - global
            - organization
          description: >-
            Global checks are shared by Effective; organization checks belong to
            your tenant.
        versionId:
          type: string
          format: uuid
          description: Immutable instruction revision. Retain this ID with review results.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
          description: >-
            When the check was last published; historical reads retain this
            catalog timestamp.
      required:
        - id
        - name
        - scope
        - versionId
        - createdAt
        - updatedAt
      additionalProperties: false
    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.