Skip to content

Insurance Covers

POST
/open/sales/insurance/covers

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.

history

Request History

Your request history will appear here.

Headers

X-API-USER stringrequired

Your Moolre username.

X-API-KEY stringrequired

Your Private API Key for the paying wallet.

Content-Type stringrequired

Send application/json.

Body Params

accountnumberstringrequired

Your insurance agent wallet account number.

Responses

The example is shortened to two covers and two policy types; the real reply lists all of them.

{
  "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": []
  }
}
data.coversarray
cover_type (use in policy.cover_type and match against Quote), cover_code, name and description.
data.policy_typesarray
pol_type (use in policy.pol_type), pol_code, name and description.
data.client_typesarray
Values for policy.customer.client_type: I and C.
data.gendersarray
Values for policy.customer.gender: M and F.
data.currencystring
GHS.
data.commission_ratenumber
Agent commission rate: 0.1 (10%) of the premium of an issued policy.

Fields every response can carry

On failures, read code, message and data (the first failing field). meta is always present and holds requestid (also the X-Request-Id header), notices and, only on idempotent replays, replayed. There is no outcome field: use status, code and data.txstatus. Send X-Moolre-Http-Status: strict to receive real HTTP status codes. See Responses and request IDs and Errors and status codes.

Language

curl --request POST \     --url 'https://api.moolre.com/open/sales/insurance/covers' \     --header 'X-API-USER: Your Username' \     --header 'X-API-KEY: YOUR_API_KEY' \     --header 'Content-Type: application/json' \     --data '{  "accountnumber": ""}'

Response

Body

{  "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": []  }}