QuoteConfig

Returns a list of input parameters that are used when configuring the different benefits within the /quote calculation request. The returned input parameters are defined by their type (eg. dropdown list) and their accepted option values, and are grouped by the benefits they are relevant for. This data could be used to render UI elements for data capture during the configuration of a quote.

Request

• Type: GET
  
• Path: /quoteConfig
  
• URL (Test env): https://quote-engine-test.blackfin.tools/quoteConfig

Authentication

A security user token is required to authenticate the request source. BlackFin will generate this and provide it separately.

• Header parameter name: userToken

Response

Success ✅

200:

JSON BodySchema

INSERT HERE

Examples

{
  "quoteConfig": {
    "benefits": [
      {
        "benefitId": 0,
        "benefitName": "string",
        "inputs": [
          {
            "inputId": "string",
            "inputLabel": "string",
            "inputType": "string",
            "inputOptions": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ]
      }
    ]
  }
}

Error

403: userToken is invalid or no longer valid