Skip to main content

start

/v2/private/termLife/start

Available Methods​

  • POST

POST /v2/private/termLife/start​

This endpoint is used to start the term life flow, it will create the required keys on the user model to proceed through the term life and use the /selectPrice end point to submit pricing information. This should be used on mount of the first page of the term life flow if the user hasn't started the flow yet

Params​

ParamTypeDescription
Example request body

Returns​

The entire user object with an updated termLife object.

Example return object with user.termLife
user: {
  termLife: {
            lastUpdated: "2022-08-23T20:07:12.032Z",
            lastViewedScreen: {
                screenId: "care",
                date: "2022-08-23T20:07:12.031Z"
            },
            selectedPrice: 70000,
            monthlyRateMultiplier: 0.00887,
            monthlyRateMultiplierLastUpdated: "2022-08-23T20:36:54.075Z",
            priceChangeLog: [
              {
                direction: "none",
                date: "2022-08-16T14:05:13.051Z",
                screenId: "start"
              },
              {
                direction: "up",
                date: "2022-08-16T14:05:46.016Z",
                screenId: "start"
              },
              {
                direction: "up",
                date: "2022-08-16T14:06:04.208Z",
                screenId: "care"
              },
              {
                direction: "none",
                date: "2022-08-16T14:11:01.417Z",
                screenId: "care"
              },
              {
                direction: "none",
                date: "2022-08-16T14:14:27.608Z",
                screenId: "care"
              },
              {
                direction: "none",
                date: "2022-08-16T14:40:05.463Z",
                screenId: "care"
              },
              {
                direction: "none",
                date: "2022-08-16T15:40:29.224Z",
                screenId: "care"
              },
              {
                direction: "none",
                date: "2022-08-23T20:07:12.028Z",
                screenId: "care"
              }
            ],
            incrementValue: 10000,
            inflationPercentage: 0.008,
            order: {
                orderId: "termLife-49E84256",
                submittedOn: "2022-08-17T18:10:03.408Z",
                orderType: 2
            },
            minimumPrice: 150000
        },
}
info

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