Forms & Endorsements
Herald Forms are any document associated with the quote that an institution returned to Herald via API (as a list not a PDF). See our files array for PDFs returned from institutions.
The forms object is intended to return as many of the forms associated with a quote as possible via API as a list. We will pass on all forms that a carrier makes available in their APIs. You can see the forms on a quote by using
[.h-code]GET/[.h-code] [.h-endpoint-link]quotes{quote_id}[.h-endpoint-link]
Forms at Herald have some notable limitations:
Most of the forms Herald returns are endorsements. Other forms like the policy form, or the dec pages are not commonly returned via api as a list, but are sometimes returned as files on a quote. The list of forms Herald collects is not static. Each institution chooses what to send us and how to structure it (and do this on a per quote basis). This could make comparing forms across different quotes difficult. We are working on ways to improve this, but if you are experiencing challenges, please contact our customer success team.
When Herald returns a form number we have found institutions tend to include a unique ID for each form, and an edition date for that form. If an institution provides those two separately, we concatenate them. Please note, a form could change title and or form number without Herald having any notice. And so we caution developers not to treat form titles or IDs as stable, or always being paired in the same combinations.
Some institutions do not provide any forms, or in some cases an institution who provides forms via API will not return forms for a particular quote. In either case you'll see this in your quote response:
[.h-code]GET/[.h-code] [.h-endpoint-link]quotes{quote_id}[.h-endpoint-link]
