Skip to main content
For field names, types, and descriptions, see the response schema on each endpoint page, such as Read Member, Read Member Status, and List Members.
This institution may represent your institution or another one from which MX is aggregating data.

​
Member Accounts

A member can have multiple accounts. For instance, an end user might have both a savings account and a checking account at Wells Fargo. In this case, two separate account objects will exist on the MX platform, both associated with a single member representing the Wells Fargo connection. Every account belongs to exactly one member.

​
Member Creation

Members can be created by you when using our API or by end users when using the Connect Widget.
Duplicate members aren’t allowed on the MX platform. A duplicate member is when a user attempts to connect to an institution they’re already connected to using the same credentials.

​
Member use cases

You must work with MX to enable this feature.
Set the use_cases field so each member is associated with a use case, PFM or MONEY_MOVEMENT. This lets you:
  • Return only the data associated with a member’s use case.
  • Filter a user’s data by a single use case, even if MX has data for other use cases.
Members with the PFM use case aggregate data as usual. MX’s Personal Finance Management and Financial Insights products show data only for members with the PFM use case. Members with the MONEY_MOVEMENT use case don’t aggregate transaction data. For how use cases affect the Connect Widget, see Member use cases in the Connect Widget. In the Connections Widget, set connections_use_case_filter to true so the widget shows only members with the use cases you set in the same request. For examples, see Filter Connections.

​
Required actions

MX enables this feature for you. For existing integrations, MX also backfills the use_cases field on your existing members. Set use_cases to PFM, MONEY_MOVEMENT, or both on each of these requests:
  • Request Widget URL requests with a widget_type of connect_widget or connections_widget
  • All Create Member requests
  • All Update Member requests. Use Update Member to add, change, or remove a use case, but every member must keep at least one.
To aggregate a member’s transactions, the member must have the PFM use case. Otherwise, the request returns 403 Forbidden.

​
Filter by use case

The List Members, List Accounts, and List Transactions endpoints accept a use_case query parameter set to PFM or MONEY_MOVEMENT. For example:
See each endpoint’s page for details.

​
Member Aggregation

Aggregation is the process of gathering data for a member from its associated institution. To gather data from an institution, the user must authenticate with the institution using one of the following authentication methods:
  • OAuth: The end user connects to an institution using OAuth. They must be present until the OAuth connection completes.
  • Credentials: The end user connects to an institution using their credentials for that institution.
Some institutions exclusively support OAuth, while others may not support it at all. Each institution has a supports_oauth field. The member_status.status of a member reflects the state of aggregation with a specific institution. For a detailed explanation of possible statuses, their meanings, and recommended actions, see Member Connection Statuses.

​
Member Connection Statuses

The connection_status indicates the state of a member’s aggregation, meaning the state of a user connecting to a particular institution. The connection_status field indicates the current state of an aggregation, meaning the state of a user connecting to a particular institution. For instance:
  • CREATED means the member has just been created.
  • CHALLENGED means the process has run into multifactor authentication.
  • FAILED means the process was unsuccessful.
The connection statuses CREATED, UPDATED, DELAYED, and RESUMED represent transient states for different points in the process and don’t require a specific action or end-user input. They may, however, require you to keep making read requests on the member until an actionable status or an end state appears. The connection statuses PREVENTED, DENIED, IMPEDED, IMPAIRED, REJECTED, EXPIRED, LOCKED, IMPORTED, DISABLED, DISCONTINUED, and CLOSED represent end states that require you to start a new connection, and possibly end-user input, for future success. Here are all the member statuses you might encounter, what they mean, and what to do about them.