Get Configuration

Retrieves company-specific configuration including rating fields, entity types, coverage options, and available forms.

companyId · string · required

The company identifier (UUID)

Response

Response

{
  "company": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "ABC Insurance Company",
    "timezone": "America/New_York",
    "currency": "USD"
  },
  "ratingFields": [
    {
      "id": "rf-001",
      "name": "Business Type",
      "type": "dropdown",
      "required": true,
      "options": [
        "Manufacturing",
        "Retail",
        "Services",
        "Construction",
        "Technology"
      ]
    },
    {
      "id": "rf-002",
      "name": "Annual Revenue",
      "type": "number",
      "required": true,
      "min": 0,
      "max": 1000000000
    },
    {
      "id": "rf-003",
      "name": "Number of Employees",
      "type": "number",
      "required": true,
      "min": 1,
      "max": 10000
    },
    {
      "id": "rf-004",
      "name": "Years in Business",
      "type": "number",
      "required": false,
      "min": 0,
      "max": 100
    }
  ],
  "entityTypes": [
    {
      "id": "et-001",
      "name": "Corporation",
      "code": "corporation",
      "description": "A legal entity separate from its owners"
    },
    {
      "id": "et-002",
      "name": "Limited Liability Company",
      "code": "llc",
      "description": "A hybrid business structure with limited liability"
    },
    {
      "id": "et-003",
      "name": "Partnership",
      "code": "partnership",
      "description": "A business owned by two or more partners"
    },
    {
      "id": "et-004",
      "name": "Sole Proprietorship",
      "code": "sole_proprietorship",
      "description": "A business owned by a single individual"
    },
    {
      "id": "et-005",
      "name": "Non-Profit Organization",
      "code": "non_profit",
      "description": "A tax-exempt organization for charitable purposes"
    }
  ],
  "policyTypes": [
    {
      "id": "pt-001",
      "name": "General Liability",
      "code": "general_liability",
      "description": "Protection against third-party claims for bodily injury and property damage",
      "available": true
    },
    {
      "id": "pt-002",
      "name": "Professional Liability",
      "code": "professional_liability",
      "description": "Protection against claims of professional negligence",
      "available": true
    },
    {
      "id": "pt-003",
      "name": "Workers Compensation",
      "code": "workers_compensation",
      "description": "Coverage for work-related injuries and illnesses",
      "available": true
    },
    {
      "id": "pt-004",
      "name": "Commercial Auto",
      "code": "commercial_auto",
      "description": "Coverage for business-owned vehicles",
      "available": true
    },
    {
      "id": "pt-005",
      "name": "Property",
      "code": "property",
      "description": "Coverage for business property and equipment",
      "available": true
    },
    {
      "id": "pt-006",
      "name": "Cyber Liability",
      "code": "cyber_liability",
      "description": "Protection against cyber attacks and data breaches",
      "available": false
    }
  ],
  "coverageOptions": {
    "general_liability": [
      {
        "id": "cov-001",
        "name": "General Liability",
        "minLimit": 100000,
        "maxLimit": 10000000,
        "defaultLimit": 1000000,
        "minPremium": 500,
        "maxPremium": 50000
      },
      {
        "id": "cov-002",
        "name": "Products Liability",
        "minLimit": 100000,
        "maxLimit": 10000000,
        "defaultLimit": 1000000,
        "minPremium": 300,
        "maxPremium": 30000
      }
    ],
    "professional_liability": [
      {
        "id": "cov-003",
        "name": "Professional Liability",
        "minLimit": 100000,
        "maxLimit": 5000000,
        "defaultLimit": 1000000,
        "minPremium": 1000,
        "maxPremium": 100000
      }
    ]
  },
  "forms": {
    "general_liability": [
      {
        "id": "GL-001",
        "name": "General Liability Application",
        "required": true,
        "description": "Standard general liability application form"
      },
      {
        "id": "GL-002",
        "name": "Additional Insured Endorsement",
        "required": false,
        "description": "Endorsement to add additional insured parties"
      },
      {
        "id": "GL-003",
        "name": "Waiver of Subrogation",
        "required": false,
        "description": "Waiver of subrogation endorsement"
      }
    ],
    "professional_liability": [
      {
        "id": "PL-001",
        "name": "Professional Liability Application",
        "required": true,
        "description": "Standard professional liability application form"
      }
    ]
  },
  "billingOptions": [
    {
      "id": "bill-001",
      "name": "Annual",
      "code": "annual",
      "description": "Single annual payment",
      "installments": 1
    },
    {
      "id": "bill-002",
      "name": "Semi-Annual",
      "code": "semi_annual",
      "description": "Two payments per year",
      "installments": 2
    },
    {
      "id": "bill-003",
      "name": "Quarterly",
      "code": "quarterly",
      "description": "Four payments per year",
      "installments": 4
    },
    {
      "id": "bill-004",
      "name": "Monthly",
      "code": "monthly",
      "description": "Twelve payments per year",
      "installments": 12
    }
  ]
}

Configuration Sections

Rating Fields

Dynamic fields used for premium calculation and risk assessment. Each field includes validation rules and options.

Entity Types

Available business entity types with descriptions and codes for insured party classification.

Policy Types

Available insurance policy types with availability status and descriptions.

Coverage Options

Policy-specific coverage options with limits, premiums, and validation rules.

Forms

Required and optional forms for each policy type with descriptions and requirements.

Billing Options

Available payment plans with installment configurations.