ac329ca07dbb

latestOpenAPI 3.1.02026-08-0821338270.1 KB

Policy

Get Policy

Retrieve a Policy.

get/v1/agency/policy/{policy_id}

Path parameters

policy_idstring required

Response

Successful Response

policy_type'DP1' | 'DP2' | 'DP3' required

An enumeration.

insurance_structure'COI_MASTER_MGA' | 'STANDARD_MGA' | 'XMGA' | 'ARCHIVED'

An enumeration.

effective_datestring date

Effective date in YYYY-MM-DD format. Defaults to today.

effective_date_timezonestring nullable

updated_atstring date-time nullable

previous_policy_idstring nullable

renewal_policy_idstring nullable

renewal_quote_idstring nullable

renewal_status'draft' | 'quoted' | 'bound' | 'invalidated'

An enumeration.

renewal_start_datestring date nullable

renewal_end_datestring date nullable

agent_ui_urlstring nullable

Direct link to Agent UI, which can be used to complete quote.

carrierstring required

public_policy_idstring nullable required

status'issued' required

An enumeration.

policy_idstring required

Example response

{
  "primary_insured": {
    "mailing_address": {
      "street_address": "4825 Mount Sinyala Crossover",
      "city": "Fort Wayne",
      "state": "IN",
      "zip_code": "46808"
    },
    "previous_address": {
      "street_address": "4825 Mount Sinyala Crossover",
      "city": "Fort Wayne",
      "state": "IN",
      "zip_code": "46808"
    }
  },
  "additional_named_insured": [
    {
      "address": {
        "street_address": "4825 Mount Sinyala Crossover",
        "city": "Fort Wayne",
        "state": "IN",
        "zip_code": "46808"
      }
    }
  ],
  "effective_date": "2022-01-15",
  "policy_details": {
    "unique_tracking_id": "id-12345"
  },
  "properties": [
    {
      "property_id": "acf85fa5-4200-4303-96ba-012e546ff628",
      "address": {
        "street_address": "4825 Mount Sinyala Crossover",
        "city": "Fort Wayne",
        "state": "IN",
        "zip_code": "46808",
        "county": "Maricopa",
        "county_fips": "04013",
        "lat": 41.079273,
        "lng": -85.139351
      },
      "property_coverages": [
        {
          "name": "water_damage_limitation",
          "config": [
            {
              "type": "limit",
              "label": "Water Damage Limitation",
              "value": "10%",
              "default": "10%",
              "options": [
                "10%",
                "25%",
                "50%",
                "75%",
                "100%"
              ],
              "editable": "yes"
            },
            {
              "type": "sublimit",
              "label": "Water Damage Limitation - Fungi Rot Sublimit",
              "value": "5000",
              "default": "5000",
              "options": [
                "5000",
                "10000"
              ],
              "editable": "no"
            }
          ]
        }
      ],
      "property_manager": {
        "address": {
          "street_address": "4825 Mount Sinyala Crossover",
          "city": "Fort Wayne",
          "state": "IN",
          "zip_code": "46808"
        }
      },
      "property_details": {
        "heating_sources": [
          "furnace_electric"
        ],
        "has_barred_windows_over_50_percent": "Yes",
        "days_uninsured": 1,
        "builder_name": "Lennar Corp.",
        "fire_protection_class": "9",
        "address_info_s3_url": "s3://steadily-test-app-carlos/logs/2024/04/08/01HTZGD6ZKZK3F40VCGYW42N9I",
        "ca_dic_zone": "ineligible",
        "foundation_type": "concrete_slab",
        "garages": [
          {
            "size": "2"
          }
        ],
        "average_wall_height_feet": 9,
        "bathroom_details": [
          {
            "type": "Full"
          }
        ],
        "bedrooms": 3,
        "fireplaces": 1
      },
      "additional_insured": [
        {
          "loan_number": "JPM98765,12345",
          "address": {
            "street_address": "4825 Mount Sinyala Crossover",
            "city": "Fort Wayne",
            "state": "IN",
            "zip_code": "46808"
          }
        }
      ]
    }
  ],
  "policy_coverages": [
    {
      "name": "premises_liability",
      "label": "Premises Liability",
      "config": [
        {
          "type": "selected",
          "label": "Selected",
          "value": "yes",
          "default": "yes",
          "editable": "yes"
        },
        {
          "type": "limit",
          "label": "Limit",
          "value": "300000",
          "options": [
            "25000",
            "50000",
            "100000",
            "200000",
            "300000",
            "500000"
          ],
          "editable": "yes"
        }
      ]
    }
  ],
  "agent_ui_url": "https://app.steadily.com/spa/create-policy/?policy_loc={policy_id}",
  "public_policy_id": "OB3-AZ-100034386",
  "pricing": {
    "payment_option": {
      "plan": "full",
      "premium_cents": 90003,
      "total_cents": 90003,
      "installments": [
        {
          "due_date": "2021-04-24"
        }
      ],
      "surcharges": [
        {
          "label": "Credit card transaction fee",
          "state": "NY",
          "amount_cents": 200,
          "rate_basis_points": 200,
          "applies_to_payment_method": "credit_card"
        }
      ]
    },
    "payment_options_available": [
      {
        "plan": "full",
        "premium_cents": 90003,
        "total_cents": 90003,
        "installments": [
          {
            "due_date": "2021-04-24"
          }
        ],
        "surcharges": [
          {
            "label": "Credit card transaction fee",
            "state": "NY",
            "amount_cents": 200,
            "rate_basis_points": 200,
            "applies_to_payment_method": "credit_card"
          }
        ]
      }
    ]
  },
  "policy_id": "pol_100034386",
  "documents": [
    {
      "display_name": "Policy Packet",
      "file_name": "policy_packet.pdf",
      "file_code": "QUOTE",
      "url": "https://example.com/unique_document_url?token=32424",
      "steadily_universal_dwelling_id": "c67b1d514b26530ed0f8dedbb95a3a0c",
      "external_reference_id": "AQ4P-E6YV"
    }
  ]
}