NaviPlan API API

by naviplancentral.com

No authHTTPSFinance

Overview

An API for accessing NaviPlan plan data for a client.

NaviPlan API is a finance API from naviplancentral.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 64 endpoints.

At a glance

Authentication: No auth
HTTPS: Yes
CORS: Unknown
Category: Finance
Base URL: https://demo.uat.naviplancentral.com/plan
Version: v1
Endpoints: 64
OpenAPI: Specification ↗
Spec updated: 2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://demo.uat.naviplancentral.com/plan/api/Advisors" \
  -H "Accept: application/json"

JavaScript

const response = await fetch("https://demo.uat.naviplancentral.com/plan/api/Advisors", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://demo.uat.naviplancentral.com/plan/api/Advisors",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/api/Advisors`	Retrieve Advisors
GET	`/api/Advisors/{householdId}/{clientId}`	Retrieve Advisors for a Client
GET	`/api/Advisors/{id}`	Retrieve an Advisor
GET	`/api/Assumptions`	Retrieve plan assumptions
GET	`/api/BusinessEntities`	Retrieve business entities
GET	`/api/BusinessEntities/{id}`	Retrieve a business entity
GET	`/api/Calculations/MonteCarlo`	Retrieve Monte Carlo results from standalone calc service
GET	`/api/DefinedBenefitPensions`	Retrieve defined benefit pensions
GET	`/api/DefinedBenefitPensions/{id}`	Retrieve a definedBenefitPension
POST	`/api/Eula/Accept`	Accepts the EULA
GET	`/api/Family`	Retrieve family
GET	`/api/GoalAdjustments/Education/{id}/Adjustments`	Retrieve the adjustments
POST	`/api/GoalAdjustments/Education/{id}/Calculations`	Perform calculations
GET	`/api/GoalAdjustments/GoalSuccessRates`	Returns a list of goals with their relevant success rates.
GET	`/api/GoalAdjustments/MajorPurchase/{id}/Adjustments`	Retrieve the adjustments
POST	`/api/GoalAdjustments/MajorPurchase/{id}/Calculations`	Perform calculations
GET	`/api/GoalAdjustments/Restrictions`	Returns a list of goal adjustment restrictions.
GET	`/api/GoalAdjustments/Retirement/Adjustments`	Retrieve the adjustments
POST	`/api/GoalAdjustments/Retirement/Calculations`	Perform calculations
GET	`/api/GoalAdjustments/{id}/WhatAreMyOptions`	Returns WAMO values for current goal
GET	`/api/Goals`	Retrieve goals
GET	`/api/Goals/{id}`	Retrieve goals
GET	`/api/HoldingCompanies`	Retrieve holding companies
GET	`/api/HoldingCompanies/{id}`	Retrieve a holding company
GET	`/api/Households`	Retrieve all Households associated with the user
GET	`/api/Liabilities`	Retrieve liabilities
GET	`/api/Liabilities/{id}`	Retrieve a liability
GET	`/api/LifestyleAssets`	Retrieve lifestyle assets
GET	`/api/LifestyleAssets/{id}`	Retrieve lifestyle assets
GET	`/api/LivePlan/Goals`	Retrieves all goals from the live plan
GET	`/api/LivePlan/Goals/Funding`	Retrieve a list of funding accounts
GET	`/api/LivePlan/Goals/{id}/WhatAreMyOptions`	Retrieve WAMO values for a given goal
GET	`/api/LivePlan/NetWorth/Accounts`	Retrieves accounts for a given plan
GET	`/api/LivePlan/NetWorth/Liabilities`	Retrieves liabilities for a given plan
GET	`/api/LivePlan/NetWorth/LifestyleAssets`	Retrieves lifestyle assets for a given plan
GET	`/api/LivePlan/NetWorth/RealEstate`	Retrieves real estate accounts for a given plan
GET	`/api/LivePlan/Projections/NetWorth`	Retrieves net worth projections
GET	`/api/LivePlan/Projections/{id}/NeedsVsAbilities`	Retrieves needs vs abilities projections
GET	`/api/NetWorth`	Retrieve net worth
POST	`/api/Password/HasUserSetPassword`	Determines if the currently logged in user has set their own password
GET	`/api/Password/PasswordRequirements`	Gets the password complexity requirements
POST	`/api/Password/Reset`	Resets the password for the supplied user name
POST	`/api/Password/Set`	Sets the password for the currently logged in user
GET	`/api/PlanInformation`	Retrieve plan information
GET	`/api/PlanStatuses`	Retrieve plan data statuses
GET	`/api/PortfolioAccounts`	Retrieve portfolio accounts
GET	`/api/PortfolioAccounts/{id}`	Retrieve a portfolio account
GET	`/api/ProjectedAnnualSummary`	Retrieve projected annual summaries
GET	`/api/ProjectedAnnualSummary/{id}`	Retrieve projected annual summary by id
GET	`/api/ProjectedCashFlow`	Retrieve projected cash flow
GET	`/api/ProjectedCashFlow/{id}`	Retrieve projected cash flow by id
GET	`/api/ProjectedGoals/AssetsFundingGoals`	Retrieve assets funding goals over time
GET	`/api/ProjectedGoals/NeedsVsAbilities`	Retrieve needs vs abilities data
GET	`/api/ProjectedNetWorth`	Retrieve projected net worth
GET	`/api/ProjectedNetWorth/{id}`	Retrieve projected net worth by id
GET	`/api/RestrictedStocks`	Retrieve restricted stocks
GET	`/api/RestrictedStocks/{id}`	Retrieve a restricted stock
GET	`/api/ServiceInformation/Statistics`	This resource can be used to check the status of the service.
GET	`/api/StockOptions`	Retrieve stock options
GET	`/api/StockOptions/{id}`	Retrieve a stock option
POST	`/api/auth/Login`	Start a session with the DomainProviders user store
GET	`/api/auth/LoginConfiguration`	Gets the login rules
POST	`/api/auth/Logout`	Auth_Logout
POST	`/api/auth/ResumeSession`	Validate and extend the duration of a session