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

# Get a form checklist requirement

> Get one requirement item returned by listRegulatoryRequirements. A retired item returns 404; list again. Costs $0.01; failed requests are free.



## OpenAPI

````yaml /openapi.json get /insurance/regulatory-requirements/{requirementId}
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/regulatory-requirements/{requirementId}:
    get:
      tags:
        - Regulatory documents
      summary: Get a form checklist requirement
      description: >-
        Get one requirement item returned by listRegulatoryRequirements. A
        retired item returns 404; list again. Costs $0.01; failed requests are
        free.
      operationId: getRegulatoryRequirement
      parameters:
        - schema:
            type: string
            format: uuid
            description: Requirement id from listRegulatoryRequirements.
          required: true
          description: Requirement id from listRegulatoryRequirements.
          name: requirementId
          in: path
      responses:
        '200':
          description: The requirement item.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2RegulatoryRequirement'
        '400':
          description: >-
            invalid_request or invalid_cursor. Restart without cursor after
            expiry or a changed filter or limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: 'forbidden: SERFF view permission, which covers regulatory documents.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: 'not_found: unknown or retired requirement item.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: >-
            temporarily_unavailable: a 60-second statement timeout or the cursor
            store failed. Retry after Retry-After seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2RegulatoryRequirement:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Requirement item identity. Re-extraction can retire an item; it then
            returns 404.
        document:
          type: object
          properties:
            id:
              type: string
              format: uuid
              description: The form checklist. Read it with getRegulatoryDocument.
            state:
              type: string
            title:
              type: string
          required:
            - id
            - state
            - title
          description: The form checklist this item comes from.
        requirement:
          type: string
          description: The requirement, normalized into one sentence.
        sourceText:
          type: string
          description: >-
            The excerpt of the checklist the item came from, so you can check
            it.
        category:
          $ref: '#/components/schemas/V2RegulatoryRequirementCategory'
        scope:
          type: string
          enum:
            - FORM
            - POLICY
          description: >-
            FORM: a requirement on a form. POLICY: a requirement on the policy
            or process.
        formTypes:
          type: array
          items:
            $ref: '#/components/schemas/V2RegulatoryRequirementFormType'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/V2RegulatoryRequirementAction'
        toiCodes:
          type: array
          items:
            type: string
          description: TOI values the item applies to. [] means none given.
        legalRefs:
          type: array
          items:
            type: string
          description: Laws the item cites, as written.
        sourceLocator:
          type: object
          properties:
            heading:
              type: string
              nullable: true
              description: Checklist heading above the excerpt, if any.
            chunkIndex:
              type: integer
              nullable: true
              minimum: 0
              description: Position of the extraction chunk. It is not a text offset.
          required:
            - heading
            - chunkIndex
          description: Where the excerpt sits in the checklist.
      required:
        - id
        - document
        - requirement
        - sourceText
        - category
        - scope
        - formTypes
        - actions
        - toiCodes
        - legalRefs
        - sourceLocator
    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
              description: Dataset needed for dataset_not_enabled.
          required:
            - code
    V2RegulatoryRequirementCategory:
      type: string
      enum:
        - MANDATORY_LANGUAGE
        - REQUIRED_CONTENT
        - PROHIBITED_CONTENT
        - NOTICE_PERIOD
        - PERMISSIBLE_REASON
        - PROHIBITED_REASON
        - DELIVERY
        - RECIPIENT
        - PROOF
        - FILING_STATUS
        - APPROVAL
        - OFFER_OR_AVAILABILITY
        - SIGNATURE
        - FORMAT
        - OTHER
      description: >-
        What the requirement governs, such as a notice period or mandatory
        wording.
    V2RegulatoryRequirementFormType:
      type: string
      enum:
        - BASE_POLICY_FORM
        - COVERAGE_FORM
        - ENDORSEMENT
        - RIDER
        - APPLICATION
        - DECLARATIONS
        - SCHEDULE
        - CERTIFICATE
        - ID_CARD
        - CANCELLATION_NOTICE
        - NONRENEWAL_NOTICE
        - CONDITIONAL_RENEWAL_NOTICE
        - RENEWAL_CHANGE_NOTICE
        - OTHER_NOTICE
        - DISCLOSURE
        - OFFER_FORM
        - CONSENT_FORM
        - SELECTION_REJECTION_FORM
        - ACKNOWLEDGMENT
        - QUESTIONNAIRE
        - CERTIFICATION
        - ELECTION_FORM
        - CLAIM_FORM
        - PROOF_OF_LOSS
        - FRAUD_WARNING
        - OTHER
      description: Kind of form the requirement applies to.
    V2RegulatoryRequirementAction:
      type: string
      enum:
        - CANCELLATION
        - NONRENEWAL
        - CONDITIONAL_RENEWAL
        - RENEWAL_WITH_CHANGE
        - DECLINATION
        - RESCISSION
        - ISSUANCE
        - OTHER
      description: Policy action the requirement applies to.
    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.