Bank Indemnity Policy

Create a new policy on the platform. There are several policies available. The following are the policies. In creating the policy for the product, there are some credentials needed for the respective policies. These required credentials are highlighted in the subsection below.

This endpoint allows you to create a policy.

POST /api/v1/client/policies

Headers

authorization : bearer token

refer to authentication

sessionToken : client session token

refer to authentication

Body param

policyNo	string Optional policy number
coverageType	string Optional coverage type for the policy. It is automatically derived from product information (if any)
generateInvoice	boolean Default: true Whether the system should auto generate a debit after creating the policy
currency required	string Policy currency code. Refer to /currencies for available currencies.
startDate required	string Policy start date in iso8601 format
endDate required	string Policy end date in iso8601 format
productId required	string Product id of the policy
oldPolicyId	string The id of the old policy, if any. This is used only if business type of the policy is RENEWAL
clientId	string Client Id. Optional if policy is created by a client
originatingStaffId	string The staff who sold the policy to the client. If null, currently logged in staff will be used. Optional if the policy is created from a client application
notes	string Additional notes about the policy
premium required	number >= 1 Policy premium
exchangeRate	number >= 0 Default: 1 Currency exchange rate
businessType required	string Enum: "NEW_BUSINESS" "CROSS_SELLING" "RENEWAL" "EXTENSION" Policy business type
businessCategory	string Default: "LOCAL" Enum: "LOCAL" "GLOBAL" Business category of the policy. Default is LOCAL
coverType	string Provided coverType if the policy uses one coverType for all assets. If some assets have different coverTypes, then it must be provided in the assets property
policyType	string Enum: "AUTO" "BANKERS_INDEMNITY" "BLANKET_BOND" "BONDS" "BOILER_OR_PRESSURE_VESSEL" "BURGLARY" "BUSINESS_INTERRUPTION" "MONEY" "DIRECTORS_OFFICERS_LIABILITY" "ELECTRONIC_EQUIPMENT" "EMPLOYERS_LIABILITY" "ERECTION_ALL_RISKS" "CONTRACTORS_ALL_RISKS" "FIDELITY_GUARANTEE" "GENERAL_LIABILITY" "GOODS_IN_TRANSIT" "GROUP_PERSONAL_ACCIDENT" "HOME" "MARINE" "PERSONAL_ACCIDENT" "PLANT_ALL_RISKS" "PLANT_AND_MACHINERY" "PROFESSIONAL_INDEMNITY" "PROPERTY_DAMAGE" "PUBLIC_LIABILITY" "TRAVEL" "AVIATION" "WORKMENS_COMPENSATION" "FIRE_AND_ALLIED_PERILS" "ASSETS_ALL_RISKS" "AGRICULTURAL" "STOCK_DETERIORATION" "MOTOR_TRADERS" "LIFE" "GROUP_LIFE_PERSONAL_ACCIDENT" "GROUP_LIFE" "GROUP_FUNERAL" "HEALTH" "PENSION" Type of policy
	object Additional information about the policy
groupId	string Id of the group which the policy belongs to
required	Array of objects (BankersIndemnityAssetDto)

{

• "policyNo": "POL-0012",
• "coverageType": "MOTOR_COMPREHENSIVE",
• "generateInvoice": true,
• "currency": "GHS",
• "startDate": "2020-01-01T00:00:00.000Z",
• "endDate": "2020-12-01T00:00:00.000Z",
• "productId": "619c0911b46b424f5f3e470f",
• "oldPolicyId": "619c0911b46b424f5f3e470f",
• "clientId": "619c0911b46b424f5f3e470f",
• "originatingStaffId": "619c0911b46b424f5f3e470f",
• "notes": "This is an auto insurance policy. It covers a car.",
• "premium": 5000,
• "exchangeRate": 1,
• "businessType": "NEW_BUSINESS",
• "businessCategory": "LOCAL",
• "coverType": "COMPREHENSIVE",
• "policyType": "AUTO",
• "additionalInformation": {

  • "formSerialNumber": "AAFE123456789"

  },
• "groupId": "63403b8a088f7a3cd5f8e717",
• "assets": [

  • {

    • "sumInsured": 100000,
    • "description": "lorem ipsum dolor sit amet consectetur adipiscing elit",
    • "limitPerClause": 5000,
    • "insuringClause": 100000,
    • "aggregateLimit": 10000

    }

  ]

}

Request Sample

policyNo	string Optional policy number
coverageType	string Optional coverage type for the policy. It is automatically derived from product information (if any)
generateInvoice	boolean Default: true Whether the system should auto generate a debit after creating the policy
currency required	string Policy currency code. Refer to /currencies for available currencies.
startDate required	string Policy start date in iso8601 format
endDate required	string Policy end date in iso8601 format
productId required	string Product id of the policy
oldPolicyId	string The id of the old policy, if any. This is used only if business type of the policy is RENEWAL
clientId	string Client Id. Optional if policy is created by a client
originatingStaffId	string The staff who sold the policy to the client. If null, currently logged in staff will be used. Optional if the policy is created from a client application
notes	string Additional notes about the policy
premium required	number >= 1 Policy premium
exchangeRate	number >= 0 Default: 1 Currency exchange rate
businessType required	string Enum: "NEW_BUSINESS" "CROSS_SELLING" "RENEWAL" "EXTENSION" Policy business type
businessCategory	string Default: "LOCAL" Enum: "LOCAL" "GLOBAL" Business category of the policy. Default is LOCAL
coverType	string Provided coverType if the policy uses one coverType for all assets. If some assets have different coverTypes, then it must be provided in the assets property
policyType	string Enum: "AUTO" "BANKERS_INDEMNITY" "BLANKET_BOND" "BONDS" "BOILER_OR_PRESSURE_VESSEL" "BURGLARY" "BUSINESS_INTERRUPTION" "MONEY" "DIRECTORS_OFFICERS_LIABILITY" "ELECTRONIC_EQUIPMENT" "EMPLOYERS_LIABILITY" "ERECTION_ALL_RISKS" "CONTRACTORS_ALL_RISKS" "FIDELITY_GUARANTEE" "GENERAL_LIABILITY" "GOODS_IN_TRANSIT" "GROUP_PERSONAL_ACCIDENT" "HOME" "MARINE" "PERSONAL_ACCIDENT" "PLANT_ALL_RISKS" "PLANT_AND_MACHINERY" "PROFESSIONAL_INDEMNITY" "PROPERTY_DAMAGE" "PUBLIC_LIABILITY" "TRAVEL" "AVIATION" "WORKMENS_COMPENSATION" "FIRE_AND_ALLIED_PERILS" "ASSETS_ALL_RISKS" "AGRICULTURAL" "STOCK_DETERIORATION" "MOTOR_TRADERS" "LIFE" "GROUP_LIFE_PERSONAL_ACCIDENT" "GROUP_LIFE" "GROUP_FUNERAL" "HEALTH" "PENSION" Type of policy
	object Additional information about the policy
groupId	string Id of the group which the policy belongs to
required	Array of objects (BankersIndemnityAssetDto)

{

• "policyNo": "POL-0012",
• "coverageType": "MOTOR_COMPREHENSIVE",
• "generateInvoice": true,
• "currency": "GHS",
• "startDate": "2020-01-01T00:00:00.000Z",
• "endDate": "2020-12-01T00:00:00.000Z",
• "productId": "619c0911b46b424f5f3e470f",
• "oldPolicyId": "619c0911b46b424f5f3e470f",
• "clientId": "619c0911b46b424f5f3e470f",
• "originatingStaffId": "619c0911b46b424f5f3e470f",
• "notes": "This is an auto insurance policy. It covers a car.",
• "premium": 5000,
• "exchangeRate": 1,
• "businessType": "NEW_BUSINESS",
• "businessCategory": "LOCAL",
• "coverType": "COMPREHENSIVE",
• "policyType": "AUTO",
• "additionalInformation": {

  • "formSerialNumber": "AAFE123456789"

  },
• "groupId": "63403b8a088f7a3cd5f8e717",
• "assets": [

  • {

    • "sumInsured": 100000,
    • "description": "lorem ipsum dolor sit amet consectetur adipiscing elit",
    • "limitPerClause": 5000,
    • "insuringClause": 100000,
    • "aggregateLimit": 10000

    }

  ]

}

Response Sample

policyNo	string Optional policy number
coverageType	string Optional coverage type for the policy. It is automatically derived from product information (if any)
generateInvoice	boolean Default: true Whether the system should auto generate a debit after creating the policy
currency required	string Policy currency code. Refer to /currencies for available currencies.
startDate required	string Policy start date in iso8601 format
endDate required	string Policy end date in iso8601 format
productId required	string Product id of the policy
oldPolicyId	string The id of the old policy, if any. This is used only if business type of the policy is RENEWAL
clientId	string Client Id. Optional if policy is created by a client
originatingStaffId	string The staff who sold the policy to the client. If null, currently logged in staff will be used. Optional if the policy is created from a client application
notes	string Additional notes about the policy
premium required	number >= 1 Policy premium
exchangeRate	number >= 0 Default: 1 Currency exchange rate
businessType required	string Enum: "NEW_BUSINESS" "CROSS_SELLING" "RENEWAL" "EXTENSION" Policy business type
businessCategory	string Default: "LOCAL" Enum: "LOCAL" "GLOBAL" Business category of the policy. Default is LOCAL
coverType	string Provided coverType if the policy uses one coverType for all assets. If some assets have different coverTypes, then it must be provided in the assets property
policyType	string Enum: "AUTO" "BANKERS_INDEMNITY" "BLANKET_BOND" "BONDS" "BOILER_OR_PRESSURE_VESSEL" "BURGLARY" "BUSINESS_INTERRUPTION" "MONEY" "DIRECTORS_OFFICERS_LIABILITY" "ELECTRONIC_EQUIPMENT" "EMPLOYERS_LIABILITY" "ERECTION_ALL_RISKS" "CONTRACTORS_ALL_RISKS" "FIDELITY_GUARANTEE" "GENERAL_LIABILITY" "GOODS_IN_TRANSIT" "GROUP_PERSONAL_ACCIDENT" "HOME" "MARINE" "PERSONAL_ACCIDENT" "PLANT_ALL_RISKS" "PLANT_AND_MACHINERY" "PROFESSIONAL_INDEMNITY" "PROPERTY_DAMAGE" "PUBLIC_LIABILITY" "TRAVEL" "AVIATION" "WORKMENS_COMPENSATION" "FIRE_AND_ALLIED_PERILS" "ASSETS_ALL_RISKS" "AGRICULTURAL" "STOCK_DETERIORATION" "MOTOR_TRADERS" "LIFE" "GROUP_LIFE_PERSONAL_ACCIDENT" "GROUP_LIFE" "GROUP_FUNERAL" "HEALTH" "PENSION" Type of policy
	object Additional information about the policy
groupId	string Id of the group which the policy belongs to
required	Array of objects (BankersIndemnityAssetDto)

{

• "policyNo": "POL-0012",
• "coverageType": "MOTOR_COMPREHENSIVE",
• "generateInvoice": true,
• "currency": "GHS",
• "startDate": "2020-01-01T00:00:00.000Z",
• "endDate": "2020-12-01T00:00:00.000Z",
• "productId": "619c0911b46b424f5f3e470f",
• "oldPolicyId": "619c0911b46b424f5f3e470f",
• "clientId": "619c0911b46b424f5f3e470f",
• "originatingStaffId": "619c0911b46b424f5f3e470f",
• "notes": "This is an auto insurance policy. It covers a car.",
• "premium": 5000,
• "exchangeRate": 1,
• "businessType": "NEW_BUSINESS",
• "businessCategory": "LOCAL",
• "coverType": "COMPREHENSIVE",
• "policyType": "AUTO",
• "additionalInformation": {

  • "formSerialNumber": "AAFE123456789"

  },
• "groupId": "63403b8a088f7a3cd5f8e717",
• "assets": [

  • {

    • "sumInsured": 100000,
    • "description": "lorem ipsum dolor sit amet consectetur adipiscing elit",
    • "limitPerClause": 5000,
    • "insuringClause": 100000,
    • "aggregateLimit": 10000

    }

  ]

}