GET api/v2/advisor/investors/{investorId}/profile
Returns the user profile for a given user.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| investorId |
Required: Investor is specified by the investorId returned from the advisor/investors endpoint. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
UserProfileModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| Birthday | date |
None. |
|
| TaxId | string |
None. |
|
| ApproximateNetWorth | decimal number |
None. |
|
| EmailAddress | string |
None. |
|
| PhoneNumber | string |
None. |
|
| AddressLine1 | string |
None. |
|
| AddressLine2 | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| EmploymentStatus | EmploymentStatus |
None. |
|
| EmploymentStatusDisplay | string |
None. |
|
| Employer | string |
None. |
|
| BusinessTitle | string |
None. |
|
| MarriageStatus | MarriageStatus |
None. |
|
| MarriageStatusDisplay | string |
None. |
|
| Gender | Gender |
None. |
|
| GenderDisplay | string |
None. |
|
| SpouseFirstName | string |
None. |
|
| SpouseLastName | string |
None. |
|
| SpouseBirthday | date |
None. |
|
| SpouseTaxId | string |
None. |
|
| Dependents | Collection of UserDependentModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Birthday": "2025-01-02T16:26:25.1937689-06:00",
"TaxId": "sample string 3",
"ApproximateNetWorth": 1.0,
"EmailAddress": "sample string 4",
"PhoneNumber": "sample string 5",
"AddressLine1": "sample string 6",
"AddressLine2": "sample string 7",
"City": "sample string 8",
"State": "sample string 9",
"Zip": "sample string 10",
"EmploymentStatus": 1,
"EmploymentStatusDisplay": "Full-Time",
"Employer": "sample string 11",
"BusinessTitle": "sample string 12",
"MarriageStatus": 1,
"MarriageStatusDisplay": "Single",
"Gender": 1,
"GenderDisplay": "Male",
"SpouseFirstName": "sample string 13",
"SpouseLastName": "sample string 14",
"SpouseBirthday": "2025-01-02T16:26:25.1937689-06:00",
"SpouseTaxId": "sample string 15",
"Dependents": [
{
"UserDependentId": 1,
"BirthDay": "2025-01-02T16:26:25.1937689-06:00"
},
{
"UserDependentId": 1,
"BirthDay": "2025-01-02T16:26:25.1937689-06:00"
}
]
}
application/xml, text/xml
Sample:
<UserProfileModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WealthAccessDataModels.Investors.Models">
<AddressLine1>sample string 6</AddressLine1>
<AddressLine2>sample string 7</AddressLine2>
<ApproximateNetWorth>1</ApproximateNetWorth>
<Birthday>2025-01-02T16:26:25.1937689-06:00</Birthday>
<BusinessTitle>sample string 12</BusinessTitle>
<City>sample string 8</City>
<Dependents>
<UserDependentModel>
<BirthDay>2025-01-02T16:26:25.1937689-06:00</BirthDay>
<UserDependentId>1</UserDependentId>
</UserDependentModel>
<UserDependentModel>
<BirthDay>2025-01-02T16:26:25.1937689-06:00</BirthDay>
<UserDependentId>1</UserDependentId>
</UserDependentModel>
</Dependents>
<EmailAddress>sample string 4</EmailAddress>
<Employer>sample string 11</Employer>
<EmploymentStatus>FullTime</EmploymentStatus>
<FirstName>sample string 1</FirstName>
<Gender>Male</Gender>
<LastName>sample string 2</LastName>
<MarriageStatus>Single</MarriageStatus>
<PhoneNumber>sample string 5</PhoneNumber>
<SpouseBirthday>2025-01-02T16:26:25.1937689-06:00</SpouseBirthday>
<SpouseFirstName>sample string 13</SpouseFirstName>
<SpouseLastName>sample string 14</SpouseLastName>
<SpouseTaxId>sample string 15</SpouseTaxId>
<State>sample string 9</State>
<TaxId>sample string 3</TaxId>
<Zip>sample string 10</Zip>
</UserProfileModel>