After policies have been created on the MID Portal, insurance companies can get the details of the policy by using the following endpoint;
| METHOD | ENDPOINT |
| GET | https://api.nicmid.com/apiv1/motor_policies/[server_reference] |
| PARAM | DESCRIPTION |
| policy_number_or_reference | is the policy number generated by the MID portal or reference provided by the user when the policy was created on the MID Portal either directly on the portal or via an API call. We recommend using a unique reference number that identifies the policy. The policy number is automatically generated by the MID portal.
|
RESPONSE
The response return the above call is a json object with the following params;
| PARAM | DATA TYPE | DESCRIPTION |
| reference | String | This is a unique reference number that uniquely identifies each record of motor policy. IT must be unique for each entry. This is not the policy number of the policy and hence must be unique. This is a required field. |
| server_reference | String | This is a unique reference number generated by the MID Engine for every record of motor policy. |
| policy_number | String | This is the policy number generated by the MID Engine. |
| sticker_number | String | This is the Sticker number for the policy if any. There will be not sticker number for uploaded historical data. |
| vehicle_registration | String | This is the Vehicle Registration number. Eg. “GT 7771 17” |
| make | String | This is the make of the vehicle eg: “Toyota” |
| model | String | This is the model of the vehicle eg: “Avalon” |
| chasis_number | String | This is the chasis number of the vehicle |
| body_type_code | String | This is the body type code of the vehicle. Refer to the body type codes table in the appendix |
| Seats | Decimal | This is the number of seats in the insured vehicle |
| year_of_manufacture | String | This is the year of manufacture for the vehicle eg: “2019” |
| cubic_capacity | Integer | This ithe cubic capacity of the vehicle. Eg. 1800 cc, 2200 cc |
| mileage | Integer | This is the mileage covered by the motor vehicle. It should be in miles |
| color | String | This is the color of the vehicle. |
| fleet | Boolean | Indicates if the vehicle belongs to a fleet, boolean |
| currency_code | String | This is the currency cod of the policy. Refer to the currency codes table in the appendix eg: “GHS” |
| exchange_rate | Decimal | This is the exchange rate for the policy |
| cover_type_code | String | This is the code for the cover Type. Refer to Cover_Type_Code under appendix |
| schedule_code | String | This is the code for the Schedule. Refer to Schedule Code under Appendix |
| computation_type_code | String | This is the code for the computation type. Refer to the computation types table in the appendix |
| Days | Integer | This is the number of days covered by the policy |
| inception_date | String | This is the inception date of the policy and is of the format “YYYY-MM-DD” eg. “2019-01-29” for 29th January, 2019. |
| expiry_date | String | This is the expiry date of the policy and is of the format “YYYY-MM-DD” eg. “2019-01-29” for 29th January, 2019. |
| sum_insured | Decimal | This is the sum insured amount for the policy it is required under comprehensive policies |
| sum_insured_rate | Decimal | This is the sum_insured_rate |
| sum_insured_charge | Decimal | This is the charge for the sum insured amount on the policy |
| Excess_type_code | String | This is the type of excess taken by the customer. Refer to the Excess Type Codes table in the appendix |
| excess_rate | Decimal | This is the rate applied for the excess chosen |
| excess_amount | Decimal | This is the amount of excess take by the customer |
| excess_charge | Decimal | This is the charge for the excess amount taken |
| total_premium | Decimal | This is the total premium charged for policy |
| co_insure_code | String | This is the short code for the insurance company with whom the policy is co_insured. |
| co_insure_rate | Decimal | This is the percentage of the policy that is co_insured |
| co_insure_amount | Decimal | This is the proportion of the policy’s sum insured that is co_insured |
| tppd_limit | Decimal | This is the TPPD Limit of the policy |
| tppd_rate | Decimal | This is the TPPD rate of the policy |
| extra_tppd_charge | Decimal | This is the charge for extra tppd taken by the client. |
| basic_premium | Decimal | This is the basic Premium for the policy and is equal to the tariffs defult premium for third party cover. |
| adjusted_premium | Decimal | This the basic_premium plus the |
| sticker_fee | Decimal | This is the sticker fee charged on the policy |
| personal_accident_charge | Decimal | This is the charge for Personal Accident |
| Levies | Decimal | This is the levies charged on the policy |
| Perils | Decimal | This is amount of cover take for perils |
| ecowas_peril_charge | Decimal | This is the Ecowas peril charge charged on the policy |
| brown_card_fee | Decimal | This is the fee charged for Ecowas brown card on the policy |
| personal_accident_charge | Decimal | This is the charge for personal accident |
| extra_seats_charge | Decimal | This is the charge for extra seats in excess of the default seating capacity of the policies body type |
| additional_peril_charge | Decimal | This is charge for additional peril cover take on the policy |
| discounts | JSON Object Array | This is a JSON object array that contains the list of discounts given on the policy. Refer to the Discounts Structure under appendix. |
| total_discounts | Decimal | This is total discounts given on the policy |
| sub_total_premium | Decimal | This is a subtotal of the premium and excludes discounts and loadings |
| legacy_policy_number | String | This is the policy number generated by the insurance companies underwriting software |
| Comment | Text | This is a comment give on the policy for future referencing purpose. |
| branch_code | String | This is the code for the Branch code. This code can be obtained by visiting branches under the mid portal. |
| loadings | JSON Object Array | This is array that contains the list of loadings given on a policy. |
| total_loadings | Decimal | This is the sum of loadings given on the policy. |
| customer | JSON object | This container information on the customer in whose name the policy is written. Refer to customer structure under appendix |
| intermediary | JSON Object | This container information on the Intermediary for the policy. Refer to Intermediary structure under appendix |