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

# Discover product profile fields

> Describe the four profile fields and their input choices. Target-market options depend on customerType; cuts reference registered types, fields or options. Null clears a scalar or target market; an empty cut list clears cuts. These choices organize material, not eligibility. Safe to retry.



## OpenAPI

````yaml /openapi.json get /insurance/product-profile/schema
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-profile/schema:
    get:
      tags:
        - Products
      summary: Discover product profile fields
      description: >-
        Describe the four profile fields and their input choices. Target-market
        options depend on customerType; cuts reference registered types, fields
        or options. Null clears a scalar or target market; an empty cut list
        clears cuts. These choices organize material, not eligibility. Safe to
        retry.
      operationId: getProductProfileSchema
      responses:
        '200':
          description: Profile form definition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ProductProfileForm'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Operation forbidden.
          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:
    V2ProductProfileForm:
      type: object
      properties:
        fields:
          type: object
          properties:
            customerType:
              type: object
              properties:
                label:
                  type: string
                options:
                  type: array
                  items:
                    type: string
                    enum:
                      - PERSONAL
                      - BUSINESS
                nullable:
                  type: boolean
                  enum:
                    - true
              required:
                - label
                - options
                - nullable
              additionalProperties: false
            structure:
              type: object
              properties:
                label:
                  type: string
                options:
                  type: array
                  items:
                    type: string
                    enum:
                      - PACKAGE
                      - MONOLINE
                nullable:
                  type: boolean
                  enum:
                    - true
              required:
                - label
                - options
                - nullable
              additionalProperties: false
            targetMarket:
              type: object
              properties:
                label:
                  type: string
                optionsPath:
                  type: string
                dependsOn:
                  type: array
                  items:
                    type: string
                    enum:
                      - customerType
                allowCustomText:
                  type: boolean
                  enum:
                    - true
                nullable:
                  type: boolean
                  enum:
                    - true
              required:
                - label
                - optionsPath
                - dependsOn
                - allowCustomText
                - nullable
              additionalProperties: false
            primaryCuts:
              type: object
              properties:
                label:
                  type: string
                type:
                  type: string
                  enum:
                    - references
                maxItems:
                  type: number
                  enum:
                    - 100
              required:
                - label
                - type
                - maxItems
              additionalProperties: false
          required:
            - customerType
            - structure
            - targetMarket
            - primaryCuts
          additionalProperties: false
      required:
        - fields
      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.
          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.