Members Overview - MX Documentation

A member represents the relationship between a user and an institution; creating a member is how you connect one to the other. Multiple members may be attached to a single user, e.g., one member for their bank, another for their mortgage provider, another for their credit card provider, etc.

Member Fields

Field Name	Data Type	Description
`aggregated_at`	String	The date and time the most recent aggregation-type job was started, given in ISO 8601 format with a time component. A job will automatically be started when a member is created or its credentials are updated, unless the `skip_aggregation` parameter is used. Jobs can also be started via manual aggregations, background aggregations, API endpoints, or when opening an MX widget. A job can be a normal aggregation, or a premium job such as identification, verification, fetching statements, or fetching an extended transaction history. If a member is deleted and then re-created with the `skip_aggregation` parameter set to true or if it is re-created within the throttle window (typically three hours), the previous value will be returned.
`background_aggregation_is_disabled`	Boolean	This field indicates whether background aggregation is disabled for the member.
`connection_status`	String	This field indicates the state of a member’s aggregation, provided as a string.
`connection_status_id`	Integer	This field indicates the state of a member’s aggregation, provided as an integer.
`connection_status_message`	String	A message that can be displayed to the user to help them navigate the connection and aggregation process.
`external_guid`	String	Partner created identifier for the member. It must be unique for all members belonging to all users within the client.
`guid`	String	Unique identifier for the member. Defined by MX.
`institution_guid`	String	Unique identifier for the institution. Defined by MX.
`is_being_aggregated`	Boolean	This field will be true if the member is being aggregated at the time of the request. Otherwise, this field will be false.
`is_managed_by_user`	Boolean	If the member is managed by the user, this field will be true. Otherwise, the member is managed by the MX partner, and this field will be false. Members created with Nexus are considered to be managed by the user. NOTE: this field should be used in place of `is_user_created`.
`is_manual`	Boolean	If a member was manually created, this field will be true. Otherwise, this field will be `false`.
`is_oauth`	Boolean	This indicates whether the member uses OAuth to authenticate the member. Defaults to false. authentication.
`is_user_created`	Boolean	If the member is user-created, this field will be true. Otherwise, this field will be false. Members created with Nexus are considered user-created. NOTE: partners should use the field `is_managed_by_user` instead of this field as it is being deprecated.
`most_recent_job_guid`	String	Unique identifier for the most recent job. Defined by MX.
`metadata`	String	Additional information a partner can store on the member.
`name`	String	Name of the given member. If omitted in a member create request, the institution name within the MX Platform will be used.
`needs_updated_credentials`	Boolean	Internal field used by MX in some circumstances. When set to true, MX will not attempt to aggregate the member. It will be set to false automatically when the member’s credentials are updated.
`oauth_window_uri`	String	A URI that takes the end user to a UI for the registered OAuth application. This field only appears in a `member` response when creating an OAuth member or when requesting a URI with the generate OAuth window URI endpoint.
`revision`	Integer	The revision number of this member record.
`successfully_aggregated_at`	String	Date and time the account was last successfully aggregated, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00).
`use_cases`	Array	The use case associated with the member. Valid values are `PFM` and/or `MONEY_MOVEMENT`. Only set this if you’ve met with MX and have opted in to using this field. For more info, see Member Use Cases.
`user_guid`	String	Unique identifier for the user the member is attached to. Defined by MX.

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.

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

​Member Connection Statuses

Member Fields

Member Connection Statuses