Quotes

When you create a submission, the application is submitted to the institution to request a quote. This request begins a process that can vary depending on the product. As soon as the submission is created, a [.h-code]quote_id[.h-code] will be provided in the submission response. This [.h-code]quote_id[.h-code] can be used to get the details of the quote, which will initially have a [.h-code]pending[.h-code] status.

Getting a Quote

When you make a submission, Herald creates an individual quote for each product that was included in the application. The submission response will include a [.h-code]quote_id[.h-code] for each quote in the [.h-code]quote_previews[.h-code] array, which can be used to get the details for each quote.

Copied

{
  "submission": {
    "id": "46f56b68-8276-470e-8f17-424f2739895b",
    "producer_id": "c5358d67-9692-43e7-a64a-5fd8d5760fd2",
    "quote_previews": [
      {
        "quote_id": "88fa7725-cd27-4672-a17f-506c83d1f821",
        "product_id": "prd_mc4r_herald_general_liability"
      },
			{
        "quote_id": "240476f9-2462-483d-9b0e-a7a5a4f4908c",
        "product_id": "prd_tv9r_herald_cyber"
      }
    ],
  }
}
 

One reason for this is because the amount of time it takes to receive a quote can vary depending on the product, from a few seconds to a few minutes. By getting the details of each quote individually, you can receive information on quotes that have finished processing while others are still pending. For example, if you create a submission for 2 products, both quotes will begin at a [.h-code]pending[.h-code] status. One institution may process the quote quickly, and return an [.h-code]active[.h-code] quote within seconds, while the other is still . You can choose to share the details of the  quote immediately, rather than waiting until all of the quotes have processed.

You can get the details of a quote using [.h-code]GET[.h-code] [.h-endpoint-link]/quotes/{quote_id}[.h-endpoint-link]. As stated above, every quote will begin with a [.h-code]pending[.h-code] status. While the status is [.h-code]pending[.h-code], most of the information in the response will be [.h-code]null[.h-code].

Copied

{
  "quote": {
    "id": "b00bf800-01c7-421a-bd3a-2e879f3d3b53",
    "product_id": "prd_0012_pigeon_general_liability",
    "status": "pending",
    "status_details": null,
    "portal_link": null,
    "naic_code": null,
    "insurers": null,
    "submission_id": "3092f26b-86c1-4c01-8097-2b213116b0e6",
    "prices": null,
    "files": null,
    "coverage_values": [],
    "risk_values": [],
    "bind_status": "unavailable",
    "quote_number": null,
    "contacts": null,
    "admitted": null,
    "created_at": "2023-11-28T14:55:41.615Z",
    "updated_at": "2023-11-28T14:55:41.615Z"
  }
}
 

Once Herald has finished communicating with the institution, the quote will progress to a non-pending status. You can check for status updates by polling the quote, or using webhooks. Learn more about quote status.

If the institution decides to provide a quote, the quote will move to an [.h-code]active[.h-code] status and all of the information about the quote will be available in the response. Make sure to check out what quote price details to expect.

Copied

{
  "quote": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "product": {
      "id": "prd_mc4r_herald_general_liability",
      "name": "Herald General Liability",
      "product_line": "General Liability",
      "institution": {
        "id": "ins_en39_herald",
        "name": "Herald",
    },
    "status": "active",
    "status_details": null,
    "portal_link": "https://www.example.com",
    "naic_code": "99999",
    "insurers": [
      {
        "naic_code": "24376",
        "name": "Macys Ins Co",
        "quota_share": 100
      }
    ],
    "submission_id": "0d4f6d8e-340d-4584-b43a-6d5ff926e9b8",
    "prices": {
      "premium_before_taxes_and_fees": 1240,
      "premium_with_taxes_and_fees": 1328,
      "details": [
        {
          "type": "premium",
          "text": "Premium (before taxes and fees)",
          "amount": 1216
        },
        {
          "type": "fee",
          "text": "Embedded Security",
          "amount": 101
        }
      ]
    },
    "files": [
      {
        "id": "d7c4579a-5450-4e79-bcfc-e918b3c8a564",
        "type": "quote_summary",
        "text": "Quote Summary",
        "status": "available"
      },
      {
        "id": "026fae5e-5af9-46d4-954c-0c8bfd7b62dc",
        "type": "application",
        "text": "Application",
        "status": "available"
      }
    ],
    "coverage_values": [
      {
        "coverage_parameter_id": "cvg_48oo_gl_effective_date",
        "value": "2022-11-10",
        "parameter_text": {
          "applicant_facing_text": "General Liability Effective Date",
          "agent_facing_text": "General Liability Effective Date"
        }
      },
      {
        "coverage_parameter_id": "cvg_c02a_gl_each_occurrence_limit",
        "value": 1000000,
        "parameter_text": {
          "applicant_facing_text": "Each Occurrence Limit",
          "agent_facing_text": "Each Occurrence Limit"
        }
      }
    ],
    "risk_values": [
      {
        "risk_parameter_id": "rsk_m4p9_insured_name",
        "value": "Miles Teller",
        "parameter_text": {
          "applicant_facing_text": "Business name",
          "agent_facing_text": "Business name"
        }
      }
    ],
    "bind_status": "available",
    "quote_number": "QPL12300005",
    "contacts": null,
    "admitted": true,
    "created_at": "2023-11-28T14:55:41.615Z",
    "updated_at": "2023-11-28T14:56:47.815Z"
  }
}
 
 

‍

Quote Metadata

[.icon-circle-blue][.icon-circle-blue]  See our full quote meta data at [.h-code]GET[.h-code] [.h-endpoint-link]/quotes/{quote_id}[.h-endpoint-link].

‍

Things to note

A quote can differ from the application that was submitted in a few ways. Also consider how file status can affect the way you consume our quotes.

• Additional coverage values: Quotes may have additional coverage values that you did not include in the submission. This happens because either Herald provided a default request value, or because the quote contains a coverage value provided by the institution, that could not be requested by the applicant. We outline this behavior in the Appendix.
• Different coverage values: Institutions have different appetites and sets of coverage options. As a result, a quote may have a different coverage value than the requested value. For any product, we make sure you get the closest coverage values to the ones requested using a process we call data coercion. For example, you could request an aggregate limit of $1,250,000. If the product you are quoting only supports a limit of $1,000,000 and $2,000,000, Herald would round this to $1,000,000.
• Fewer parameters: Most parameters are only relevant for certain products. As a result, the quote only includes the parameters that are relevant for the quoted product. If you submit an application for multiple products, each individual quote will only include the parameters that were relevant for the quote.
• Files: When a [.h-code]quote[.h-code] is successfully processed, some [.h-code]files[.h-code] may have the status [.h-code]processing[.h-code]. Poll our [.h-code]GET[.h-code][.h-endpoint-link]/quotes/{quote_id}[.h-endpoint-link]endpoint until the files you need have a the [.h-code]avaiable[.h-code] status. Learn more about how to get files here.

‍