Skip to main content

start

/v2/private/finalExpenses/start

Available Methods​

  • POST

POST /v2/private/finalExpenses/start​

Begin the Final Expenses flow by providing the user's gender and dateOfBirth.

The endpoint calculates an estimated price based on selected package and rounds to the nearest $2000 and returns it as the estimate. The endpoint also uses the gender and age of the user to calculate the inflation percentage as well as the monthly rate multiplier used to calculate the actual Monthly Rate on the client side.

Info

The user must have completed their planning before starting this step.

Planning completion is no longer required for starting SLI/Final Expenses as of April 5th, 2022

Params​

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

Returns​

The entire user object, with estimate, inflationPercentage, and monthlyRateMultiplier values calculated and saved to the user's preneed.finalExpenses object.

Example return object of just user.preneed.finalExpenses
user: {
  preneed: {
  finalExpenses: {
    bulletPoints: [
        "Viewing",
        "Funeral Service",
        "Traditional Burial"
    ],
    estimate: 10000,
    incrementValue: 2000,
    inflationPercentage: 52,
    lastUpdated: "2022-02-01T00:44:30.758Z",
    lastViewedScreen: {
        "screenId": 0,
        "date": "2022-02-08T20:03:54.338Z"
    },
    maximumPrice: 25000,
    minimumPrice: 2000,
    monthlyRateMultiplier: 0.00547,
    monthlyRateMultiplierLastUpdated: "2022-02-01T00:44:30.758Z",
  }
}
}
info

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