Persons

Get profile data for a user

Changed on

Fetch the profile data of a Person specified by the id parameter.

get/persons/{id}

Request

  • Base URL
    //basrvqaap6001.morningstar.com/WPDemo/webportfolio/api/v1 (relative, and the document’s source URL is not known)
  • Auth
    API key in header Authorization

Path parameters

idinteger required

The unique identifier of the person

Response

Ok

idinteger required

ID of the Person

firstNamestring required

First name of the Person

middleNamestring

Middle name of the Person

lastNamestring required

Last name of the Person

emailAddressstring

Email address of the Person

phoneNumberstring

Phone number of the Person

taxIdstring

Phone number of the Person

isSSOUserboolean

True if Person is an SSO-enabled user

advisorIdinteger

Id of the Person's Advisor

firmTag1string

Firm Tag 1

firmTag2string

Firm Tag 2

firmTag3string

Firm Tag 3

userAgreementAcceptedboolean required

Indicates whether the user agreement has been accepted

uimGuidstring

UIM Guid for the Person if one was assigned at creation

Example response

{
  "id": 778899,
  "firstName": "Rosalind",
  "middleName": "Elsie",
  "lastName": "Franklin",
  "emailAddress": "RosalindFranklin@email.com",
  "phoneNumber": "5085551212",
  "taxId": "101896403",
  "isSSOUser": true,
  "firmTag1": "xxx",
  "firmTag2": "yyy",
  "firmTag3": "ZZZ",
  "userAgreementAccepted": true,
  "uimGuid": "C5E883D3-8B92-438C-A43B-E70455FA1F06"
}

Changes