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

> A carrier with its aliases, NAIC group members and the MGAs it backs. No query parameters. Responses are private, no-store.



## OpenAPI

````yaml /openapi.json get /carriers/{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://canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /carriers/{id}:
    get:
      tags:
        - Carriers
      summary: Get a carrier
      description: >-
        A carrier with its aliases, NAIC group members and the MGAs it backs. No
        query parameters. Responses are private, no-store.
      operationId: getCarrier
      parameters:
        - schema:
            type: string
            description: '`naic:38970` or `38970`.'
          required: true
          description: '`naic:38970` or `38970`.'
          name: id
          in: path
      responses:
        '200':
          description: The carrier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Carrier'
        '400':
          description: Unknown query parameters or invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Missing or invalid credentials, or credential scope denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: The credential does not permit this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Carrier not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable. Respect Retry-After (seconds).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2Carrier:
      type: object
      properties:
        id:
          type: string
          description: '`naic:` plus the 5-digit NAIC company code.'
          example: naic:38970
        name:
          type: string
        group:
          type: object
          nullable: true
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
          description: NAIC group; id is `group:` plus the group code.
        domicile:
          type: string
          nullable: true
          description: Two-letter state of domicile.
        status:
          type: string
          enum:
            - active
            - inactive
        grossPremiumWritten:
          type: object
          nullable: true
          properties:
            year:
              type: integer
            amount:
              type: number
          required:
            - year
            - amount
          description: Latest NAIC statement, in dollars. Null without the NAIC dataset.
        cessionRatio:
          type: object
          nullable: true
          properties:
            year:
              type: integer
            value:
              type: number
          required:
            - year
            - value
          description: >-
            Premium ceded ÷ premium written (Page 14, line 35). Null without the
            NAIC dataset.
        aliases:
          type: array
          items:
            type: string
        groupMembers:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
            required:
              - id
              - name
          description: Other carriers in the same NAIC group.
        mgas:
          type: array
          items:
            type: object
            properties:
              mga:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                required:
                  - id
                  - name
              role:
                type: string
                enum:
                  - fronting
                  - issuing
                description: >-
                  fronting: the carrier issues the program and cedes at least
                  90% of its premium.
              note:
                type: string
                nullable: true
                description: >-
                  Free-text source for the link, such as a SERFF tracking number
                  or a web page.
            required:
              - mga
              - role
              - note
      required:
        - id
        - name
        - group
        - domicile
        - status
        - grossPremiumWritten
        - cessionRatio
        - aliases
        - groupMembers
        - mgas
      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.
          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.