> ## 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 the products you have access to

> Which products and states the caller has access to, for finding the products you can read in full. This is normally the organization's access; an API key pinned to every product or to none reports that instead. A product has full access when allStates is true or states covers every state in its availabilitySummary; otherwise getProduct returns a limited view with the rest in access.lockedStates. Merged products are reported under the surviving product. Safe to retry. Access: open to every caller; no product access needed.



## OpenAPI

````yaml /openapi.json get /insurance/product-access
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/product-access:
    get:
      tags:
        - Products
      summary: Get the products you have access to
      description: >-
        Which products and states the caller has access to, for finding the
        products you can read in full. This is normally the organization's
        access; an API key pinned to every product or to none reports that
        instead. A product has full access when allStates is true or states
        covers every state in its availabilitySummary; otherwise getProduct
        returns a limited view with the rest in access.lockedStates. Merged
        products are reported under the surviving product. Safe to retry.
        Access: open to every caller; no product access needed.
      operationId: getProductAccess
      responses:
        '200':
          description: The products and states you have access to.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ProductAccess'
        '400':
          description: 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'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable. Honor Retry-After (seconds).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2ProductAccess:
      type: object
      properties:
        allProducts:
          type: boolean
          description: >-
            You have access to every product in every state, including products
            added later; products is then empty.
        products:
          type: array
          items:
            type: object
            properties:
              productId:
                type: string
                description: Managed product_ ID of the surviving product.
              allStates:
                type: boolean
                description: >-
                  Every state of the product is unlocked, including states
                  configured later.
              states:
                type: array
                items:
                  type: string
                description: >-
                  Unlocked states, sorted, when allStates is false; empty
                  otherwise.
            required:
              - productId
              - allStates
              - states
            additionalProperties: false
          description: >-
            Products with at least one unlocked state, sorted by ID. Unlisted
            products are locked.
      required:
        - allProducts
        - products
      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
              description: Dataset needed for dataset_not_enabled.
            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.