Members Overview
Members represent the connection between an end user and a financial institution. 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 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 connection_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:
CREATEDmeans the member has just been created.CHALLENGEDmeans the process has run into multifactor authentication.FAILEDmeans 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.
| Integer Value | Status | Definition | Next Steps | End-User Message |
|---|---|---|---|---|
| null | null | The member exists but does not have credentials. A member that does not aggregate (e.g., a manual member) will always have this status. | None. | None. |
| 0 | CREATED | The member is new and has not yet been aggregated. | Aggregate the member once the end user logs in; poll for a status update. | Connecting to [...] ... |
| 1 | PREVENTED | The end user's entered credentials have failed to connect three times in a row. MX has locked the account to avoid locking the end user out of their account on the financial institution's website. The end user must reenter their username and password to continue updating their data. | Display end-user message; after end user has updated their credentials, aggregate again. | The last 3 attempts to connect have failed. Please re-enter your credentials to continue importing data. |
| 2 | DENIED | The credentials provided for the member were invalid. | Display end-user message; after end user has updated their credentials, aggregate again. | The credentials entered do not match your credentials at this institution. Please re-enter your credentials to continue importing data. |
| 3 | CHALLENGED | The connection is waiting for the end user to complete a multifactor authentication (MFA) challenge. This is not an error and will change to an EXPIRED status if the end user fails to complete MFA. | Display end-user message; follow MFA pathway; after the user answers MFA, poll for a status update. | To authenticate your connection to [...], please answer the following challenge(s). |
| 4 | REJECTED | An MFA challenge was answered incorrectly. | Display end-user message; another challenge may follow or aggregation may need to be restarted. | The answer or answers provided were incorrect. Please try again. |
| 5 | LOCKED | The financial institution is preventing authentication. The end user must go to the FI's website or contact the financial institution. | Display end-user message. | Your account is locked. Please log in to the appropriate website for [...] and follow the steps to resolve the issue. |
| 6 | CONNECTED | The member was successfully authenticated and data is now aggregating. | Display the account as having been connected. | Connected to [...] ... |
| 7 | IMPEDED | The end user’s attention is required at their online banking institution, e.g., there is a marketing message that must be viewed, terms and conditions that must be accepted, etc. | Display end-user message. | Your attention is needed at this institution's website. Please log in to the appropriate website for [...] and follow the steps to resolve the issue. |
| 8 | RECONNECTED | The member has been migrated to a new data source and aggregation is likely to trigger one-time password MFA. MX will not perform background aggregation in order to avoid unnecessarily disruptive texts, emails, etc. The member must be re-aggregated in the foreground with the end user present. | Aggregate the member once the end user logs in; poll for a status update. | Reconnecting to [...] ... |
| 9 | DEGRADED | Aggregation has failed at least three times within a short period of time. This could be due to website maintenance or other factors that are preventing account aggregation. | Display end-user message. | We are upgrading this connection. Please try again later. |
| 10 | DISCONNECTED | Aggregation has failed at least three times and has not succeeded for at least two weeks. | Display end-user message. | It looks like your data from [...] cannot be imported. We are working to resolve the issue. |
| 11 | DISCONTINUED | The connection to this financial institution is no longer available. | Display end-user message. | Connections to this institution are no longer supported. You may create a manual account and use manual transactions to track data for this account. |
| 12 | CLOSED | The end user, MX, the client, or a partner has marked the member as closed. | Display end-user message. | This connection has been closed. You may track this account manually. If reopened, you may connect the institution again. |
| 13 | DELAYED | Aggregating the member has taken longer than expected and it has not yet been connected. This can be due to reasons outside of MX's control, such as internet bandwidth, problems at the financial institution's website, and other factors. | Display end-user message; poll for a status update. | Importing your data from [...] may take a while. Please check back later. |
| 14 | FAILED | Aggregation failed without being connected. Most aggregation issues are temporary and self-resolve after 24 hours. | Display end-user message; try aggregating again later. | There was a problem validating your credentials with [...]. Please try again later. |
| 15 | UPDATED | The member has been updated — i.e., credentials have been updated — but it has not yet been connected. | Aggregate the member once the end user logs in; poll for a status update. | Connecting to [...] ... |
| 16 | DISABLED | Aggregation has been momentarily paused, but the member is still connected. | Display end-user message. | Importing data from this institution has been disabled. Please contact us if you believe it has been disabled in error. |
| 17 | IMPORTED | MX does not have credentials and will not try to aggregate the member until the end user provides credentials. | Display end-user message; re-aggregate after the end user updates credentials. | You must re-authenticate before your data can be imported. Please enter your credentials for [...]. |
| 18 | RESUMED | The answer to an MFA challenge was received, but it is not yet clear whether it was correct. | Poll for a status update. | Connecting to [...] ... |
| 19 | EXPIRED | The MFA answer was not provided within the time allotted by the financial institution. | Display end-user message; re-aggregate the member if the end user initiates it. | The answer or answers were not provided in time. Please try again. |
| 20 | IMPAIRED | The member is missing some or all credentials needed in order to connect. | Display end-user message; re-aggregate after the end user updates credentials. | You must re-authenticate before your data can be imported. Please enter your credentials for [...]. |
| 21 | PENDING | The member is using OAuth to authenticate credentials and still needs to go through the financial institution's OAuth process. A PENDING status will appear only on members less than one hour old with is_oauth: true. Members that stay PENDING longer than one hour will be deleted by MX. | Redirect the end user to the oauth_window_uri provided in the create member response, or request one through the generate OAuth window URI endpoint. | None. |
Member Fields
| Field | Data Type | Definition |
|---|---|---|
guid | String | The unique identifier for the member. Defined by MX. |
id | String | The unique partner-defined identifier for the member. |
metadata | String | Additional metadata stored on the member. |
name | String | The name of the member. |
self | String | The API URI path for the member. |
institution.guid | String | The unique identifier for the related institution. Defined by MX. |
institution.id | String | The unique partner-defined identifier for the related institution. |
institution.name | String | The name of the related institution. |
institution.self | String | The API URI path for the related institution. |
member_status.status | String | The status of the user's connection to the institution. |
member_status.error.error_type | String | The type of member connection error, when present. |
member_status.error.error_code | String | The specific member connection error code, when present. |
member_status.error.error_message | String | A human-readable message describing the error, when present. |
member_status.error.user_message | String | A human-readable message intended for the end user, when present. |
member_status.self | String | The API URI path for the member status resource. |
oauth.is_oauth | Boolean | Indicates whether the member uses OAuth to authenticate. |
oauth.authorization_url | String | The OAuth authorization URL for the member when available. |
oauth.self | String | The API URI path to generate a new OAuth authorization URL. |
user.guid | String | The unique identifier for the related user. Defined by MX. |
user.id | String | The unique partner-defined identifier for the related user. |
user.metadata | String | Additional metadata stored on the related user. |
user.self | String | The API URI path for the related user. |