NaviPlan API
An API for accessing NaviPlan plan data for a client.
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
An API for accessing NaviPlan plan data for a client.
Endpoints 64
Advisors
- GETRetrieve Advisors
/api/AdvisorsThis operation retrieves a list of all of the Advisors in the plan. - GETRetrieve Advisors for a Client
/api/Advisors/:householdId/:clientIdThis operation retrieves a list of all of the Advisors for the client. - GETRetrieve an Advisor
/api/Advisors/:idThis operation retrieves an Advisor from the plan.
Assumptions
- GETRetrieve plan assumptions
/api/Assumptions?planId=stringThis operation retrieves an object containing all assumptions for the specified plan.
BusinessEntities
- GETRetrieve business entities
/api/BusinessEntities?planId=stringThis operation retrieves a list of all of the business entities in the plan. - GETRetrieve a business entity
/api/BusinessEntities/:id?planId=stringThis operation retrieves a business entity from the plan.
Calculations
- GETRetrieve Monte Carlo results from standalone calc service
/api/Calculations/MonteCarlo?planId=stringCurrently just stubbed out, POC in development
DefinedBenefitPensions
- GETRetrieve defined benefit pensions
/api/DefinedBenefitPensions?planId=stringThis operation retrieves a list of all of the defined benefit pensions in the plan. - GETRetrieve a definedBenefitPension
/api/DefinedBenefitPensions/:id?planId=stringThis operation retrieves a defined benefit pension from the plan.
Eula
- POSTAccepts the EULA
/api/Eula/Accept
Family
- GETRetrieve family
/api/Family?planId=stringThis operation retrieves an object containing all familymembers for the specified plan.
GoalAdjustments
- GETRetrieve the adjustments
/api/GoalAdjustments/Education/:id/Adjustments?clientId=string&planId=stringThis function retrieves a goal and the adjustments made to it - POSTPerform calculations
/api/GoalAdjustments/Education/:id/Calculations?planId=stringThis function returns the posted object and the adjusted calculation values - GETReturns a list of goals with their relevant success rates.
/api/GoalAdjustments/GoalSuccessRates?clientId=string&planId=string - GETRetrieve the adjustments
/api/GoalAdjustments/MajorPurchase/:id/Adjustments?clientId=string&planId=stringThis function retrieves a goal and the adjustments made to it - POSTPerform calculations
/api/GoalAdjustments/MajorPurchase/:id/Calculations?planId=stringThis function returns the posted object and the adjusted calculation values - GETReturns a list of goal adjustment restrictions.
/api/GoalAdjustments/Restrictions?clientId=string&planId=stringThis function returns a list of adjustment restrictions for all goals. - GETRetrieve the adjustments
/api/GoalAdjustments/Retirement/Adjustments?clientId=string&planId=stringThis function retrieves a goal and the adjustments made to it for a particular client - POSTPerform calculations
/api/GoalAdjustments/Retirement/Calculations?planId=stringThis function returns the posted object and the adjusted calculation values - GETReturns WAMO values for current goal
/api/GoalAdjustments/:id/WhatAreMyOptions?clientId=string&planId=string
Goals
- GETRetrieve goals
/api/Goals?planId=stringThis operation retrieves a list of all of the goals in the plan. - GETRetrieve goals
/api/Goals/:id?planId=stringThis operation retrieves a goal from the plan.
HoldingCompanies
- GETRetrieve holding companies
/api/HoldingCompanies?planId=stringThis operation retrieves a list of all of the holding companies in the plan. - GETRetrieve a holding company
/api/HoldingCompanies/:id?planId=stringThis operation retrieves a holding company from the plan.
Households
- GETRetrieve all Households associated with the user
/api/Households?householdId=0This operation retrieves a list of households the current user has access to or one household specified by a householdId parameter
Liabilities
- GETRetrieve liabilities
/api/Liabilities?planId=stringThis operation retrieves a list of all of the liabilities in the plan. - GETRetrieve a liability
/api/Liabilities/:id?planId=stringThis operation retrieves a liability from the plan.
LifestyleAssets
- GETRetrieve lifestyle assets
/api/LifestyleAssets?planId=stringThis operation retrieves a list of all of the lifestyle assets in the plan. - GETRetrieve lifestyle assets
/api/LifestyleAssets/:id?planId=stringThis operation retrieves a lifestyle asset from the plan.
LivePlan
- GETRetrieves all goals from the live plan
/api/LivePlan/Goals?clientId=string&planId=string - GETRetrieve a list of funding accounts
/api/LivePlan/Goals/Funding?clientId=string&planId=stringThis function retrieves a list of funding accounts for the goals in the plan - GETRetrieve WAMO values for a given goal
/api/LivePlan/Goals/:id/WhatAreMyOptions?clientId=string&planId=stringThis function retrieves the WAMO values for the specified goal - GETRetrieves accounts for a given plan
/api/LivePlan/NetWorth/Accounts?clientId=string&planId=string - GETRetrieves liabilities for a given plan
/api/LivePlan/NetWorth/Liabilities?clientId=string&planId=string - GETRetrieves lifestyle assets for a given plan
/api/LivePlan/NetWorth/LifestyleAssets?clientId=string&planId=string - GETRetrieves real estate accounts for a given plan
/api/LivePlan/NetWorth/RealEstate?clientId=string&planId=string - GETRetrieves net worth projections
/api/LivePlan/Projections/NetWorth?clientId=string&planId=string - GETRetrieves needs vs abilities projections
/api/LivePlan/Projections/:id/NeedsVsAbilities?clientId=string&planId=string
NetWorth
- GETRetrieve net worth
/api/NetWorth?planId=stringThis operation retrieves an object containing net worth values for specific dates within the plan: * Plan Start Date * Retirement Date * Plan End Date.
Password
- POSTDetermines if the currently logged in user has set their own password
/api/Password/HasUserSetPassword - GETGets the password complexity requirements
/api/Password/PasswordRequirements - POSTResets the password for the supplied user name
/api/Password/Reset - POSTSets the password for the currently logged in user
/api/Password/Set
PlanInformation
- GETRetrieve plan information
/api/PlanInformation?planId=stringThis operation retrieves the high level plan information for a given plan
PlanStatuses
- GETRetrieve plan data statuses
/api/PlanStatuses?planId=stringThis operation retrieves the data statuses of the published plan if on demand updates are enabled
PortfolioAccounts
- GETRetrieve portfolio accounts
/api/PortfolioAccounts?planId=stringThis operation retrieves a list of all of the portfolio accounts in the plan. - GETRetrieve a portfolio account
/api/PortfolioAccounts/:id?planId=stringThis operation retrieves a portfolio account from the plan.
ProjectedAnnualSummary
- GETRetrieve projected annual summaries
/api/ProjectedAnnualSummary?planId=stringThis operation retrieves an object containing annual summary information for each year of the projected plan. - GETRetrieve projected annual summary by id
/api/ProjectedAnnualSummary/:id?planId=stringThis operation retrieves an object containing annual summary information for a single specified year of the projected plan.
ProjectedCashFlow
- GETRetrieve projected cash flow
/api/ProjectedCashFlow?planId=stringThis operation retrieves an object containing cash flow information for each year of the projected plan. - GETRetrieve projected cash flow by id
/api/ProjectedCashFlow/:id?planId=stringThis operation retrieves an object containing cash flow information for a single specified year of the projected plan.
ProjectedGoals
- GETRetrieve assets funding goals over time
/api/ProjectedGoals/AssetsFundingGoals?planId=stringThis operation retrieves the assets funding each goal throughout the plan years - GETRetrieve needs vs abilities data
/api/ProjectedGoals/NeedsVsAbilities?planId=stringThis operation retrieves a needs and abilities data for all goals throughout the plan years.
ProjectedNetWorth
- GETRetrieve projected net worth
/api/ProjectedNetWorth?planId=stringThis operation retrieves an object containing net worth information for each year of the projected plan. These are EOY numbers. - GETRetrieve projected net worth by id
/api/ProjectedNetWorth/:id?planId=stringThis operation retrieves an object containing net worth information for a single specified year of the projected plan. These are EOY numbers.
RestrictedStocks
- GETRetrieve restricted stocks
/api/RestrictedStocks?planId=stringThis operation retrieves a list of all of the restricted stocks in the plan. - GETRetrieve a restricted stock
/api/RestrictedStocks/:id?planId=stringThis operation retrieves a restricted stock from the plan.
ServiceInformation
- GETThis resource can be used to check the status of the service.
/api/ServiceInformation/Statistics
StockOptions
- GETRetrieve stock options
/api/StockOptions?planId=stringThis operation retrieves a list of all of the stock options in the plan. - GETRetrieve a stock option
/api/StockOptions/:id?planId=stringThis operation retrieves a stock option from the plan.
Auth
- POSTStart a session with the DomainProviders user store
/api/auth/Login - GETGets the login rules
/api/auth/LoginConfiguration - POSTAuth_Logout
/api/auth/Logout - POSTValidate and extend the duration of a session
/api/auth/ResumeSession
API details
- Base URL
https://demo.uat.naviplancentral.com/plan- Authentication
- None declared in the description
- Operations
- 64 operations on 64 pathsGET 54POST 10
- Main resources
- GoalAdjustments 9LivePlan 9Auth 4Password 4Advisors 3BusinessEntities 2DefinedBenefitPensions 2Goals 2HoldingCompanies 2Liabilities 2
- Description format
- Swagger 2.0, API version
v1 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the NaviPlan API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the NaviPlan API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Retrieve Advisors” (GET /api/Advisors), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the NaviPlan API?
An API for accessing NaviPlan plan data for a client. It is listed under Finance & banking and has 64 endpoints.
Who publishes the NaviPlan API?
It is listed from Naviplancentral's public API description (an OpenAPI document), not published by Naviplancentral on Swastik Codes. Anyone who controls naviplancentral.com can claim the profile by adding a DNS TXT record.
What is the base URL of the NaviPlan API?
Requests go to https://demo.uat.naviplancentral.com/plan. Endpoint paths are added to this base URL.
How do I authenticate with the NaviPlan API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the NaviPlan API have?
64 operations on 64 paths (54 GET, 10 POST). The largest groups are GoalAdjustments, LivePlan, Auth, Password.
Is forking the NaviPlan API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.