Skip to main content

Atrium API

Connection Status

Connection Status
aggregated_at
The date and time the account was last aggregated.
connection_status
An array containing MFA challenges that have been issued. `challenges` will only be present when the `connection_status` is `CHALLENGED`.
connection_status
The status of a member's aggregation.
guid
A unique identifier for the `member`. Defined by MX.
has_processed_accounts
`true` when accounts have been processed for a `member`, `false` otherwise. Resets each time `/aggregate` is called.
has_processed_transactions
`true` when transactions have been processed for a `member`, `false` otherwise. Resets each time `/aggregate` is called.
is_authenticated
If the member's credentials were authenticated during the most recent aggregation, this field will be `true`. Otherwise, this field will be `false`. Resets to `false` each time `/aggregate` is called. This field _does not_ indicate that an aggregation is completed — only that the credentials used were good; MFA or other connection problems may occur while this value is `true`.
is_being_aggregated
`true` if the `member` is being aggregated at the time of the request and `false` otherwise.
status
The status of a member's aggregation. This field will soon be deprecated. Use `connection_status` above as more detailed indicator of a member's status.
successfully_aggregated_at
The date and time the member was successfully aggregated.