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

# List citations out of or into a regulatory document

> List citation links. direction=out (default) lists what this document cites: each row has the relationship, the citation as written, and the cited document or null when it is not in the corpus. direction=in lists corpus documents that cite this one. Rows are ordered by relationship, then citing document and citation. A document can cite laws in legalRefs without any reference rows. Each returned reference costs $0.003; empty pages and failed requests are free.



## OpenAPI

````yaml /openapi.json get /insurance/regulatory-documents/{documentId}/references
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-documents/{documentId}/references:
    get:
      tags:
        - Regulatory documents
      summary: List citations out of or into a regulatory document
      description: >-
        List citation links. direction=out (default) lists what this document
        cites: each row has the relationship, the citation as written, and the
        cited document or null when it is not in the corpus. direction=in lists
        corpus documents that cite this one. Rows are ordered by relationship,
        then citing document and citation. A document can cite laws in legalRefs
        without any reference rows. Each returned reference costs $0.003; empty
        pages and failed requests are free.
      operationId: listRegulatoryDocumentReferences
      parameters:
        - schema:
            type: string
            format: uuid
            description: Document id from listRegulatoryDocuments.
          required: true
          description: Document id from listRegulatoryDocuments.
          name: documentId
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: Maximum items to return, 1–100. Default 50.
          required: false
          description: Maximum items to return, 1–100. Default 50.
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            description: >-
              Opaque nextCursor from the previous page. Repeat the same filters
              and limit. Expires 24 hours after the first page.
          required: false
          description: >-
            Opaque nextCursor from the previous page. Repeat the same filters
            and limit. Expires 24 hours after the first page.
          name: cursor
          in: query
        - schema:
            type: string
            enum:
              - out
              - in
            default: out
            description: >-
              out (default): citations this document makes. in: documents in the
              corpus that cite this one.
          required: false
          description: >-
            out (default): citations this document makes. in: documents in the
            corpus that cite this one.
          name: direction
          in: query
      responses:
        '200':
          description: A page of citation links.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2RegulatoryDocumentReferenceList'
        '400':
          description: >-
            invalid_request or invalid_cursor. Restart without cursor after
            expiry or a changed query, 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 deleted document.'
          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: the search embedding, 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:
    V2RegulatoryDocumentReferenceList:
      type: object
      properties:
        references:
          type: array
          items:
            type: object
            properties:
              relationship:
                $ref: '#/components/schemas/V2RegulatoryReferenceRelationship'
              citation:
                type: string
                description: The cited law or document, as written in the citing document.
              document:
                type: object
                nullable: true
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Read it with getRegulatoryDocument.
                  state:
                    type: string
                  kind:
                    $ref: '#/components/schemas/V2RegulatoryDocumentKind'
                  identifier:
                    type: string
                    nullable: true
                required:
                  - id
                  - state
                  - kind
                  - identifier
                description: >-
                  With direction=out, the cited document, or null when it is not
                  in the corpus. With direction=in, the citing document.
            required:
              - relationship
              - citation
              - document
        nextCursor:
          type: string
          nullable: true
          description: Cursor for the next page, or null on the last.
      required:
        - references
        - nextCursor
    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
    V2RegulatoryReferenceRelationship:
      type: string
      enum:
        - references
        - amends
        - supersedes
      description: How the citing document relates to the cited one.
    V2RegulatoryDocumentKind:
      type: string
      enum:
        - bulletin
        - circular_letter
        - data_call
        - examination_standards
        - filing_requirement
        - form_checklist
        - guideline
        - informational_memo
        - legislative_bill
        - mcas_scorecard
        - meeting_materials
        - model_law
        - model_law_adoption
        - news_release
        - order
        - reference_document
        - regulation
        - statute
        - survey
      description: >-
        Document kind. New values can be added; tolerate values you do not
        recognize.
    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.