API homepage

Use cases


What if you could offer unique features in your existing digital client experience using the algorithmic capabilities of your NaviPlan® planning engine? NaviPlan APIs can provide context surrounding a client’s financial plan in NaviPlan and create a powerful experience for clients as they engage with you on your digital platform.

FACT FINDING

Our NaviPlan fact finder API provides you with the capability to capture your client’s demographic information, current financial status and goals. This can be accomplished through either a blank fact finder or a fact finder that is pre-populated with current NaviPlan client data.

Demographics:



For example, the Demographics endpoint allows you to collect, update, or delete information about your client. By utilizing the demographicsID you are able to populate all demographic data. Responses include first name, last name, tax-filing status, address, and addition spouse and dependent data. You can request all demographics data within a client file using the /api/Demographics/{id} and GET /api/Demographics/{demographicId}/Dependents endpoints.


             {
  "factFinderId": 9476,
  "demographicsId": 10083,
  "externalSourceId": null,
  "jointAnalysis": false,
  "head1": {
    "firstName": "Test",
    "lastName": "Test",
    "birthDate": "1980-05-01T23:32:06.837",
    "gender": "Female",
    "taxFilingStatus": 5,
    "alreadyRetired": false,
    "externalDestinationId": null
  },
  "head2": null,
  "city": "string",
  "state": 53,
  "created": "2017-06-06T12:46:33.897",
  "externalDestinationId": null,
  "lockRetirement": false,
  "links": [
    {
      "rel": "self",
      "href": "http://mke-qa-npap01:6700/FactFinder/api/Demographics?factFinderId=9476"
    }
  ]
}

GOAL SUMMARY

When leveraging the retirement planning API, The Goals endpoint returns information about a plan’s retirement goal. Only the plan ID and the scenario type are required to request goal data. Responses include the type of goal, name, start date, end date, percentage of coverage, and options for correcting an off-track goal. You can request for all goals within a plan or a specific goal by goal ID in the /api/Goals/{id} endpoint.

Goal details:

Goal coverage:

Goal status and options for solving:


{
  "goal": {
    "identifier": {
      "id": 1
    },
    "type": 0,
    "description": "Retirement",
    "startDate": {
      "month": 1,
      "year": 2041,
      "day": 1,
      "urlEncoded": "2041-01-01",
      "formatted": "1/1/2041",
      "formattedNA": "1/1/2041",
      "formattedMMMdd": "Jan 1",
      "formattedMMMddyyyy": "Jan 1, 2041",
      "formattedMMMMddyyyy": "January 1, 2041",
      "formattedMMMyyyy": "Jan 2041",
      "toDateTime": "2041-01-01T00:00:00"
    },
    "endDate": {
      "month": 12,
      "year": 2066,
      "day": 31,
      "urlEncoded": "2066-12-31",
      "formatted": "12/31/2066",
      "formattedNA": "12/31/2066",
      "formattedMMMdd": "Dec 31",
      "formattedMMMddyyyy": "Dec 31, 2066",
      "formattedMMMMddyyyy": "December 31, 2066",
      "formattedMMMyyyy": "Dec 2066",
      "toDateTime": "2066-12-31T00:00:00"
    },
    "coverage": {
      "enabled": true,
      "populated": true,
      "value": {
        "formattedRaw": 0.73,
        "raw": 0.73007478831062286,
        "rawCappedAt100": 0.73007478831062286,
        "formatted": "73 %"
      }
    },
    "yearAssetsDepleted": {
      "enabled": true,
      "populated": true,
      "value": {
        "raw": 2017,
        "formatted": "2017"
      }
    },
    "assetsRemainingAfterFundingGoal": {
      "enabled": true,
      "populated": true,
      "value": {
        "raw": 0,
        "formattedNoDecimal": "$0",
        "formattedDecimal": "$0.00"
      }
    }
  },
  "links": [
    {
      "rel": "self",
      "href": "http://mke-qa-npap01:6700/Sparkles/api/Goals/0?planId=9627-8-2&=0"
    }
  ]
}

NET WORTH

Our NaviPlan APIs allow you to provide your client with their current financial status.

For example, the Net Worth endpoint returns net worth values for specific dates within a current plan. Only the plan ID and the scenario type are required to request net worth data. The response will contain net worth values at the plan date, retirement date, and at the plan’s end date. Itemized net worth information will also be available, including an individual client’s net worth, specific assets, and liabilities. You can request all net worth information within a plan by utilizing the planId in the /api/NetWorth endpoint.

Estimates assets vs. liabilities:

PROJECTED CASH FLOW

By utilizing our NaviPlan APIs, you can enable clients to see their projected cash flows for each year laid out in their plan.

For example, the projected cash flow resource provides cash flow information for each year of the projected plan. A specific year cash flow projection is also available. Within the cash flow resource, itemized cash inflows and outflows are provided. You can request for all cash flow information within a plan by utilizing the planId in the /api/ProjectedCashFlow endpoint.

Estimates:

Estimates of income vs expenses:

GOAL PLANNING

Our NaviPlan APIs give you the ability to capture your client’s goal information from their current plan. By utilizing this API, you can offer your clients insight into their goals and allow them to track their progress.

For example, the Goals endpoint returns information about a plan’s retirement, major purchase, and education goals. Only the plan ID and the scenario type are required to request goal data. Responses include the type of goal, name, start date, end date, percentage of coverage and options for solving an off-track goal. You can request any specific goal by utilizing the goalId in the /api/Goals/{id} endpoint.

Goal details:

Goal coverage:

Goal status and options for solving:



{
  "goal": {
    "identifier": {
      "id": 1
    },
    "type": 0,
    "description": "Retirement",
    "startDate": {
      "month": 1,
      "year": 2041,
      "day": 1,
      "urlEncoded": "2041-01-01",
      "formatted": "1/1/2041",
      "formattedNA": "1/1/2041",
      "formattedMMMdd": "Jan 1",
      "formattedMMMddyyyy": "Jan 1, 2041",
      "formattedMMMMddyyyy": "January 1, 2041",
      "formattedMMMyyyy": "Jan 2041",
      "toDateTime": "2041-01-01T00:00:00"
    },
    "endDate": {
      "month": 12,
      "year": 2066,
      "day": 31,
      "urlEncoded": "2066-12-31",
      "formatted": "12/31/2066",
      "formattedNA": "12/31/2066",
      "formattedMMMdd": "Dec 31",
      "formattedMMMddyyyy": "Dec 31, 2066",
      "formattedMMMMddyyyy": "December 31, 2066",
      "formattedMMMyyyy": "Dec 2066",
      "toDateTime": "2066-12-31T00:00:00"
    },
    "coverage": {
      "enabled": true,
      "populated": true,
      "value": {
        "formattedRaw": 0.73,
        "raw": 0.73007478831062286,
        "rawCappedAt100": 0.73007478831062286,
        "formatted": "73 %"
      }
    },
    "yearAssetsDepleted": {
      "enabled": true,
      "populated": true,
      "value": {
        "raw": 2017,
        "formatted": "2017"
      }
    },
    "assetsRemainingAfterFundingGoal": {
      "enabled": true,
      "populated": true,
      "value": {
        "raw": 0,
        "formattedNoDecimal": "$0",
        "formattedDecimal": "$0.00"
      }
    }
  },
  "links": [
    {
      "rel": "self",
      "href": "http://mke-qa-npap01:6700/Sparkles/api/Goals/0?planId=9627-8-2&=0"
    }
  ]
}