> ## 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.

# Find supporting requirements before creating a filing

> Read supporting-document requirements from the active imported source: newest shared source covering the state and environment, falling back to an organization source. Results include names, template links and source date. Read /requirements/{requirementId} with the same classification to get full instructions. Beta is a reference dataset, not production requirements. No matches do not prove no requirements apply. Each requirement appears once, ordered lexicographically by ID. Repeat query parameters with nextCursor until null; changed filing classification invalidates its cursor. Use item POST/PATCH supportingRequirement to assign a document, and item GET/list to read assignments. Assignment is not a compliance assessment. Does not create a filing or contact SERFF.



## OpenAPI

````yaml /openapi.json get /insurance/managed-filings/requirements
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/requirements:
    get:
      tags:
        - Managed Filings
      summary: Find supporting requirements before creating a filing
      description: >-
        Read supporting-document requirements from the active imported source:
        newest shared source covering the state and environment, falling back to
        an organization source. Results include names, template links and source
        date. Read /requirements/{requirementId} with the same classification to
        get full instructions. Beta is a reference dataset, not production
        requirements. No matches do not prove no requirements apply. Each
        requirement appears once, ordered lexicographically by ID. Repeat query
        parameters with nextCursor until null; changed filing classification
        invalidates its cursor. Use item POST/PATCH supportingRequirement to
        assign a document, and item GET/list to read assignments. Assignment is
        not a compliance assessment. Does not create a filing or contact SERFF.
      operationId: listManagedFilingRequirements
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
            description: Maximum number of items to return (1-200).
          required: false
          description: Maximum number of items to return (1-200).
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 8192
            description: >-
              Opaque nextCursor from this operation. Repeat every other query
              parameter unchanged; a cursor from a different query returns
              invalid_cursor.
          required: false
          description: >-
            Opaque nextCursor from this operation. Repeat every other query
            parameter unchanged; a cursor from a different query returns
            invalid_cursor.
          name: cursor
          in: query
        - schema:
            type: string
            enum:
              - beta
              - production
            default: beta
            description: >-
              Requirement source environment. Defaults to beta, matching the
              workspace reference catalog. Never falls back between
              environments.
          required: false
          description: >-
            Requirement source environment. Defaults to beta, matching the
            workspace reference catalog. Never falls back between environments.
          name: environment
          in: query
        - schema:
            type: string
            pattern: ^[A-Z]{2}$
          required: true
          name: state
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 300
          required: true
          name: toiCode
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 300
          required: true
          name: subToiCode
          in: query
        - schema:
            type: string
            enum:
              - form
              - rate
              - rule
              - rate_rule
              - form_rate
              - form_rule
              - form_rate_rule
          required: true
          name: filingType
          in: query
      responses:
        '200':
          description: Applicable requirements and source provenance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ManagedFilingRequirementList'
        '400':
          description: >-
            Invalid request, changed cursor inputs, or incomplete filing
            classification. Supply state, TOI, sub-TOI and a supported filing
            type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            Requires an organization member credential; filing lookup also
            requires filing and jurisdiction read access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            No source covers the state/environment, or the filing or
            jurisdiction is inaccessible. An unavailable source is never treated
            as an empty requirement list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: The active source changed between pages. Restart without cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency temporarily unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2ManagedFilingRequirementList:
      type: object
      properties:
        context:
          type: object
          properties:
            state:
              type: string
              pattern: ^[A-Z]{2}$
            toiCode:
              type: string
              minLength: 1
              maxLength: 300
            subToiCode:
              type: string
              minLength: 1
              maxLength: 300
            filingType:
              type: string
              enum:
                - form
                - rate
                - rule
                - rate_rule
                - form_rate
                - form_rule
                - form_rate_rule
          required:
            - state
            - toiCode
            - subToiCode
            - filingType
          additionalProperties: false
        source:
          type: object
          properties:
            environment:
              type: string
              enum:
                - beta
                - production
            capturedAt:
              type: string
              format: date-time
            coverage:
              type: string
          required:
            - environment
            - capturedAt
            - coverage
          additionalProperties: false
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                maxLength: 30
                pattern: ^\d+$
              state:
                type: string
                pattern: ^[A-Z]{2}$
              name:
                type: string
                minLength: 1
                maxLength: 300
              businessType:
                type: string
                maxLength: 300
              requirePerCompany:
                type: boolean
              attachments:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      maxLength: 1000
                    url:
                      type: string
                      maxLength: 4000
                      format: uri
                  required:
                    - name
                    - url
                maxItems: 100
              sourceUrl:
                type: string
                maxLength: 4000
                format: uri
              observedAt:
                type: string
                format: date-time
              applicability:
                type: string
                enum:
                  - matched
                  - needs_confirmation
                description: >-
                  needs_confirmation means the source lists conflicting filing
                  types. Document assignment does not resolve that uncertainty.
            required:
              - id
              - state
              - name
              - businessType
              - requirePerCompany
              - attachments
              - sourceUrl
              - observedAt
              - applicability
            additionalProperties: false
        nextCursor:
          type: string
          nullable: true
          description: Cursor for the next page, or null on the last page.
      required:
        - context
        - source
        - items
        - nextCursor
      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.
            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.