Important Member Fields and States

There are multiple fields on each member that indicate the state of the aggregation and how to resolve that state to be successful, as well as when resolution is not possible. You'll experience these fields in the response of your request to fetch data.

info

Aggregation is the process we use to gather financial data; it's the process in which we connect the member to their institution, and fetch the data you request so it applies to many products, not just Account Aggregation. We describe to that process in the following fields.

Field Name	Data Type	Description
aggregated_at	String	The date and time at which aggregation (or similar data fetch such as Statements or Instant Account Verification) for the member was last initiated.
connection_status	String	The state of the connection required to gather the data, provided as a string.
is_being_aggregated	Boolean	This field is true if the aggregation process is running at the time of the request. Otherwise, this field is false.
successfully_aggregated_at	String	The date and time the aggregation was last completed successfully.

connection_status

The connection_status field indicates the current state of an aggregation. 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 generally do not 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 shows up.

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.

For more information on connection statuses, review our reference.

is_being_aggregated

The is_being_aggregated indicates whether the aggregation process is currently taking place on the MX platform.

The connection_status and is_being_aggregated fields should be used in conjunction with several other member fields to determine future actions. These include aggregated_at, successfully_aggregated_at, and is_authenticated.

For example, when the connection_status is CONNECTED and the is_being_aggregated field is false, this means the latest attempt has finished and the gathered data can be read. You can use the field successfully_aggregated_at to determine when the last successful aggregation occurred.