Skip to main content

basics

/v2/private/engine/basics

Available Methods​

  • POST

POST /v2/private/engine/basics​

This endpoint is used to save information on the basics step in the engine flow.

Params​

ParamTypeDescription
genderString Enum - ['Male', 'Female']The user's selected gender
dateOfBirthDate (ISO)The user's date of birth
stageOfRetirementString Enum - ['notSoon', 'soon', 'early', 'late']The user's stage of retirement
Example request body
body: {
"gender": "Male",
"dateOfBirth": "2022-01-30T23:52:45.372+00:00",
"stageOfRetirement": "soon"
}

Returns​

The entire user object.

Example return object with user.insurance
user: {
gender: "Male",
dateOfBirth: "2022-01-30T23:52:45.372+00:00",
stageOfRetirement: "soon",
...,
insurance: {
lostInsurance: {
other: [],
dental: false,
health: false,
life: true,
vision: true
},
finances: {
monthlyAllowance: 100,
monthlyExpenses: 100,
totalAssets: 10000
},
health: {
bmi: 24,
drinker: true,
exerciser: true,
height: 91,
inCare: false,
practiceSelfCare: false,
seriousIllness: false,
sleepWell: false,
smoker: false,
weight: 177
},
objectives: {
coverCareCosts: 1,
coverFinalExpenses: 3,
coveragePermanence: 2,
enoughIncomeToRetire: 6,
policySize: 3,
settlePosthumousBills: 5,
willingnessToAnswerMoreQuestions: false
}
}
}
info

For more detailed information about each value in insurance, please refer to the user model docs.