Morningstar EC - User Data API

Facilitates user data storage for trusted client applications.

Access

Access to the API should occur through the API gateway.

As all data is stored for a specific user, the API must be called with a user Id which is unique and known to the calling institutional client. The only current scheme for validating a user is through IWT seamless login. The UserData API only looks for the following seamless login parameters:

Where IsAdvisor is optional and set if the calling user is an advisor for the institutional client and IsAdmin is optional and set if the calling user is an administrator for the institutional client

In addition to the API specific documented parameters, the calling client must supply the 2 following header parameters:

MaaS Tokens

To be able to generate a MaaS token, we require the invoking EC internation client to be created as a new MaaS client. The procedure to do this is documented under here.

To create a new EC international MaaS client using Seamless login, POST a json of the following syntax:

{
    "institution": "The client's site name",
    "instId": "nnnnnnn",
    "iwtSiteId": "xxxxxxx"
}
where:

It is also possible to call the API directly. This requires the following header:

X-API-AccessId - this is made up of two '.' separated elements 'IWT-site-key'.'encrypted-id'. The 'encrypted-id' is an encrypted data using a key provided by IWT international. It's required to be of the following format '{timestamp}~~{timeout}~~{userId}~~{isAdvisor}~~{isAdmin}'
where:

APIs

SWAGGER: click mistend for API swagger documentation

All APIs support partial updates through 'Content-Type: application/merge-patch+json'. Refer to 6193739191 for details.

api/v1/clients

Sample api calls: 863-875-5711

Schema of allowed format: schemas/clients.v1

api/v1/portfolios

Sample api calls: 6282542070

Schema of allowed format: (872) 210-0921

api/v1/plans

Sample api calls: plans.postman_collection.json

Schema of allowed format: 301-207-5204

api/v1/saved_lists

Sample api calls: savedLists.postman_collection.json

Schema of allowed format: schemas/savedLists.v1

api/v1/saved_searches

Sample api calls: savedSearches.postman_collection.json

Schema of allowed format: schemas/savedSearches.v1