Get Policy Product

Gets all of the available insurance policy products available to your channel.

Get a list of insurance policy products

GEThttps://channel.sandbox.casava.co/api/channel-service/v1/policy

Authorization

api_key

Query parameters

Header parameters

Response

200404

successful operation

Body

application/json

policyCode*string

unique reference code of the insurance policy

Example: "hospicash"

policyName*string

short summary description of the insurance product

Example: "health cash insurance "

descriptionstring

detailed description of the insurance product

Example: "policy description"

durationnumber

used in computing the end date for the insurance policy alongside the installment value

Example: 12

installmentenum

allowed data type for the field

DAILYWEEKLYMONTHLYYEARLYONETIME

autoIssueboolean

flag to signfy that the insurance policy would be auto issued once accepted

fieldGroupsarray of FieldGroup (object)

perilsarray of PolicyPerils (object)

Request

JavaScriptCurlPython

const response = await fetch('https://channel.sandbox.casava.co/api/channel-service/v1/policy', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "policyCode": "hospicash",
    "policyName": "health cash insurance ",
    "description": "policy description",
    "duration": 12,
    "installment": "DAILY",
    "autoIssue": false,
    "fieldGroups": [
      {
        "fieldGroupId": "fieldGroupId",
        "title": "field group name",
        "description": "field group description",
        "fields": [
          {
            "fieldId": "fieldId",
            "title": "field name",
            "fieldType": "string",
            "optional": true,
            "description": "field description",
            "min": 0,
            "max": 0
          }
        ]
      }
    ],
    "perils": [
      {
        "name": "peril name",
        "title": "policy peril title",
        "description": "policy peril description"
      }
    ]
  }
]

Sample Response

{
    "statusCode": 200,
    "message": "successful operation",
    "data": {
        "policy": [
            {
                "policyCode": "INCOMEPROTECT",
                "policyName": "Income Protection Insurance",
                "description": "Protect your job against unforeseen risk",
                "duration": 12,
                "installment": "MONTHLY",
                "autoIssue": true,
                "perils": [
                    {
                        "name": "personalaccident",
                        "title": "Personal Accident",
                        "description": "policy peril description"
                    },
                    {
                        "name": "personalaccident2",
                        "title": "Personal Accident",
                        "description": "policy peril description"
                    },
                    {
                        "name": "personalaccident3",
                        "title": "Personal Accident",
                        "description": "policy peril description"
                    }
                ],
                "fieldGroups": [
                    {
                        "fieldGroupId": "HOMEADDRESS",
                        "title": "Home Address ",
                        "description": "field groups for the home address of the policy holder ",
                        "fields": [
                            {
                                "fieldId": "STREETNUMBER",
                                "title": "Street Number",
                                "fieldType": "string",
                                "optional": false,
                                "description": "street number of the policy holder",
                                "min": 255,
                                "max": 255
                            },
                            {
                                "fieldId": "STREETNAME",
                                "title": "Street Name ",
                                "fieldType": "string",
                                "optional": false,
                                "description": "street name of the policy holder",
                                "min": 255,
                                "max": 255
                            },
                            {
                                "fieldId": "CITY",
                                "title": "City",
                                "fieldType": "string",
                                "optional": false,
                                "description": "city of the policy holder",
                                "min": 255,
                                "max": 255
                            },
                            {
                                "fieldId": "COUNTRY",
                                "title": "Country",
                                "fieldType": "string",
                                "optional": false,
                                "description": "country of the policy holder ",
                                "min": 255,
                                "max": 255
                            },
                            {
                                "fieldId": "STATE",
                                "title": "State",
                                "fieldType": "string",
                                "optional": false,
                                "description": "state of the policy holder",
                                "min": 255,
                                "max": 255
                            }
                        ]
                    },
                    {
                        "fieldGroupId": "IDENTITY",
                        "title": "Identification",
                        "description": "field groups for identification requirement of the policy holder ",
                        "fields": [
                            {
                                "fieldId": "IDTYPE",
                                "title": "Identification Type ",
                                "fieldType": "string",
                                "optional": true,
                                "description": "the allowed identification type for the policy holder ",
                                "min": 255,
                                "max": 255
                            },
                            {
                                "fieldId": "IDNUMBER",
                                "title": "Identification Number",
                                "fieldType": "string",
                                "optional": true,
                                "description": "the identification number attached to the identification type ",
                                "min": 255,
                                "max": 255
                            }
                        ]
                    }
                ]
            }
        ],
        "total": 1,
        "totalPages": 1,
        "currentPage": 0
    }
}