Programs

The application question schema for an instant-quote program

Changed on

Exactly the questions Hedge's carrier integration asks for this program — the schema the carrier application is filed on — projected for your own application builder: sections of questions with stable keys, labels, types, options, help, and depends_on visibility dependencies. Collect answers against these keys, then save them to the submission's application via the application-workspace checkpoint. Optional lob/state check that the program lists that line / state.

Served from Hedge's schema cache only — the schema Hedge's own quoting already filed on; this read never calls the carrier. Until Hedge's first quote with a program the response is 404 code: application_schema_unavailable (the list endpoint's application_schema_available tells you in advance). Programs Hedge quotes itself have no schema: 404 code: no_application_schema pointing at GET /broker/markets/{market_id}/requirements.

questions (with schema_version) is the same application in the shared question shape: exactly the questions the Hedge broker workspace asks for this program, one flat list in order. key is the shared answer key: Hedge's fact key where the program's question means the same fact in the same form (so one answer can prefill every program that asks it), otherwise program.<program_slug>.<id>. show_if / required_if are the full condition rules, keyed by key. Pass lob for the coverage being quoted: programs whose questions depend on the products Hedge selects for a line (Blitz) resolve them from it. schema_version changes whenever questions change; cache per schema_version.

get/broker/programs/{program_id}/application-schema

Request

  • Base URL
    https://api.hedgespecialty.com/api/v1
  • Auth
    OAuth 2
    Authorization code: https://api.hedgespecialty.com/api/v1/oauth/authorize
    Client credentials
    Token URL: https://api.hedgespecialty.com/api/v1/oauth/token

Path parameters

program_idstring uuid required

Query parameters

lobstring
statestring

Response

The projected question schema and the program's shared questions

program_idstring uuid required
market_idstring uuid required
namestring required
program_category'instant_quote' required
contract_version'structured_v1' required
schema_fingerprintstring required

Content hash of the served schema; changes when the carrier's questions change. Per-application fingerprints for checkpoints come from the application-workspace.

titlestring nullable
descriptionstring nullable
schema_versionstring required

Content hash of questions.

Changes

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      endpoint added