Skip to main content

finances

/v2/private/engine/finances

Available Methods​

  • POST

POST /v2/private/engine/finances​

This endpoint is used to save finances data on user.insurance.finances.

Note

This endpoint is for editing insurance.finances data only, so it may not be used depending how the frontend looks.

Params​

ParamTypeDescription
monthlyExpensesNumberThe user's monthly expenses
monthlyAllowanceNumberThe user's monthly allowance
totalAssetsNumberThe user's total assets
Example request body
body: {
  "monthlyExpenses": 6000,
  "monthlyAllowance": 6000,
  "totalAssets": 500000
}

Returns​

The entire user object.

Example return object of just user.insurance
user: {
  insurance: {
    lostInsurance: {
      other: [],
      dental: false,
      health: false,
      life: true,
      vision: true
    },
    finances: {
      monthlyAllowance: 6000,
      monthlyExpenses: 6000,
      totalAssets: 500000
    },
    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.