Fill Out Application

Once an application has been created, it can be updated using PUT /applications/{application_id}. As you submit values for parameters, you will get back any conditional questions that become relevant based on the values you've provided. You continue to update the application, by making PUT requests, until all required questions have been answered and the application has a status of complete.

For each parameter, Herald provides metadata for rendering the parameter on your front end. This includes information like parameter_text, input_type, and schema (for building front-end validation). Check out our full guide to Designing a Front-End Dynamic Application.

Herald also provides a property called [.h-code-link]affects_conditions[.h-code-link] to communicate if a parameter may trigger additional, conditional parameters. Any parameter that can potentially yield additional parameters will have affects_conditions : true. Herald recommends making a PUT each time a value is collected for a parameter where this is true, in order to check for conditional questions.

Example: Gross Sales is a parameter that is only relevant for certain class codes. In this case, the parameter for class code would have a value of affects conditions: true, and the parameter for Gross Sales would only be returned if one of the condition-triggering class codes was submitted when updating the application.

Read our step-by-step guide to filling out applications.