Getting Policies

Getting a Policy

Once you have the id of the policy that’s been created, you can get the details of the policy using [.h-code]GET[.h-code] [.h-endpoint-link]/policies/{policy_id}[.h-endpoint-link]. The policy response will provide you details such as the policy number, coverage values, files, and more. Here’s a sample policy response:

GET /policies/{policy_id}

Copied

{
  "policy": {
      "id": "872e8b77-d1e6-40dc-bb7e-5777a3a1242f",
      "policy_number": "HRLD-F0576534BFA",
      "portal_link": "https://www.example.com?quoteId=44xa",
      "product_id": "prd_0050_herald_cyber",
      "price_details": {
          "premium": {
              "total": 2680,
              "breakdown": null
          },
          "institution_surcharges": {
              "total": null,
              "breakdown": null
          }
      },
      "actions": [
        {
          "id": "0864c501-7af3-46a6-89e5-cd4a1b06c495",
          "status": "open"
        }
      ],
      "files": [
        {
          "id": "819718f7-5494-45d6-8037-28a88e307cc1",
          "type": "policy",
          "status": "available",
          "text": "Policy"
        },
        {
          "id": "b0a9b3a5-a9e1-4680-a970-93170e32660a",
          "type": "declarations",
          "status": "available",
          "text": "Declarations"
        }
      ],
      "coverage_values": [
        {
          "coverage_parameter_id": "cvg_o3mw_cyb_effective_date",
          "value": "2023-08-01"
        }
      ],
      "created_at": "2023-08-01T01:13:30.714Z"
  }
}
 

As you can see in the example above, the policy response provides details such as the prices and the coverage details on the policy. Some details to call out:

• The policy_number is the policy number provided by the institution, unlike the id which is the unique id provided by Herald.
• Every policy has a files array containing relevant policy files. Check out our list of supported file types, and read our guide to getting files to learn more about downloading the contents of a file.
• A policy may require actions. If the actions array contains actions with an open status, you should complete these actions to prevent the policy from being cancelled. Learn more in our guide to completing actions.
• Price expectations for the policy response are similar to prices in the quote response and in fact there may be fewer details (ie discounts). Note, the price may change between the time a quote is received and a policy is bound, therefore the prices may not be the same in each response.
• The time that a policy was created is communicated in the created_at property, but Herald currently does not provide a policy status. To check the status of the policy, you should direct users to the portal_link.