# NaviPlan API API

> NaviPlan API API on Apizie: 64 endpoints (Retrieve Advisors, Retrieve Advisors for a Client, Retrieve an Advisor, Retrieve plan assumptions, …) returned as clean JSON through one API key. 64 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/finance:naviplancentral-plan/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:naviplancentral-plan`
- Category: Finance
- Status: live
- Source: https://naviplancentral.com
- Page: https://zieapi.vercel.app/api/finance/naviplancentral-plan
- OpenAPI: https://zieapi.vercel.app/api/finance/naviplancentral-plan/openapi.json

An API for accessing NaviPlan plan data for a client.

## Endpoints

### Retrieve Advisors
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/advisors-get`

### Retrieve Advisors for a Client
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/advisors-get-by-householdid-clientid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| householdId | integer | yes | Integer id of the household |
| clientId | string | yes | Guid id of the client. |

### Retrieve an Advisor
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/advisors-get-by-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Guid id of the advisor |

### Retrieve plan assumptions
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/assumptions-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve business entities
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/business-entities-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve a business entity
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/business-entities-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of business entity to retrieve |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve Monte Carlo results from standalone calc service
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/calculations-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve defined benefit pensions
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/defined-benefit-pensions-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve a definedBenefitPension
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/defined-benefit-pensions-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of defined benefit pension to retrieve |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Accepts the EULA
`POST https://zieapi.vercel.app/v1/finance:naviplancentral-plan/eula-accept`

### Retrieve family
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/family-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve the adjustments
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goal-adjustments-get-education-by-id-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the goal to retrieve adjustments for. |
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Perform calculations
`POST https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goal-adjustments-post-education-by-id-goaladjustments-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the goal to retrieve adjustments for. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |
| body | object | yes | JSON request body |

### Returns a list of goals with their relevant success rates.
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goal-adjustments-get-goal-success-rates-by-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieve the adjustments
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goal-adjustments-get-major-purchase-by-id-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the goal to retrieve adjustments for. |
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Perform calculations
`POST https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goal-adjustments-post-major-purchase-by-id-goaladjustments-p`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the goal to retrieve adjustments for. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |
| body | object | yes | JSON request body |

### Returns a list of goal adjustment restrictions.
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goal-adjustments-get-goal-adjustment-restrictions-by-clienti`

| Parameter | Type | Required | Description |
|---|---|---|---|
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieve the adjustments
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goal-adjustments-get-retirement-by-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Perform calculations
`POST https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goal-adjustments-post-retirement-by-goaladjustments-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |
| body | object | yes | JSON request body |

### Returns WAMO values for current goal
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goal-adjustments-get-what-are-my-options-by-id-clientid-plan`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the goal to retrieve WAMO values for. |
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieve goals
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goals-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve goals
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/goals-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of goal to retrieve |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve holding companies
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/holding-companies-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve a holding company
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/holding-companies-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of holding company to retrieve |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve all Households associated with the user
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/households-get-by-householdid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| householdId | integer | no | The Id of the specific household to retrieve |

### Retrieve liabilities
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/liabilities-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve a liability
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/liabilities-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of liability to retrieve |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve lifestyle assets
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/lifestyle-assets-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve lifestyle assets
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/lifestyle-assets-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of lifestyle asset to retrieve |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieves all goals from the live plan
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/live-plan-get-goals-by-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieve a list of funding accounts
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/live-plan-get-goal-funding-list-by-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieve WAMO values for a given goal
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/live-plan-get-what-are-my-options-by-id-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the goal |
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieves accounts for a given plan
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/live-plan-get-accounts-by-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieves liabilities for a given plan
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/live-plan-get-liabilities-by-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieves lifestyle assets for a given plan
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/live-plan-get-lifestyle-assets-by-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieves real estate accounts for a given plan
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/live-plan-get-real-estate-assets-by-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieves net worth projections
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/live-plan-get-projected-net-worth-by-clientid-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieves needs vs abilities projections
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/live-plan-get-projected-needs-vs-abilities-by-id-clientid-pl`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes |  |
| clientId | string | no | Id of the client user for the plan. Required if current session user is an advisor. Ignored for client user sessions. |
| planId | string | yes | Id of the Plan to retrieve or update data for (e.g. 1001-11-3). |

### Retrieve net worth
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/net-worth-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Determines if the currently logged in user has set their own password
`POST https://zieapi.vercel.app/v1/finance:naviplancentral-plan/password-has-user-set-password`

### Gets the password complexity requirements
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/password-password-requirements`

### Resets the password for the supplied user name
`POST https://zieapi.vercel.app/v1/finance:naviplancentral-plan/password-reset-by-model`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Sets the password for the currently logged in user
`POST https://zieapi.vercel.app/v1/finance:naviplancentral-plan/password-set-by-model`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve plan information
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/plan-information-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve plan data statuses
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/plan-statuses-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3) |

### Retrieve portfolio accounts
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/portfolio-accounts-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve a portfolio account
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/portfolio-accounts-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of portfolio account to retrieve |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve projected annual summaries
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/projected-annual-summary-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve projected annual summary by id
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/projected-annual-summary-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Index into the list of annual projections |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve projected cash flow
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/projected-cash-flow-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve projected cash flow by id
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/projected-cash-flow-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Index into the list of annual projections |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve assets funding goals over time
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/projected-goals-get-assets-funding-goals-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve needs vs abilities data
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/projected-goals-get-needs-vs-abilities-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve projected net worth
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/projected-net-worth-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve projected net worth by id
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/projected-net-worth-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Index into the list of annual projections |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve restricted stocks
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/restricted-stocks-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve a restricted stock
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/restricted-stocks-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of restricted stock to retrieve |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### This resource can be used to check the status of the service.
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/service-information-statistics`

### Retrieve stock options
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/stock-options-get-by-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Retrieve a stock option
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/stock-options-get-by-id-planid`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of stock option to retrieve |
| planId | string | yes | Id of the plan to retrieve data from (e.g. 1001-11-3). |

### Start a session with the DomainProviders user store
`POST https://zieapi.vercel.app/v1/finance:naviplancentral-plan/auth-login-by-model`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Gets the login rules
`GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/auth-password-requirements`

### POST /api/auth/Logout
`POST https://zieapi.vercel.app/v1/finance:naviplancentral-plan/auth-logout`

### Validate and extend the duration of a session
`POST https://zieapi.vercel.app/v1/finance:naviplancentral-plan/auth-resume-session`

## Example
```
curl "https://zieapi.vercel.app/v1/finance:naviplancentral-plan/advisors-get" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the NaviPlan API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/finance:naviplancentral-plan/advisors-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the NaviPlan API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the NaviPlan API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:naviplancentral-plan.

### What is the status of the NaviPlan API API?
Live: works with just an Apizie key