/participants/{participant_id}/retirement-planning-estimate/

get

https://sandbox.401go.com/api/participants/{participant_id}/retirement-planning-estimate/

Estimate a participant's projected balance and target savings for retirement. Will use the defaults as defined
from the retirement-planning-defaults unless an override is given. Can only be used if the participant has not
yet reached retirement, or the supplied age is less than retirement_age.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

participant_id

string

required

Query Params

age

integer

18 to 115

Defaults to participant's age

annual_raise

string

^-?\d{0,3}(?:\.\d{0,2})?$

Defaults to 2.00

Expected annual raise

correct_for_inflation

boolean

Defaults to true

Display amounts as they are worth today

current_savings

integer

≥ 0

Defaults to participant's current account balance

include_contributions

boolean

Defaults to true

Include employer contributions to the account

include_social_security

boolean

Defaults to true

inflation

string

^-?\d{0,3}(?:\.\d{0,2})?$

Defaults to 2.00

Expected annual inflation

investment_return

string

^-?\d{0,3}(?:\.\d{0,2})?$

Defaults to 5.00

Expected annual investment return

life_expectancy

integer

Defaults to 90

retirement_age

integer

18 to 115

Defaults to participant's retirement age

retirement_spending

string

^-?\d{0,3}(?:\.\d{0,2})?$

Defaults to 70.00

Percentage of income needed during retirement

salary

integer

≥ 0

Defaults to participant's previous year compensation or estimation based on this year

savings_percent

string

^-?\d{0,3}(?:\.\d{0,2})?$

Percentage of income saved

Responses

400

Bad Request: invalid supplied data

401

Unauthorized: Missing or invalid authentication

403

Forbidden: Insufficient permissions or scopes

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200