Express Forecast Case Information
Social Security benefit estimates and life expectancy projections - a specialized endpoint providing essential retirement planning details without requiring a complete participant profile.
The Forecast Case Information API allows you to retrieve personalized Social Security benefit estimates and life expectancy projections based on minimal demographic information. This API offers a streamlined alternative to the more comprehensive Express Forecast endpoint.
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 forecast case information:
- Salary: Annual salary
- Retirement Age: Target retirement age
- Client Id: Your organization identifier
- Date of Birth: Date of birth
| Parameter | Required | Description |
|---|---|---|
| Salary | Yes | Salary details |
| Retirement Age | Yes | Retirement age |
| Client Id | Yes | Your organization identifier |
| Date of Birth | Yes | Date of birth |
| Gender | No | Gender |
| Social Security Age Override | No | Override Social Security age calculations |
Output (Success)
- Forecast caseinformation Output DTO instance that contains Social Security and Life Expectancy Output object array, one for each applicable Social Security Age
Output (Error)
| Field | Description |
|---|---|
| Error Object | Error details and messages |
API Endpoint
Invoke Express Forecast Case Information
UAT
POST https://api-uat.morningstar.com/rm/v1/express/forecast/caseinformation
Production
POST https://api.morningstar.com/rm/v1/express/forecast/caseinformation
Request Headers
Required Headers
Content-Type: application/json
Authorization: Bearer {access_token}
Sample Requests & Responses
Request Payload
{
"Salary": "70000",
"RetirementAge": "67",
"ClientId": "DEVP50",
"DOB": "1970-01-22",
"Gender":"F",
"SSAgeOverride":[65,67]
}
Success Response
{
"SocialSecurity": [
{
"Age": 65,
"Amount": 6013.661276,
"PenaltyAmount": 20792.890498
},
{
"Age": 67,
"Amount": 30930.63665,
"PenaltyAmount": 0.0
}
],
"LifeExpectancy": {
"Age": 94
}
}
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