Getting Policies
Get details for a policy
Once a bind order has move to a status of [.h-code]accepted[.h-code], you can get the details of the policy that has been created. The [.h-code]id[.h-code] of the policy will be provided in the bind order response in the [.h-code]policy[.h-code] object:
Getting the 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:
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 [.h-code]policy_number[.h-code] is the policy number provided by the institution, unlike the [.h-code]id[.h-code] which is the unique id provided by Herald.
- Every policy has a [.h-code]files[.h-code] 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 [.h-code]actions[.h-code] array contains actions with an [.h-code]open[.h-code] status, you should complete these actions to prevent the policy from being cancelled. Learn more in our guide to completing actions.
- The time that a policy was created is communicated in the [.h-code]created_at[.h-code] property, but Herald currently does not provide a policy status. To check the status of the policy, you should direct users to the [.h-code]portal_link[.h-code].