Skip to main content

All Insurers

Get all insurers using this endpoint.

GET /api/v1/client/insurers

Headers​

authorization : bearer token
session : client session token

Query param​

You can also specify and filter the kind of insurer that should be in the response, by using one of these parameters.

NameDescriptionRequiredType
emailFilter by email of the insurer. Example: email=support@kekbrokers.netNot RequiredString
nameFilter by name of the insurer. Example: name=KEK BrokersNot Requiredstring
typeFilter by insurer type. Example: type=INSURER Enum: "INSURER" "MICRO_INSURER"Not Requiredstring

Response Sample​

id
required
string

Unique ID of the company

subdomain
string >= 3 characters

Subdomain of the company

address
string or null

Address of the company

kind
string or null
Enum: "NON_LIFE" "LIFE" "HEALTH" "PENSION"

Kind of the insurer

type
required
string
Enum: "INSURER" "BROKER" "MICRO_INSURER" "DIGITAL_AGENT" "AGENT"
primaryColor
string
{
  • "id": "619c0911b46b424f5f3e470f",
  • "subdomain": "transnational",
  • "address": "123 Main Street, Suite 100, Greater Accra, Ghana",
  • "kind": "HEALTH",
  • "type": "INSURER",
  • "primaryColor": "string"
}