Insurance Covers API

Environment: Sandbox

List the motor insurance cover types and policy types, with their meanings, and the client type and gender values.

# Insurance Covers API

List the cover types and policy types you can sell, with what each one means, and the client type and gender values a policy takes. The lists are fixed, so call it once and keep the result.

## Endpoint
- **Method**: POST
- **URL**: https://sandbox.moolre.com/open/sales/insurance/covers

## Headers
| Header | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| Content-Type | string | Yes | Send application/json. |
| X-API-USER | string | Yes | Your Moolre username. |
| X-API-KEY | string | Yes | Your Private API Key for the paying wallet. |

## Request Body
| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| accountnumber | string | Yes | Your insurance agent wallet account number. |

## Response (200 Covers (ASC02))
The example is shortened to two covers and two policy types; the real reply lists all of them.

```json
{
  "status": "1",
  "code": "ASC02",
  "message": "Insurance covers and policy types",
  "data": {
    "covers": [
      {
        "cover_type": "third_party",
        "cover_code": "T",
        "name": "Third party",
        "description": "The legal minimum. Pays for injury or death of other people and damage to their property caused by the insured vehicle. Does not cover the insured vehicle itself."
      },
      {
        "cover_type": "third_party_amplified_private",
        "cover_code": "TPA",
        "name": "Third party amplified (private)",
        "description": "Third party cover with extended benefits for privately used vehicles, as set out in the insurer's policy schedule."
      }
    ],
    "policy_types": [
      {
        "pol_type": "PRIVATE_INDIVIDUAL_X_1",
        "pol_code": "MPP",
        "name": "Private individual",
        "description": "A private vehicle owned by an individual."
      },
      {
        "pol_type": "PRIVATE_CORPERATE_X_4",
        "pol_code": "MPC",
        "name": "Private corporate",
        "description": "A private vehicle owned by a company or organisation."
      }
    ],
    "client_types": [
      {
        "value": "I",
        "name": "Individual"
      },
      {
        "value": "C",
        "name": "Commercial"
      }
    ],
    "genders": [
      {
        "value": "M",
        "name": "Male"
      },
      {
        "value": "F",
        "name": "Female"
      }
    ],
    "currency": "GHS",
    "commission_rate": 0.1
  },
  "go": null,
  "meta": {
    "requestid": "req_c68f4c66115c26725c796242",
    "notices": []
  }
}
```

## Before you begin

Call these endpoints from your server with your Moolre username as X-API-USER and your Private API Key as X-API-KEY: never put the private key in a browser or a mobile app. Quote, Vehicles, VIN lookup and Covers only read: nothing is charged and no externalref is needed. Only Sell Insurance charges the wallet.

## Cover types

| cover_type | cover_code | Name | What it covers |
| --- | --- | --- | --- |
| third_party | T | Third party | The legal minimum. Pays for injury or death of other people and damage to their property caused by the insured vehicle. Does not cover the insured vehicle itself. |
| third_party_amplified_private | TPA | Third party amplified (private) | Third party cover with extended benefits for privately used vehicles, as set out in the insurer's policy schedule. |
| third_party_amplified_commercial | TPA | Third party amplified (commercial) | Third party cover with extended benefits for commercially used vehicles, as set out in the insurer's policy schedule. |
| third_party_fire_theft | F | Third party, fire and theft | Third party cover plus loss of or damage to the insured vehicle by fire or theft. |
| comprehensive | C | Comprehensive | Third party, fire and theft cover plus accidental damage to the insured vehicle. Cover mode 90. |
| comprehensive_full_cover | CX | Comprehensive (full cover) | Comprehensive cover at the full (100) cover mode. |

## Policy types

| pol_type | pol_code | Name | Insures |
| --- | --- | --- | --- |
| PRIVATE_INDIVIDUAL_X_1 | MPP | Private individual | A private vehicle owned by an individual. |
| PRIVATE_CORPERATE_X_4 | MPC | Private corporate | A private vehicle owned by a company or organisation. |
| TAXI_HIRING_CARS | MCH | Taxi and hiring cars | Taxis and cars let out for hire. |
| MAXI_AND_MINI_BUS | MCO | Maxi and mini bus | Commercial maxi and mini buses. |
| MOTOR_CYCLE | MCY | Motor cycle | Motor cycles and tricycles. |
| AMBULANCE_HEARSE_OWN_GOODS | MOG | Ambulance, hearse and own goods | Ambulances, hearses and vehicles carrying the owner's own goods. |
| ART_TANKERS_GEN_CARTAGE_Z_301 | MGC | Articulated trucks, tankers and general cartage | Articulated trucks, tankers and goods vehicles carrying goods for others. |
| SPECIAL_TYPE_Z_802 | MST | Special type | Special type vehicles such as plant and machinery. |
| TRADE_PLATES | MCT | Trade plates | Motor trade plates used by dealers and garages. |
| RIDE_HAILING_UBER_BOLT_YANGO | MUB | Ride hailing | Cars driven for ride hailing apps such as Uber, Bolt and Yango. |

## Codes

| Code | Meaning | Next step |
| --- | --- | --- |
| ASC00 | Authentication error (Covers). | Check X-API-USER, X-API-KEY and accountnumber. |
| ASC02 | Insurance covers and policy types. | The lists were returned in data. |
| ASC03 | Unknown error (Covers). | Ask again. |

[Quote a cover](https://docs.moolre.com/api/sales/insurance/quote) or [sell a policy](https://docs.moolre.com/api/sales/insurance).

## Fields every response can carry

These fields are additive: existing fields keep their names, order and types.

| Field | Meaning |
| :--- | :--- |
| meta | Always present, last in the object. meta.replayed is true only when the response is the stored answer to a repeated Idempotency-Key (absent otherwise). meta.requestid is the unique id of the request (also the X-Request-Id response header): quote it when you contact support. meta.notices is always an array, empty when there is nothing to report; each notice is { code, message, docs? }, for example that a deprecated way of sending credentials was used. See [Deprecations](https://docs.moolre.com/guides/deprecations). |

There is no outcome field. Decide the result from status, code and, on payment and transfer endpoints, data.txstatus (0 pending, 1 succeeded, 2 failed). These codes mean the result is unknown and may still succeed, so treat them as pending and check the status: PY01, PY02, TR01, TR02, TP11, TP18, APY10, APY16, ASL06, IS30, SYS500. Status 1 with TR08, OBGH01, OTGH01, OBNG01, GHQ03 or OM03 is final success; any other status 1 is an accepted, unfinished request.

Send X-Moolre-Http-Status: strict to receive real HTTP status codes (400, 401, 403, 404, 409, 422, 429, 5xx) instead of HTTP 200. See [Responses and request IDs](https://docs.moolre.com/guides/responses).

Back to the Moolre AI documentation index