Express Forecast Current
The Express Forecast Current API directly exposes current forecasting portion of Morningstar® Retirement Manager™ functionality enabling clients to integrate forecasting tools into their participant interfaces.
API utilizes record-kept participant data and provides:
- Income projections based on participant's current strategy. This assumes a default retirement age, per RM logic.
- Current Strategy will tell the participant how their account is doing relative to their retirement need, but will not give advice.
Overview
Functionality will be exposed in a form of an externally accessible synchronous RESTful endpoint.
Input Parameters
Required Parameters
The following parameters are mandatory for successful current forecast:
- Client Id: Your organization identifier
- Participant XML: RM Participant XML data
| Parameter | Required | Description |
|---|---|---|
| Client Id | required | Your organization identifier |
| Participant XML | required | RM Participant XML data |
| Retirement Age | optional | Target retirement age |
| Savings rates | optional | Savings rate details |
| Salary | optional | Salary details |
| Pensions | optional | Pension information |
| Exclude Social Security | optional | Whether to exclude Social Security calculations |
Output (Success)
| Field | Description |
|---|---|
| StrategyOutput | RM Strategy Output DTO instance containing strategy output objects |
| Transaction XML | Encoded transaction XML |
Output (Error)
| Field | Description |
|---|---|
| Error | Error details and information |
API Endpoint
Invoke Express Forecast Current
UAT
POST https://api-uat.morningstar.com/rm/v1/express/forecast/current
Production
POST https://api.morningstar.com/rm/v1/express/forecast/current
Request Headers
Required Headers
Content-Type: application/json
Authorization: Bearer {access_token}
Sample Requests & Responses
Request Payload
{
"ClientId": "ABCD",
"ExcludeSocialSecurity": true,
"ParticipantXML": "RM Participant XML",
"PensionTypes": [
{
"Amount": 13000,
"Cola": true,
"IsFromRecordKeeper": true,
"StartYear": "2021"
}
],
"RetirementAge": 71,
"Salary": 75000,
"SavingsRateDetails": [
{
"PlanId": "XYZ_PLAN",
"SavingsType": "0",
"Value": "0"
}
]
}
Success Response
{
"StrategyOutput": [
{
"InvestmentSelections": {
"--UNIQUEIDENTIFIER--": []
},
"AssetMixAdvisableAccounts": {
"--UNIQUEIDENTIFIER--": {
"Asset": [
{
"AssetClass": "LargeCap",
"Weight": "20"
}
],
"RiskLevel": "3"
}
},
"AssetMixHousehold": {
"Asset": [
{
"AssetClass": "LargeCap",
"Weight": "31"
}
],
"RiskLevel": "3"
},
"Percentile": [
{
"IncomeSources": [
{
"Values": [
{
"Age": "50",
"Value": 0.0
}
],
"Type": "AccountIncome",
"Account": "RMDefaultTaxableAccount",
"Investor": "Participant",
"ContributionType": "PostTax",
"CatchupType": "Type"
}
],
"TotalWealth": {
"Values": [
{
"Age": "50",
"Value": 0.0
}
]
},
"Percentage": 50.0,
"Label": "Strong Market",
"SustainableRetirementIncome": 0.0
}
],
"StrategyType": "Current",
"Rating": "3",
"RiskLevel": "3",
"RetirementAge": "65",
"SavingsRate": 0.0,
"SocialSecurity": [
{
"Age": "67",
"FullBenefitAge": 67,
"Amount": 0.0,
"GrossAmount": 0.0,
"FullBenefitAmount": 0.0,
"Account": "--UNIQUEIDENTIFIER--",
"Investor": "Participant"
}
],
"ModelPortfolioIndex": 4
}
],
"CommunicationXML": "ENCODED TRANSACTION XML",
"AccountMappings": [
{
"AccountId": "UNIQUEIDENTIFIER",
"PlanId": "planId",
"PlanType": "Plan Type"
}
]
}
Data Tables
Input Data Points
Total: 0Required: 0Optional: 0Showing: 0
Parameter | Type | Required | Description | Example |
|---|
No parameters found
No parameters found
Output Data Points
Total: 0Showing: 0
Parameter | Type | Description | Example |
|---|
No parameters found
No parameters found