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

# Read a filing a review's link covers

> One filing's public catalog record, through a review link that covers it. No sign-in is required; the review ID authorizes only the filings the review lists.



## OpenAPI

````yaml /openapi.json get /filing-reviews/{reviewId}/filings/{filingId}
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.effectiveai.app/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /filing-reviews/{reviewId}/filings/{filingId}:
    get:
      tags:
        - Filing reviews
      summary: Read a filing a review's link covers
      description: >-
        One filing's public catalog record, through a review link that covers
        it. No sign-in is required; the review ID authorizes only the filings
        the review lists.
      operationId: getPublicFilingReviewFiling
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 64
            description: >-
              The review ID from the review link, as in
              filings.effectiveai.app/r/{reviewId}, e.g.
              frev_7Kq2mXa9b3Lr5Tn8Pw1Zc4.
          required: true
          description: >-
            The review ID from the review link, as in
            filings.effectiveai.app/r/{reviewId}, e.g.
            frev_7Kq2mXa9b3Lr5Tn8Pw1Zc4.
          name: reviewId
          in: path
        - schema:
            type: string
            format: uuid
            description: A filing the review covers, as the review lists it.
          required: true
          description: A filing the review covers, as the review lists it.
          name: filingId
          in: path
      responses:
        '200':
          description: The filing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2PublicFilingReviewFilingDetail'
        '400':
          description: Invalid review or filing identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            The review link is unknown, revoked or expired, or the review does
            not cover this filing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: 'rate_limited: too many requests; wait Retry-After seconds.'
          headers:
            Retry-After:
              required: true
              schema:
                type: integer
                minimum: 1
              description: Seconds to wait before retrying.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security: []
components:
  schemas:
    V2PublicFilingReviewFilingDetail:
      allOf:
        - $ref: '#/components/schemas/V2PublicFilingReviewFiling'
        - type: object
          properties:
            description:
              type: string
              nullable: true
          required:
            - description
    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
    V2PublicFilingReviewFiling:
      type: object
      properties:
        id:
          type: string
          format: uuid
        source:
          type: string
        sourceReference:
          type: string
        state:
          type: string
        companyName:
          type: string
          nullable: true
        carrierIds:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Unique canonical carrier_ IDs resolved from source NAIC codes. Null
            when no valid source codes are known; [] when codes are known but
            none resolve. May be partial; naicCompanyCodes preserves all known
            source codes. Never contains naic: references.
        groupId:
          type: string
          nullable: true
          description: >-
            Canonical carrier_group_ ID, or null when the source code is absent,
            unresolved or ambiguous. naicGroupCode preserves the source code.
        naicCompanyCodes:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Unique five-digit source NAIC company codes, preserving leading
            zeros; null when unknown. These are source identifiers, not managed
            IDs, and remain available without a directory match.
        naicGroupCode:
          type: string
          nullable: true
          description: >-
            Source NAIC group code as a decimal string without leading zeros, or
            null when unknown. Kept separately from managed groupId.
        productName:
          type: string
          nullable: true
        typeOfInsurance:
          type: string
          nullable: true
        subTypeOfInsurance:
          type: string
          nullable: true
        toiCode:
          type: string
          nullable: true
        subToiCode:
          type: string
          nullable: true
        filingType:
          type: string
          nullable: true
        sourceStatus:
          type: string
          nullable: true
        submissionDate:
          type: string
          nullable: true
          format: date
        dispositionDate:
          type: string
          nullable: true
          format: date
        stateStatus:
          type: string
          nullable: true
        dispositionStatus:
          type: string
          nullable: true
        rateImpact:
          $ref: '#/components/schemas/V2FilingRateChangeSummary'
      required:
        - id
        - source
        - sourceReference
        - state
        - companyName
        - carrierIds
        - groupId
        - naicCompanyCodes
        - naicGroupCode
        - productName
        - typeOfInsurance
        - subTypeOfInsurance
        - toiCode
        - subToiCode
        - filingType
        - sourceStatus
        - submissionDate
        - dispositionDate
        - stateStatus
        - dispositionStatus
        - rateImpact
      description: The reviewed filing.
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
    V2FilingRateChangeSummary:
      type: object
      nullable: true
      properties:
        overallRateImpactPercent:
          type: number
          nullable: true
          description: >-
            The overall change the filing selects and requests, in percent: 7.5
            means 7.5%. Null means unknown.
        overallIndicatedChangePercent:
          type: number
          nullable: true
          description: >-
            The overall change the filing’s rate analysis indicates, in percent.
            Often differs from the selected change. Null means unknown.
      required:
        - overallRateImpactPercent
        - overallIndicatedChangePercent
      description: >-
        Overall rate change extracted from the SERFF rate data. Null when none
        was extracted, which includes form-only filings and every Florida IRFS
        filing; it does not mean no change. A filed rate is not an approved
        rate. GET /insurance/filings/{filingId}/rate-impact adds written
        premium, policyholders affected and the range of changes.
  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.