Quote

Returns a list of quote results containing premiums that have been calculated based on details provided in the request. These details must include client demographics, chosen benefit options, and the providers and products they are interested in. Each request generates a new quote. Quotes are not saved by the API.

Request

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

Request payload is sent as HTTP JSON body.

Authentication

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

Header parameter name: userToken

JSON Schema

INSERT HERE

Examples

JSON Request Body

{
  "comboQuoteId": "string",
  "clients": [
    {
      "firstName": "string",
      "lastName": "string",
      "age": 0,
      "gender": "string",
      "smoker": true,
      "employedStatus": "Employed",
      "occupationId": 0,
      "isChild": false,
      "clientId": "string",
      "clientBenefits": [
        {
          "clientBenefitId": "string",
          "benefitId": 0,
          "loading": 1,
          "benefitProducts": [
            {
              "providerId": 0,
              "productId": 0
            }
          ]
        }
      ]
    }
  ],
  "settings": {
    "paymentFrequency": 0,
    "providerSettings": [
      {
        "providerId": 0,
        "vitalityDiscountSelected": false,
        "vitalityFeeSelected": true
      }
    ]
  }
}

Response

Success

200: Success

JSON Schema

INSERT HERE

Examples

Success Response

{
  "results": [
    {
      "providerId": 0,
      "providerName": "string",
      "providerLogoUrl": "string",
      "hexColor": "string",
      "hasErrors": true,
      "policyFee": 0,
      "vitalityFee": 0,
      "totalPremium": 0,
      "clients": [
        {
          "clientId": "string",
          "clientName": "string",
          "products": [
            {
              "clientBenefitId": "string",
              "benefitId": 0,
              "productId": 0,
              "productName": "string",
              "descriptions": [
                "string"
              ],
              "premium": 0,
              "errors": [
                {
                  "id": 0,
                  "message": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "quoteId": "string",
  "paymentFrequency": "string",
  "calcTime": 0,
  "apiVersion": "string"
}

Error

400: Request body is null or invalid

JSON Schema

INSERT HERE

Examples

Error Response

{
  "data": {
    "response": {
      "code": 0,
      "message": "string"
    }
  }
}

~~403:~~403: userToken is invalid or no longer valid