> ## 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 review from its link > A review of one filing that Effective shared by link, with the filing's public catalog record and the carrier's recent filings for the same line and state, plus other carriers' recent filings for it. No sign-in is required: the review ID in the link is the only authority, and it reads only this review and the filings it lists. Unknown, revoked and expired links return the same 404. Requests are rate limited per address and per review. ## OpenAPI ````yaml /openapi.json get /filing-reviews/{reviewId} 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}: get: tags: - Filing reviews summary: Read a filing review from its link description: >- A review of one filing that Effective shared by link, with the filing's public catalog record and the carrier's recent filings for the same line and state, plus other carriers' recent filings for it. No sign-in is required: the review ID in the link is the only authority, and it reads only this review and the filings it lists. Unknown, revoked and expired links return the same 404. Requests are rate limited per address and per review. operationId: getPublicFilingReview 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 responses: '200': description: The review, its filing and the filing history it covers. content: application/json: schema: $ref: '#/components/schemas/V2PublicFilingReview' '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: V2PublicFilingReview: type: object properties: id: type: string expiresAt: type: string nullable: true format: date-time review: type: object properties: reviewStandard: type: string nullable: true findings: type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9_-]{1,64}$ description: Stable within the review, so a filer can cite "finding 2". severity: type: string enum: - must_fix - worth_checking consequence: type: string minLength: 1 maxLength: 200 description: >- What the regulator is likely to do, such as "Likely intake rejection". title: type: string minLength: 1 maxLength: 300 description: type: string minLength: 1 maxLength: 10000 evidence: oneOf: - type: object properties: kind: type: string enum: - excerpt location: type: string minLength: 1 maxLength: 300 lines: type: array items: type: object properties: text: type: string maxLength: 2000 note: type: string minLength: 1 maxLength: 300 flagged: type: boolean required: - text additionalProperties: false minItems: 1 maxItems: 40 required: - kind - lines additionalProperties: false - type: object properties: kind: type: string enum: - comparison sides: type: array items: type: object properties: location: type: string minLength: 1 maxLength: 300 value: type: string minLength: 1 maxLength: 500 required: - location - value additionalProperties: false minItems: 2 maxItems: 6 required: - kind - sides additionalProperties: false source: type: string minLength: 1 maxLength: 1000 description: The rule or document the finding relies on. nextStep: type: string minLength: 1 maxLength: 2000 required: - id - severity - title - description additionalProperties: false maxItems: 50 passedChecks: type: array items: type: string minLength: 1 maxLength: 300 maxItems: 100 default: [] required: - reviewStandard - findings additionalProperties: false filing: $ref: '#/components/schemas/V2PublicFilingReviewFiling' history: type: object properties: filings: type: array items: allOf: - $ref: '#/components/schemas/V2PublicFilingReviewFiling' - type: object properties: objections: type: array items: $ref: '#/components/schemas/V2PublicFilingReviewObjection' description: >- Up to 20 recent objection letters, newest first; empty for other carriers. required: - objections description: >- The carrier's recent filings for this line in this state, this one included. related: type: array items: allOf: - $ref: '#/components/schemas/V2PublicFilingReviewFiling' - type: object properties: objections: type: array items: $ref: '#/components/schemas/V2PublicFilingReviewObjection' description: >- Up to 20 recent objection letters, newest first; empty for other carriers. required: - objections description: >- Other carriers' recent filings for the same line in the same state. required: - filings - related required: - id - expiresAt - review - filing - history 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. V2PublicFilingReviewObjection: type: object properties: id: type: string format: uuid objectionDate: type: string nullable: true format: date reviewerName: type: string nullable: true description: The state analyst who wrote the letter, when known. textPreview: type: string nullable: true description: The start of the letter, or null when it has no text. textTruncated: type: boolean required: - id - objectionDate - reviewerName - textPreview - textTruncated 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.