Atrium API
Read Member Connection Status
This endpoint provides the status of the member's most recent aggregation-type event. This is an important step in the aggregation process (as well as identification, verification, etc.), and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member.
MX has introduced new, more detailed information on the current status of a member's connection to a financial institution and the state of its aggregation: the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.
Member connection statuses should be used in conjunction with all the fields described below. For instance, when is_being_aggregated switches from true to false and the value of connection_status is CONNECTED, you can stop polling the status and list the member's transactions or list the transactions for a specific account.
The response for this endpoint is not the same as the read member endpoint; this endpoint returns fields which are specifically focused on the state of the member's aggregation, as well as including MFA challenges when the connection_status is CHALLENGED.
MX recommends a minimum polling interval of 3 seconds when using this endpoint.