Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Envestnet User API is one of 21 APIs that Envestnet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 11 paths, and defines 89 schemas. It is described by OpenAPI 3.0.1, at version 1.1.0.

Requests are made against a single base URL, /.

14 operations 11 paths 89 schemas 2 DELETE6 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.1.0
Server
/
Terms of Service
Resource Areas
1

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 2 DELETE, 6 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User 14

Users API

POST
/user/samlLogin
Envestnet Saml Login
samlLogin 3 params → 200400401404
POST
/user/register
Envestnet Register User
registerUser body → 200400401404
GET
/user/accessTokens
Envestnet Get Access Tokens
getAccessTokens 1 param → 200401404
GET
/user
Envestnet Get User Details
getUser → 200401404
PUT
/user
Envestnet Update User Details
updateUser body → 204401404
POST
/user/logout
Envestnet User Logout
userLogout → 204401404
DELETE
/user/unregister
Envestnet Delete User
unregister → 204401404
GET
/insights/configs/userSubscriptions
Envestnet Provides user-level preferences for each insight.
getUserSubscriptions 2 params → 200400401
PATCH
/insights/configs/userSubscriptions
Envestnet Update user-level preferences for each insight.
updateUserSubscription body → 204400401
DELETE
/insights/configs/userSubscriptions
Envestnet Delete an existing entity-level insight configuration
deleteUserSubscriptions 3 params → 204400401
GET
/insights/feed
Envestnet Fetch all the insights generated for a user.
getUserFeed 9 params → 200400401
GET
/insights/feedExtracts
Envestnet Fetch all the insights generated for a user.
getUserFeedWebHook 10 params → 200400401
GET
/insights/feed/count
Envestnet Fetch the count of generated insight for a user.
getUserFeedCount 7 params → 200400401
POST
/insights/trigger
Envestnet Evalute the insights on demand.
createTrigger body → 200400401

Schemas 89

The contract defines 89 schemas that model the data the API accepts and returns. The most detailed are feed (30 properties), BasicTransaction (13 properties), BasicTrend (13 properties), BasicPredictedEvent (13 properties). Each schema is shown below with its type and property counts.

PeerSpendingComparison
object
4 properties
NetWorthTrendDetail
object
Date Range identified as first of the month. E.g. January 2021 will be represented as 2021-01-01.
4 properties 2 required
CashFlowTrend
object
Cash flow trend information, broken down by a specific frequency, for a specific date range.
8 properties
UpdateUserRequest
object
1 property 1 required
AssetDetail
object
Summary information across all the aggregated accounts categorized as 'assets'.
1 property 1 required
User
object
6 properties
UserSubscriptions
object
1 property
ChangeValue
object
Change in value identified for a type between two different time periods.
7 properties 7 required
BasicCreditCardUtilization
object
Derived information across one or more aggregated card accounts.
4 properties
BasicPeerDetail
object
Peer data information.
3 properties 2 required
entityconfig
object
2 properties
BasicStatementLink
object
Reference path link to fetch more information about the specific statement.
3 properties 2 required
BasicHolding
object
Object that contains details about one or more securities.
9 properties 2 required
UserAddress
object
7 properties
BasicMerchant
object
Information about the associated merchant.
3 properties 1 required
BasicBenchMark
object
4 properties 4 required
Name
object
4 properties
DetailCategoryTrend
object
Detail category trend information, broken down by a specific frequency, for a specific date range.
11 properties 2 required
total
object
1 property
ChangeAPR
object
Change in APR for an aggregated card account.
3 properties 3 required
UserAccessTokensResponse
object
1 property
BasicStatement
object
Object that contains details about one or more aggregated statements.
12 properties 3 required
CashFlowDetail
object
8 properties
ErrorInfo
object
Error encountered while refreshing a specific aggregated account.
4 properties 4 required
BasicPredictedEventLink
object
Reference path link to fetch more information about the specific predicted event.
3 properties 2 required
YodleeError
object
3 properties
Link
object
Reference path link to fetch more information about the specific entity.
3 properties 2 required
DateRange
object
The date range identified by fromDate and toDate.
2 properties
ViewDerived
object
Derived information for a specific VIEW.
3 properties
Geo
object
2 properties
BankAccount
object
Account object that contains details about one or more aggregated bank accounts.
7 properties
BasicMerchantDetail
object
Derived merchant spending information.
7 properties 1 required
RealEstateAccount
object
Account object that contains details about one or more aggregated real estate accounts.
2 properties
AccessTokens
object
3 properties
Money
object
4 properties
Threshold
object
3 properties
AccountInfo
object
9 properties 9 required
UserSession
object
1 property
UpdateUserRegistration
object
7 properties
feedsCount
object
1 property
NetworthDetail
object
Summary information across all the aggregated accounts calculated as (total of all assets) - (total of all liabilities).
1 property 1 required
Address
object
The address information associated with a merchant or an account.
11 properties
feeds
object
1 property
UserDetail_2
object
4 properties
NetWorthTrend
object
Net Worth trend information, broken down by a specific frequency, for a specific date range.
4 properties
Message
object
Provides information about customized text-messages associated with an insight.
1 property 1 required
BasicTrend
object
Trend information, broken down by a specific frequency, for a specific date range.
13 properties
StatementDerived
object
Statement derived
1 property
BasicHoldingLink
object
Reference path link to fetch more information about the specific holding.
3 properties 2 required
BasicAccount
object
Account object that contains details about one or more aggregated accounts.
9 properties
subscriptionModel
object
Details about the configurations applied for the specific insight.
5 properties 2 required
BasicView
object
Object that contains details about one or more user/system created VIEWs.
6 properties 3 required
UserDetail
object
9 properties
BasicCategoryTypeDetail
object
Derived information across one or more category types - INCOME, EXPENSE, TRANSFER, DEFERREDCOMPENSATION, or UNCATEGORIZE.
6 properties
userConfiguration
object
7 properties
MerchantTrend
object
Merchant trend information, broken down by a specific frequency, for a specific date range.
9 properties 1 required
trigger
object
3 properties
PredictedInfo
object
Predidcted information based on one or more eligible accounts.
7 properties
UserAccessToken
object
1 property
CustomerConfiguration
object
6 properties
BasicTransactionLink
object
Reference path link to fetch more information about the specific transaction.
3 properties 2 required
UserDetailResponse
object
1 property
UserSubscription
object
2 properties
LiabilityDetail
object
Summary information across all the aggregated accounts categorized as 'liability'.
1 property 1 required
Detail
object
12 properties 4 required
UserRequest
object
1 property 1 required
BasicPredictedEvent
object
Predicted Event object that contains details about one or more predicted events as identified by the system.
13 properties 2 required
descriptions
object
3 properties 1 required
AccountDerived
object
Derived information across one or more aggregated accounts.
5 properties
UserRegistration
object
7 properties 1 required
CategoryDerived
object
category information
2 properties
BasicTransaction
object
Transaction object that contains details about one or more aggregated transactions.
13 properties 8 required
InvestmentAccount
object
Account object that contains details about one or more aggregated investment accounts.
2 properties
UserRequestPreferences
object
4 properties
Triggers
object
1 property
UserResponse
object
1 property
LoanAccount
object
Account object that contains details about one or more aggregated loan accounts.
1 property
BasicCategoryDetail
object
Information about a specific "master" category.
7 properties 2 required
CardAccount
object
Account object that contains details about one or more aggregated card accounts.
11 properties
TransactionDerived
object
Derived information across one or more aggregated transactions.
11 properties
AccountDetail
object
2 properties 4 required
PredictedInfoDerived
object
provide the predicted balance aggregated across all account per date
3 properties
UserResponsePreferences
object
4 properties
feed
object
Feed is an array of insights generated for a specific user.
30 properties 7 required
Subscription
object
Details about the configurations applied for the specific insight.
7 properties
CategoryTrend
object
Category trend information, broken down by a specific frequency, for a specific date range.
10 properties 2 required
CategoryTypeDerived
object
provides values derived at "categoryType" level.
4 properties
ViewLink
object
Reference path link to fetch more information about the specific VIEW.
3 properties 2 required
Error
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

envestnet-user-api-openapi.yml Raw ↑

Other APIs Envestnet publishes across the network.

Envestnet Account Token API
Envestnet Accounts API
Envestnet Associated Details API
Envestnet Auth API
Envestnet Configs API
Envestnet Consents API
Envestnet CreditAcceleratorFile API
Envestnet Customer API
Envestnet DataExtracts API
Envestnet Derived API
Envestnet Documents API
Envestnet Holdings API