QuoteInsuranceArgs

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/go-foresee-com/json-schema/go-foresee-com-quote-insurance-args-schema.json",
  "title": "QuoteInsuranceArgs",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/go-foresee-com-openapi.json#/components/schemas/QuoteInsuranceArgs",
  "type": "object",
  "required": [
    "profile",
    "lines"
  ],
  "properties": {
    "profile": {
      "$ref": "#/$defs/QuoteProfile"
    },
    "lines": {
      "$ref": "#/$defs/Lines"
    },
    "carriers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Restrict the panel; defaults to all supported carriers."
    },
    "include_failures": {
      "type": "boolean",
      "default": true
    }
  },
  "$defs": {
    "AutoAsk": {
      "type": "object",
      "additionalProperties": true,
      "description": "Auto coverage ask, as actual numbers. Required axes: bi, pd, coll_deductible, comp_deductible. An incomplete ask returns coverage_required naming the axes.",
      "properties": {
        "bi": {
          "type": "string",
          "description": "Bodily-injury liability, per-person/per-accident in $000s, e.g. \"100/300\"."
        },
        "pd": {
          "type": "integer",
          "description": "Property-damage liability in $000s, e.g. 100."
        },
        "coll_deductible": {
          "type": "integer",
          "description": "Collision deductible in dollars."
        },
        "comp_deductible": {
          "type": "integer",
          "description": "Comprehensive deductible in dollars."
        },
        "um": {
          "type": "string",
          "description": "Optional. UM/UIM BI in $000s, e.g. \"100/300\"."
        },
        "medpay": {
          "type": "integer",
          "description": "Optional. Medical payments in dollars."
        }
      }
    },
    "HomeAsk": {
      "type": "object",
      "additionalProperties": true,
      "description": "Home coverage ask, in dollars. All four axes required.",
      "properties": {
        "coverage_a": {
          "type": "integer",
          "description": "Dwelling limit — usually the replacement cost."
        },
        "coverage_e": {
          "type": "integer",
          "description": "Personal liability."
        },
        "coverage_f": {
          "type": "integer",
          "description": "Guest medical."
        },
        "aop_deductible": {
          "type": "integer",
          "description": "All-other-perils deductible."
        }
      }
    },
    "Lines": {
      "type": "object",
      "additionalProperties": true,
      "description": "REQUIRED — one map: each key names a line to price (auto, home, renters), each value that line's coverage ask as actual numbers.",
      "properties": {
        "auto": {
          "$ref": "#/$defs/AutoAsk"
        },
        "home": {
          "$ref": "#/$defs/HomeAsk"
        },
        "renters": {
          "$ref": "#/$defs/RentersAsk"
        }
      }
    },
    "QuoteProfile": {
      "type": "object",
      "additionalProperties": true,
      "description": "ZIP code, age (or dob) and — for auto — each vehicle's year/make/model are required; every other omission becomes a declared assumption reported back under assumptions/tighten_by.",
      "properties": {
        "zip_code": {
          "type": "string",
          "description": "5-digit ZIP. Required."
        },
        "age": {
          "type": "integer",
          "description": "Required, or pass dob."
        },
        "dob": {
          "type": "string",
          "description": "YYYY-MM-DD — accepted alternative to age."
        },
        "city": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "marital_status": {
          "type": "string"
        },
        "education": {
          "type": "string"
        },
        "employment_status": {
          "type": "string"
        },
        "occupation": {
          "type": "string"
        },
        "credit_range": {
          "type": "string",
          "description": "Used only where state law permits credit in rating."
        },
        "home_ownership_status": {
          "type": "string",
          "description": "rent / own"
        },
        "residence_type": {
          "type": "string"
        },
        "military_affiliation": {
          "type": "string",
          "description": "active / veteran / family / none. USAA is military-affiliated households only."
        },
        "memberships": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "effective_date": {
          "type": "string"
        },
        "prior_insurance": {
          "type": "object",
          "additionalProperties": true,
          "description": "Current/prior insurance for the same line: carrier, limits, tenure."
        },
        "companion_policies": {
          "type": "array",
          "description": "Policies the household already holds, each with the carrier that writes it. A carrier's multi-policy discount applies only to a policy it writes.",
          "items": {
            "type": "object",
            "additionalProperties": true,
            "required": [
              "line"
            ],
            "properties": {
              "line": {
                "type": "string",
                "description": "What the policy insures: home, renters, condo, auto, life, umbrella…"
              },
              "carrier": {
                "type": "string",
                "description": "Who writes it, e.g. \"State Farm\", \"AAA\". Without it no carrier's discount applies."
              },
              "in_force": {
                "type": "boolean",
                "description": "False for a policy that has lapsed or been cancelled."
              }
            }
          }
        },
        "auto": {
          "type": "object",
          "additionalProperties": true,
          "description": "Auto block: vehicles[] (year/make/model required) and drivers[].",
          "properties": {
            "vehicles": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true,
                "properties": {
                  "year": {
                    "type": "integer"
                  },
                  "make": {
                    "type": "string"
                  },
                  "model": {
                    "type": "string"
                  },
                  "ownership": {
                    "type": "string"
                  },
                  "annual_mileage": {
                    "type": "integer"
                  },
                  "primary_use": {
                    "type": "string"
                  },
                  "garaging_zip": {
                    "type": "string"
                  }
                }
              }
            },
            "drivers": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true,
                "properties": {
                  "relation": {
                    "type": "string",
                    "description": "self for the first."
                  },
                  "dob": {
                    "type": "string"
                  },
                  "years_licensed": {
                    "type": "integer"
                  },
                  "accidents": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "on"
                      ]
                    },
                    "description": "Empty list = clean record."
                  },
                  "violations": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "on",
                        "kind"
                      ]
                    }
                  },
                  "sr22_required": {
                    "type": "boolean"
                  }
                }
              }
            }
          }
        },
        "property": {
          "type": "object",
          "additionalProperties": true,
          "description": "Home/renters block.",
          "properties": {
            "year_built": {
              "type": "integer"
            },
            "construction_type": {
              "type": "string"
            },
            "roof_type": {
              "type": "string"
            },
            "square_feet": {
              "type": "integer"
            },
            "protection_class": {
              "type": "string"
            },
            "replacement_cost": {
              "type": "integer"
            },
            "devices": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "losses": {
              "type": "array",
              "items": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "RentersAsk": {
      "type": "object",
      "additionalProperties": true,
      "description": "Renters coverage ask, in dollars. Required axes: coverage_c, coverage_e, coverage_f, deductible.",
      "properties": {
        "coverage_c": {
          "type": "integer",
          "description": "Personal-property (contents) limit."
        },
        "coverage_e": {
          "type": "integer",
          "description": "Personal liability."
        },
        "coverage_f": {
          "type": "integer",
          "description": "Guest medical."
        },
        "deductible": {
          "type": "integer",
          "description": "All-perils deductible."
        },
        "coverage_d": {
          "type": "integer",
          "description": "Optional. Loss of use."
        }
      }
    }
  }
}