Insurance Cloud Open API

Authenticates an approved integration using its Insurance Cloud key and passkey. If the credentials are valid, the endpoint returns an access token that should authorize subsequent API requests.

Headers

Request body

{
  "inscloudkey": "your_inscloud_key",
  "passkey": "your_passkey"
}

{
  "token": "1|your_access_token"
}

Responses

Sends one or more SMS messages in a single request. Each result is reported separately, making partial delivery failures easy to identify.

Headers

Request body

{
  "transaction": "Policy notification",
  "sms": [
    {
      "phone": "254718888888",
      "message": "Your policy is ready.",
      "policy_id": 125
    }
  ]
}

{
  "status": "success",
  "message": "1 SMS sent, 0 failed.",
  "summary": {"total": 1, "sent": 1, "failed": 0},
  "results": [
    {
      "index": 0,
      "phone": "254718888888",
      "message": "Your policy is ready.",
      "policy_id": 125,
      "transaction": "Policy notification",
      "sent": true,
      "error": null
    }
  ]
}

Responses

Returns sent SMS records in reverse chronological order, with date filtering and pagination.

Headers

Query parameters

{
  "status": "success",
  "filters": {"from": "2026-07-01", "to": "2026-07-27"},
  "summary": {
    "total": 1,
    "per_page": 20,
    "current_page": 1,
    "last_page": 1
  },
  "sms": [
    {
      "id": 42,
      "phone": "254718888888",
      "message": "Your policy is ready.",
      "policy_id": 125,
      "transaction": "Policy notification",
      "added_by": 7,
      "created_at": "2026-07-27T08:30:00.000000Z",
      "updated_at": "2026-07-27T08:30:00.000000Z"
    }
  ]
}

Responses

Returns the current SMS-unit balance available to the authenticated integration.

Headers

{
  "status": "success",
  "balance": 125
}

Responses

Sends an M-Pesa payment prompt to the supplied phone number and records the Safaricom checkout request for callback processing.

Headers

Request body

{
  "account": "POL-2026-001",
  "amount": 52736,
  "phone": "0718888888"
}

{
  "merchant_request_id": "29115-34620561-1",
  "checkout_request_id": "ws_CO_280720261230001234"
}

Responses

Issues DMVIC certificates for one or more vehicles linked to the policy identified by the risknote.

Request body

{
  "risknote": 100245,
  "email": "client@example.com",
  "phone": "254718888888",
  "vehicles": [{
    "registration": "KDA 123A",
    "start_date": "2026-07-27",
    "expiring": "2027-07-26"
  }]
}

Responses

Issues the next eligible certificate stage for an agent-owned policy. Insurance Cloud calculates the certificate period from the policy, instalments, receipts, and certificates already issued.

Additional headers

Request body

Responses

Retrieves a previously issued certificate using its DMVIC certificate number.

Request body

Responses

Checks whether a vehicle has overlapping insurance for the requested cover period.

Request body

Responses

Returns DMVIC certificate stock information for a configured insurer member company.

Request body

Responses

Returns insurer IDs, short and legal names, and a logo URL when available. Use ?search=term to filter by name.

Returns branch IDs, codes, locations, and cities. Use data[].id as client.branch_id.

Returns active risk-manager user IDs, names, and email addresses. Use data[].id as client.risk_manager_id.

Returns salesperson IDs, names, codes, and branch IDs. Use data[].id as client.sales_person_id when applicable.

Returns configured policy-tax IDs and names. Use data[].id as taxes[].tax_id.

Returns Motor benefit IDs and names. Use data[].id as vehicles[].benefits[].benefit_id.

Returns matching insurer rates, benefits, taxes, markup, instalments, and limits of liability.

Responses

Stores the customer, vehicle, and one or more calculated insurer options as a quotation. This does not create a policy.

Creates the client and motor policy from the selected quote option, including vehicles, taxes, and selected benefits.

Returns the unique configured inpatient limits in ascending order. Limited to ten requests per minute per IP.

Calculates available medical plans using principal age, spouse age, number of children, and inpatient limit.

Responses

Creates a medical policy for a client and family members using the selected insurer plan.

Lists supported standard product IDs and names.

Returns insurer options, premiums, benefits, logo URLs, and brochures for a standard product.

Creates a policy for a supported standard product with its taxes and optional benefit schedule.

Returns matching insurer plans based on destination, dates, rate type, and traveller count.

Creates a travel policy for the selected quote and stores each traveller and beneficiary record.

Creates a single prospect. Only p_name and status are required — everything else is optional.

Headers

Request body

{
  "p_name": "Jane Doe",
  "status": "New",
  "email": "jane@example.com",
  "phone": "254718888888",
  "sector": "Retail",
  "products": [
    {
      "product": "Motor Comprehensive",
      "comm_rate": 10,
      "premium": 50000,
      "commission": 5000
    }
  ],
  "assign_to": [7]
}

{
  "status": "success",
  "message": "Prospect created successfully.",
  "prospect": {
    "id": 154,
    "p_name": "Jane Doe",
    "status": "New",
    "expected_prem": 50000,
    "expected_comm": 5000,
    "created_at": "2026-08-28T09:12:00+00:00"
  }
}

Responses

Returns clients visible to the authenticated ERP employee, salesperson, or agent, ordered by client name.

Query parameters

Response data

Each client includes contact and identity details, address information, the assigned salesperson, and associated agents. Pagination is returned in meta and links.

Returns policies visible to the authenticated account, ordered by most recent start date.

Query parameters

Response data

Policy records include insurer, client, product, cover dates, risknote, premium, receipts, balance, salesperson, and agents.

Returns claims for policies visible to the authenticated account, ordered by most recent incident date.

Query parameters

Response data

Claim records include policy and insurer references, incident and reporting dates, status and progress, client, claimant, amounts, salesperson, and agents.