Skip to main content

lifeInsurance

/v2/private/life/lifeInsurance

Available Methods​

  • POST

POST /v2/private/life/lifeInsurance​

This endpoint is used to save information on the life Insurance step in the life flow.

Params​

ParamTypeDescription
insuranceCoverArray Enum - ['payingFuneral', 'unpaidBills', 'replaceMyIncome', 'leavingForFamily', 'donation']The user's insurance covers
selectionsArrayThe user's leave financial legacy
relationshipStatusArray Enum - ['married', 'divorced', 'dating', 'flySolo']The user's relationship status
haveChildrenString Enum - ['yesLiveWithMe', 'yesLiveOnTheirOwn', 'notYet', 'doNotWant']The user's childer status
workStatusBooleanThe user's work status
annualIncomeNumberThe user's totla annual income
setAsideNumberThe user's set aside saving
propertyStatusArray Enum - ['ownOutRight', 'ownedByBank', 'iRent']The user's property status
Example request body
body: { 
"insuranceCover": ["payingFuneral", "donation"],
"selections": [
{
"id": 2,
"title": "Spouse"
},
{
"id": 3,
"title": "Son"
}
],
"relationshipStatus": "married",
"haveChildren": "yesLiveWithMe",
"workStatus": true,
"annualIncome": "1000",
"setAside": "20000",
"propertyStatus": "ownOutRight"
}

Returns​

The entire user object.

Example return object with user.life
user: {
"life": {
"lifeInsurance": {
"objectiveCoverage": "payingBills",
"annualIncome": 1000,
"haveChildren": "yesLiveWithMe",
"insuranceCover": [
"payingFuneral",
"donation"
],
"leaveFinancialLegacy": {
"selections": [
{
"id": 2,
"title": "Spouse"
},
{
"id": 3,
"title": "Son"
}
]
},
"relationshipStatus": "married",
"setAside": 20000,
"workStatus": true
}
}
}