Atrium API
Overview
The features in this section must be enabled by MX. Contact MX for information about pricing and enabling.
Extend Transaction History
Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multifactor authentication.
Account Owner Identification
Account Owner Identification (AOI) allows you to access data such as the name, street address, phone number, and email address for all the accounts associated with a particular member. The process for getting an account owner's identity is much like standard aggregation. For more detailed information on the process, see the AOI guide.
The identify endpoint may be used to gather this information on certain institutions, and then it can be accessed with another call to the account owners endpoint.
Statements
Some institutions allow developers to access account statements associated with a particular member. The process for fetching and then reading account statements is much like standard aggregation, and it may trigger multi-factor authentication.
Instant Account Verification
Verification now includes two separate workflows depending on the partner's needs. In the new default flow, the partner or end user must choose only one account associated with the member to verify — this is done through a specialized MFA challenge. This flow is generally faster, which is why it is now the default. The legacy workflow, on the other hand, verifies every account associated with a member.
New partners will default to the new workflow; they can, however, have MX enable the legacy flow if desired. Existing partners will be left with the legacy workflow but may have the new flow enabled if desired.
Account verification allows you to access account and routing numbers for demand deposit accounts associated with a particular member. Functionally, this means it is that only CHECKING and SAVINGS accounts are likely to be verified.
The process for account verification is much like standard aggregation.
- Start the verification.
- Check the
connection_status. - Answer MFA if necessary.
- Answer the special account-selection challenge (when using the default flow; the legacy flow skips this step).
- Check the
connection_statusagain. - List the member's account numbers.
For more detailed information on the process, see the account verification guide.