Atrium API
Overview
An institution represents a financial institution like Chase, Wells Fargo, or Mountain America Credit Union.
It's important to point out that many real-world financial institutions will actually have several different institution objects within Atrium. This is because, for example, the banking and mortgage divisions of Wells Fargo may use separate online systems for accessing customer data, both of which may be different from the credit card division's system, etc.
info
The development environment only allows you to access the top 15 financial institutions.
Institution Fields
| Field Name | Data Type | Description |
|---|---|---|
code | String | A unique identifier for each institution, defined by MX. |
medium_logo_url | String | The URL for a 100x100px logo for each institution. A generic logo is returned for institutions that don't have one. |
name | String | An easy-to-read name for an institution, e.g., "Chase Bank" or "Wells Fargo Bank." |
small_logo_url | String | The URL for a 50x50px logo for each institution. A generic logo is returned for institutions that don't have one. |
supports_account_identification | Boolean | This indicates whether the institution supports account identification. |
supports_account_statement | Boolean | This indicates whether the institution provides access to account statements. |
supports_account_verification | Boolean | This indicates whether the institution supports account verification. |
supports_oauth | Boolean | This reflects two conditions. This will be true when both:
|
supports_transaction_history | Boolean | This indicates whether the institution allows access to up to 24 months of transaction data. |
url | String | The URL for an institution's website. |