Skip to main content

resources

/v2/private/engine/resources

Available Methods​

  • POST

POST /v2/private/engine/resources​

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

Note

This endpoint is a combination of /finances and /lostInsurance to be used on a specific engine step.

Params​

ParamTypeDescription
monthlyExpensesNumberThe user's monthly expenses
monthlyAllowanceNumberThe user's monthly allowance
totalAssetsNumberThe user's total assets
healthBooleanIf the user has lost health insurance
visionBooleanIf the user has lost vision insurance
dentalBooleanIf the user has lost dental insurance
lifeBooleanIf the user has lost life insurance
otherArray<String>An array of strings describing other lost insurances
Example request body
body: {
  "monthlyExpenses": 6000,
  "monthlyAllowance": 6000,
  "totalAssets": 500000,
  "health": false,
  "vision": false,
  "dental": false,
  "life": false,
  "other": ["some insurance"]
}

Returns​

The entire user object.

Example return object of just user.insurance
user: {
  insurance: {
    lostInsurance: {
      other: ["some insurance"],
      dental: false,
      health: false,
      life: false,
      vision: false
    },
    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.