> ## 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 carrier line result

> Requires the organization’s NAIC dataset grant after acceptance of the NAIC terms. The grant is checked before carrier lookup on every request. Each successful request costs $0.02 plus $0.01 per returned observation. Failed requests are not charged; repeated successful reads are charged again. Use the ID returned by listCarrierLineResults under the same carrier. Reads the current loaded value of the source observation, not an immutable revision. A removed observation or wrong carrier returns 404. Accepts no query parameters. Read-only; private, no-store.



## OpenAPI

````yaml /openapi.json get /insurance/carriers/{carrierId}/line-results/{id}
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/carriers/{carrierId}/line-results/{id}:
    get:
      tags:
        - NAIC statutory data
      summary: Get a carrier line result
      description: >-
        Requires the organization’s NAIC dataset grant after acceptance of the
        NAIC terms. The grant is checked before carrier lookup on every request.
        Each successful request costs $0.02 plus $0.01 per returned observation.
        Failed requests are not charged; repeated successful reads are charged
        again. Use the ID returned by listCarrierLineResults under the same
        carrier. Reads the current loaded value of the source observation, not
        an immutable revision. A removed observation or wrong carrier returns
        404. Accepts no query parameters. Read-only; private, no-store.
      operationId: getCarrierLineResult
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 100
            description: >-
              Managed carrier_ ID or bare checked code. Legacy five-digit NAIC
              codes and naic: codes are also accepted.
          required: true
          description: >-
            Managed carrier_ ID or bare checked code. Legacy five-digit NAIC
            codes and naic: codes are also accepted.
          name: carrierId
          in: path
        - schema:
            type: string
            maxLength: 200
          required: true
          name: id
          in: path
      responses:
        '200':
          description: One line observation, with the same representation as the list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CarrierLineResult'
        '400':
          description: >-
            invalid_request for invalid, conflicting, unknown or repeated scalar
            inputs; invalid_id for a malformed carrier; invalid_cursor requires
            restarting traversal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            dataset_not_enabled: NAIC terms and organization entitlement are
            required. No charge. Other credential restrictions use forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            not_found for an unknown carrier or missing/wrong-parent item;
            statutory_data_not_found when the carrier has no loaded observations
            in the selected exhibits and year range. This does not prove it did
            not file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: A dependency is unavailable; respect Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2CarrierLineResult:
      oneOf:
        - type: object
          properties:
            id:
              type: string
              description: >-
                Opaque observation ID; copy to the item GET. Identifies source
                company, year, exhibit and line, not an immutable value.
            carrier:
              type: object
              properties:
                id:
                  type: string
                name:
                  type: string
              required:
                - id
                - name
            naicCompanyCode:
              type: string
              description: Source company code, distinct from the managed carrier identity.
            year:
              type: integer
              minimum: 1900
              maximum: 9999
            line:
              type: object
              properties:
                code:
                  type: string
                name:
                  type: string
                  nullable: true
                  description: >-
                    Loaded line label. Interpret with year, exhibit and note;
                    labels alone do not establish continuity.
                family:
                  type: string
                  nullable: true
                  enum:
                    - allied-lines
                    - cmp
                    - group-ah
                    - other-ah
                    - inland-marine
                    - ppa-liability
                    - commercial-auto-liability
                    - auto-physical-damage
                    - null
                scheme:
                  type: string
                  enum:
                    - statement
                note:
                  type: string
                  nullable: true
                  description: >-
                    Known meaning changes, especially auto-liability codes
                    before and after 2022.
              required:
                - code
                - name
                - family
                - scheme
                - note
            sources:
              type: array
              items:
                allOf:
                  - $ref: '#/components/schemas/V2NaicSource'
                  - type: object
                    properties:
                      line:
                        type: string
                    required:
                      - line
            exhibit:
              type: string
              enum:
                - part-1b
            premium:
              type: object
              properties:
                direct:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                assumedAffiliated:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                assumedUnaffiliated:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                cededAffiliated:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                cededUnaffiliated:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                net:
                  type: integer
                  nullable: true
                  description: >-
                    Reported net written premium, not recomputed from other
                    fields. Whole US dollars or null.
              required:
                - direct
                - assumedAffiliated
                - assumedUnaffiliated
                - cededAffiliated
                - cededUnaffiliated
                - net
              description: >-
                Reported written-premium components from Part 1B, in whole US
                dollars. Net is the reported value; no derived gross or ratios.
          required:
            - id
            - carrier
            - naicCompanyCode
            - year
            - line
            - sources
            - exhibit
            - premium
        - type: object
          properties:
            id:
              type: string
              description: >-
                Opaque observation ID; copy to the item GET. Identifies source
                company, year, exhibit and line, not an immutable value.
            carrier:
              type: object
              properties:
                id:
                  type: string
                name:
                  type: string
              required:
                - id
                - name
            naicCompanyCode:
              type: string
              description: Source company code, distinct from the managed carrier identity.
            year:
              type: integer
              minimum: 1900
              maximum: 9999
            line:
              type: object
              properties:
                code:
                  type: string
                name:
                  type: string
                  nullable: true
                  description: >-
                    Loaded line label. Interpret with year, exhibit and note;
                    labels alone do not establish continuity.
                family:
                  type: string
                  nullable: true
                  enum:
                    - allied-lines
                    - cmp
                    - group-ah
                    - other-ah
                    - inland-marine
                    - ppa-liability
                    - commercial-auto-liability
                    - auto-physical-damage
                    - null
                scheme:
                  type: string
                  enum:
                    - statement
                note:
                  type: string
                  nullable: true
                  description: >-
                    Known meaning changes, especially auto-liability codes
                    before and after 2022.
              required:
                - code
                - name
                - family
                - scheme
                - note
            sources:
              type: array
              items:
                allOf:
                  - $ref: '#/components/schemas/V2NaicSource'
                  - type: object
                    properties:
                      line:
                        type: string
                    required:
                      - line
            exhibit:
              type: string
              enum:
                - iee-part-3
            underwriting:
              type: object
              properties:
                premiumWritten:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                premiumEarned:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                dividendsToPolicyholders:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                lossesIncurred:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                defenseAndCostContainmentIncurred:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                adjustingAndOtherExpensesIncurred:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                unpaidLosses:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                unearnedPremiumReserve:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                commissionsAndBrokerageExpense:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                taxesLicensesAndFees:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                otherAcquisitionExpenses:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                generalExpensesIncurred:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                otherIncome:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
                pretaxProfit:
                  type: integer
                  nullable: true
                  description: >-
                    Reported amount in whole US dollars. Null is unavailable,
                    not zero. Negative amounts are preserved.
              required:
                - premiumWritten
                - premiumEarned
                - dividendsToPolicyholders
                - lossesIncurred
                - defenseAndCostContainmentIncurred
                - adjustingAndOtherExpensesIncurred
                - unpaidLosses
                - unearnedPremiumReserve
                - commissionsAndBrokerageExpense
                - taxesLicensesAndFees
                - otherAcquisitionExpenses
                - generalExpensesIncurred
                - otherIncome
                - pretaxProfit
              description: >-
                Reported underwriting components from IEE Part 3, scaled from
                thousands to whole US dollars. No derived ratios.
          required:
            - id
            - carrier
            - naicCompanyCode
            - year
            - line
            - sources
            - exhibit
            - underwriting
    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
    V2NaicSource:
      type: object
      properties:
        exhibit:
          type: string
        statementYear:
          type: integer
          minimum: 1900
          maximum: 9999
      required:
        - exhibit
        - statementYear
    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.