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

Authentication

A userToken API key is required to authenticate the request source. This should be included in the header of the request.See Authentication for more details.

Response

Success 

200: Success

JSON Schema
{
  "type": "object",
  "properties": {
    "providerId": {
      "type": "integer",
      "description": "The API's internal ID for the current provider. <br /><br />\r\nThis ID is used within the payload of the request of the `/quote` endpoint when requesting the calculation of a premium from this provider.",
      "format": "int32"
    },
    "providerName": {
      "type": "string",
      "description": "The display name of the current provider",
      "nullable": true
    },
    "hexColor": {
      "type": "string",
      "description": "A hex color value representing the dominant colour from the provider's logo that can be incorporated into the design of the UI if desired.",
      "nullable": true
    },
    "logoUrl": {
      "type": "string",
      "description": "The URL of the provider's logo image (hosted by BlackFin) that can be displayed with the UI if desired.",
      "nullable": true
    },
    "benefits": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "benefitId": {
            "type": "integer",
            "description": "The API's internal ID for the current benefit. <br /><br />\r\nThis ID is used within the payload of the request of the `/quote` endpoint when requesting the calculation of a premium for this benefit.",
            "format": "int32"
          },
          "benefitName": {
            "type": "string",
            "description": "The display name of the current benefit",
            "nullable": true
          },
          "products": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "productId": {
                  "type": "integer",
                  "description": "The API's internal ID for the current product. <br /><br />\r\nThis ID is used within the payload of the request of the '/quote' endpoint when requesting the calculation of a premium for this product.\"",
                  "format": "int32"
                },
                "productName": {
                  "type": "string",
                  "description": "The display name of the current product",
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "description": "An array of one or more objects detailing the product(s) which the current provider offers under this benefit.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "description": "An array of benefit objects detailing which benefits the current provider offers.",
      "nullable": true
    }
  },
  "additionalProperties": false
}


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

Error

403: userToken is invalid or no longer valid

Back to top