Skip to main content

Providers

Returns a list of the insurance providers supported by the API, along with the benefits and products that they offer. This data will only change a few times per year, depending on any renaming or addition/removal of products by the insurers.

Request


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

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 ✅

  • HTTP response code: 200
JSON Body

INSERT HERE

Examples
Success Response
{
  "providerId": 0,
  "providerName": "string",
  "hexColor": "string",
  "logoUrl": "string",
  "benefits": [
    {
      "benefitId": 0,
      "benefitName": "string",
      "products": [
        {
          "productId": 0,
          "productName": "string"
        }
      ]
    }
  ]
}

 

Error ❌

  • HTTP response code: 403