Skip to content

Get life policy by id

GET
/policies/life/{policyId}

Authorizations

BearerAuth
Type
HTTP (bearer)

Parameters

Path Parameters

policyId*
Type
string
Required

Responses

Success

application/json
JSON
{
  
"id": "string",
  
"policyNumber": "string",
  
"status": "string",
  
"startDate": "string",
  
"endDate": "string",
  
"basicPremium": 0,
  
"premiumLevy": 0,
  
"grossPremium": 0,
  
"currency": "string",
  
"package": {
  
  
"id": "string",
  
  
"name": "string",
  
  
"duration": 0,
  
  
"durationType": "string",
  
  
"coverType": "string",
  
  
"premium": 0,
  
  
"premiumType": "string",
  
  
"description": "string",
  
  
"externalReference": "string",
  
  
"benefits": [
  
  
  
{
  
  
  
  
"sumAssured": {
  
  
  
  
},
  
  
  
  
"name": {
  
  
  
  
},
  
  
  
  
"description": {
  
  
  
  
}
  
  
  
}
  
  
],
  
  
"premiumRates": [
  
  
  
{
  
  
  
  
"id": {
  
  
  
  
},
  
  
  
  
"createdAt": {
  
  
  
  
},
  
  
  
  
"updatedAt": {
  
  
  
  
},
  
  
  
  
"min": {
  
  
  
  
},
  
  
  
  
"max": {
  
  
  
  
},
  
  
  
  
"value": {
  
  
  
  
},
  
  
  
  
"addonType": {
  
  
  
  
},
  
  
  
  
"name": {
  
  
  
  
},
  
  
  
  
"categoryType": {
  
  
  
  
}
  
  
  
}
  
  
]
  
},
  
"policyHolder": {
  
  
"clientType": "string",
  
  
"name": "string",
  
  
"dateOfBirth": "string",
  
  
"phone": "string",
  
  
"contactPerson": "string",
  
  
"contactPersonPhoneNumber": "string",
  
  
"email": "string",
  
  
"physicalAddress": "string",
  
  
"postalAddress": "string",
  
  
"registrationNumber": "string",
  
  
"idType": "string",
  
  
"idNumber": "string",
  
  
"tpinNumber": "string",
  
  
"sector": "string"
  
},
  
"nextOfKin": {
  
  
"firstName": "string",
  
  
"lastName": "string",
  
  
"relationship": "string",
  
  
"idNumber": "string",
  
  
"phoneNumber": "string",
  
  
"dateOfBirth": "string"
  
},
  
"paidThroughDate": "string"
}

Playground

Authorization
Variables
Key
Value

Samples

Built with ❤️ by Hobbiton Technologies