Flexible inputs (beta)

Some select_one coverage parameters also accept integer values not included in their enum list. This provides more front-end options for your application.

At Herald we strive to make things easier for developers and brokers by standardizing information and being thoughtful about your front-end experience. That’s why we’re taking coverage parameters that used to be the [.h-code]number[.h-code] input type and making them into the [.h-code]select_one[.h-code] input type with a key caveat. These [.h-code]select_one[.h-code] coverage values will also accept any integer within a given range. These coverage parameters are only identified in this doc, and not yet in our API responses. Please use the list we provide in this doc to identify them.

Name	Parameter ID	Max	Min
Aggregate Limit	cvg_agj9_cyb_aggregate_limit	0	10,000,000
Business Income Coverage Limit	cvg_64oi_cyb_business_income_coverage_limit	5,000	1,000,000
Social Engineering Limit	cvg_mov6_cyb_social_engineering_limit	0	250,000
Aggregate Retention	cvg_7fsk_cyb_aggregate_retention	0	500,000
Waiting Period (Hours)	cvg_orn9_cyb_waiting_period	0	24

This is not a Breaking Change

The [.h-code]number[.h-code] input type is designed for you to create a free entry for a number on your front-end and send Herald the integer value. All of the coverage values in our pilot used to be the [.h-code]number[.h-code] input type and are now [.h-code]select_one[.h-code]. But the coverage values listed above will still accept any integer between their max and min, just like the [.h-code]number[.h-code] input type. Although the input type has changed, implementations built on the [.h-code]number[.h-code] input type will continue to work for these coverage values.

A Better UX Pattern

The [.h-code]select_one[.h-code] input parameters above also offer a curated list of values in a dropdown for your front-end. We created this list to save applicants time by having a dropdown instead of a free entry (which is how number input types are generally rendered on the front-end). We provide this list in the API response (see examples below) just as we would for any [.h-code]select_one[.h-code] input type.

[.icon-circle-blue][.icon-circle-blue] We provide the list of values for these [.h-code]select_one[.h-code] coverage values as integers because those are the values we accept. If you want to display the list as currency, for example, you’d need to parse the integers we provide and add that formatting.

You can also take advantage of the flexibility we provide by showing a list with an option for the applicant to override the dropdown.

Examples

Here’s how the aggregate limit appears in a [.h-code]PUT[.h-code] [.h-endpoint-link]/applications[.h-endpoint-link] response

Copied


"cvg_agj9_cyb_aggregate_limit",
"value": null,
"section": "Coverages",
"parameter_text": {
    "applicant_facing_text": "Aggregate Limit",
    "agent_facing_text": "Aggregate Limit"
},
"input_type": "select_one",
"relevant_products": [
    "prd_0050_herald_cyber"
],
"creates_array": false,
"affects_conditions": false,
"required_for": [],
"schema": {
    "type": "integer",
    "enum": [
        250000,
        500000,
        1000000,
        2000000,
        3000000,
        4000000,
        5000000,
        10000000
    ],
    "title": "Aggregate Limit"
}

Before it was a [.h-code]select_one[.h-code] Aggregate Limit was a [.h-code]number[.h-code] input type and would have looked like the example below.