> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mx.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Read institution
>
This endpoint returns information about the institution specified by `institution_code`. The `v20250224` update enhances the granularity of the information provided about the services and products supported by the institution.
## OpenAPI
````yaml openapi/platform-api/v20250224.yaml GET /institutions/{institution_code}
openapi: 3.0.0
info:
contact:
name: MX Platform API
url: https://www.mx.com/products/platform-api
description: >
The MX Platform API is a powerful, fully-featured API designed to make
aggregating and enhancing financial data easy and reliable. It can
seamlessly connect your app or website to tens of thousands of financial
institutions.
## What's Changed?
Several endpoints, headers, and fields changed in `v20250224`. For more on
breaking changes, refer to our
[versioning](/api-reference/platform-api/overview/versioning#v20250224) and
[migration](/api-reference/platform-api/overview/migration) guides.
## Version Header
Versions are set in the `Accept-Version` header of API requests. Version
numbers correspond with the date associated with that version. The example
below uses the version `v20250224`.
```
-H 'Accept: application/json'
-H 'Accept-Version: v20250224'
```
---
title: MX Platform API
version: '20250224'
servers:
- url: https://int-api.mx.com
- url: https://api.mx.com
security:
- basicAuth: []
tags:
- name: authorization
- name: accounts
description: >
The Accounts endpoints represent a user's checking, savings, mortgage,
401(k), or other types of accounts held by a financial institution.
An account belongs to a `member`, which represents the user's overall
relationship with a particular financial institution. A checking account
may be just one part of a larger relationship that could also include a
car loan and a savings account.
Accounts—and the transactions associated with them—are updated every 24
hours, unless the associated `user` is disabled.
You can also create manual accounts. Since a manual account has no
credentials tied to the member, the account will never aggregate or
include data from a data feed. All manual accounts are automatically
created under the Manual Institution member.
- name: ach return
description: >
The features documented here are in a beta state, and this documentation
is considered draft material subject to frequent change.
Using our Platform API, you can securely submit ACH Returns to reduce your
ACH return rates and automate your ACH return process.
You can query the status and outcomes of your submitted ACH returns to
track progress and access resolution details.
- name: budgets
description: >
Use these endpoints to create and manage budgets for your end users.
You can create a budget for a specific category or autogenerate a budget
for several categories based on existing transactions.
Each budget has a `category_guid`, relating to one of the
[categories](docs.mx.com/api-reference/platform-api/reference/categories#default-categories-and-subcategories).
- name: categories
description: >
A `transaction` can have its `category` set to one of MX’s default
categories or a custom category for a specific `user`.
See [Default Categories and
Subcategories](docs.mx.com/api-reference/platform-api/reference/categories#default-categories-and-subcategories)
for a complete list.
- name: deprecated
- name: goals
description: >
Use these endpoints to create and manage goals for a `user`. You can also
reposition goals to adjust their priority levels.
Every goal has a track type and a meta type.
The [track
type](docs.mx.com/api-reference/platform-api/reference/goals/#goal-track-type)
is the overall classification of the goal (debt, savings, retirement, or
emergency fund) while the [meta
type](docs.mx.com/api-reference/platform-api/reference/goals/#goal-meta-type)
is the specific classification (like college, house, vacation, and so on).
- name: insights
description: >
Use these endpoints to build customizable user experiences in UIs powered
by our Financial Insights data.
With Financial Insights, your users will receive personalized insights
based on their transaction history.
Want to learn more about the product? See [Financial
Insights](docs.mx.com/products/experience/insights).
Looking for a guide to use these endpoints? See [Build Your Own Insights
UI](docs.mx.com/products/experience/insights/integration-guides/insights-api-guide).
- name: institutions
description: >
Institutions represent a financial institution.
A single real-world financial institution may have several `institution`
objects on the MX platform.
For example, the mortgage division of a financial institution might use a
separate system than its everyday banking division, which is different
from its credit card division.
For more info, see [Institutions
Overview](docs.mx.com/api-reference/reference/institutions).
- name: investment holdings
description: >
Investment Data Enhancement lets you connect to an end user's financial
institution and retrieve cleansed and enhanced investment data. By
combining investment data with retail banking information, you get
comprehensive insights into customer financial behaviors, risk tolerance,
and investment strategies.
You can [read a user's
holding](docs.mx.com/api-reference/platform-api/reference/read-holding),
[list all their
holdings](docs.mx.com/api-reference/platform-api/reference/list-holdings),
or list their holdings by
[account](docs.mx.com/api-reference/platform-api/reference/list-holdings-by-account)
or
[member](docs.mx.com/api-reference/platform-api/reference/list-holdings-by-member).
You can also [deactivate a
user](docs.mx.com/api-reference/platform-api/reference/deactivate-user)
from the Investment Data Enhancement. This is non-billable.
- name: managed data
- name: members
description: >
Members represent the connection between an end user and a financial
institution. This institution may represent your institution or another
one from which MX is aggregating data.
For more info, see [Members
Overview](docs.mx.com/api-reference/reference/members).
- name: merchants
description: >
Merchants are representations of a transaction’s origin. For example, if
you buy a coffee at Starbucks, the transaction merchant will be
`Starbucks`.
Use the `merchant_guid` and a `merchant_location_guidon` any `transaction`
object to access Merchant endpoints for details like the merchant’s name,
logo URL, website, street address, and more.
- name: microdeposits
description: >
Microdeposits is an additional verification method that allows you to
verify account details and navigate the process of using microdeposits and
the automated clearing house (ACH) system.
Make two, small ACH deposits into a consumer's account using the provided
account and routing number. You can then require that the end user confirm
the exact amount of each deposit to verify that they own the account and
meet NACHA’s account verification.
For more info, including process flows, setting block lists, and more, see
[Microdeposits](docs.mx.com/products/connectivity/microdeposits).
- name: monthly cash flow profile
- name: notifications
description: >
You can only use notifications endpoints if you’re using the MX mobile
application.
All notifications created through the API will be of notification type
`API_NOTIFICATION`, channel `PUSH`, and will not be associated to an
entity. No other channels are supported.
The read and list endpoints can return any notification associated with
the `user`, including notifications created by MX for other channels
besides `PUSH`.
- name: processor token
- name: rewards
- name: spending plan
description: >
Use the Spending Plan endpoints to create your own version of our
[Spending Plan
Widget](docs.mx.com/products/experience/pfm/legacy-widget-overviews/spending-plan),
which helps end users track their spending throughout the month.
To understand key terms and how to best use these endpoints, see [Build
Your Own Spending Plan
UI](docs.mx.com/products/experience/pfm/integration-guides/build-your-own-spending-plan-ui).
- name: statements
description: >
With Statements, you can retrieve a user's monthly account statements in
PDF format. This data can be used for solutions like personal financial
management or risk analysis.
- name: taggings
description: >
Tags and taggings are two resources in the MX Platform API that, when used
together, give end users more control over organizing their transactions.
A tag is a custom label that can be applied to a transaction.
After you create a tag, use it for tagging. This means you should actually
apply the tag to a particular transaction.
Together, they're a powerful tool for personalization, customization, and
money management.
For a guide on creating a tag and then applying it to a specific
transaction with a tagging, see [Custom Tags and
Taggings](docs.mx.com/products/experience/pfm/integration-guides/personalization/).
- name: tags
description: >
Tags and taggings are two resources in the MX Platform API that, when used
together, give end users more control over organizing their transactions.
A tag is a custom label that can be applied to a transaction.
After you create a tag, use it for tagging. This means you should actually
apply the tag to a particular transaction.
Together, they're a powerful tool for personalization, customization, and
money management.
For a guide on creating a tag and then applying it to a specific
transaction with a tagging, see [Custom Tags and
Taggings](docs.mx.com/products/experience/pfm/integration-guides/personalization/).
- name: transaction rules
description: >
Transaction Rules allow users to automatically recategorize or rename all
similar transactions according to their preferences. This only applies to
future transactions.
When recategorizing or renaming a transaction, the user will be asked
whether they want the new data to apply to the selected transaction or to
all future transactions. If they choose to apply it to all future
transactions, it will create a transaction rule which will automatically
apply the changes going forward.
- name: transactions
description: >
Transactions represent any instance in which money moves into or out of an
account. This could be a purchase at a business, a payroll deposit, a
transfer from one account to another, an ATM withdrawal, and so on.
Transactions are created automatically when a member is successfully
aggregated.
Each `transaction` belongs to only one `account`.
For more info, see [Transactions
Overview](docs.mx.com/api-reference/reference/transactions).
- name: users
description: >
Users represent an end user using the Platform API through your web or
mobile app.
Users are created by MX clients and belong to a specific
[client](docs.mx.com/products/connectivity/overview/data-architecture/#clients)
on the platform.
- name: verifiable credentials
description: >
MX provides Verifiable Credential endpoints that comply with web5
standards.
For more info, see [Verifiable Credentials
Overview](docs.mx.com/api-reference/reference/verifiable-credentials).
- name: widgets
description: >
Use the [Request Widget
URL](docs.mx.com/api-reference/platform-api/reference/request-widget-url)
endpoint to generate a URL that loads one of our widgets.
Many request body parameters only work for some widgets.
For more info, including widget types, see [Widgets
Overview](docs.mx.com/api-reference/reference/widgets).
paths:
/institutions/{institution_code}:
get:
tags:
- institutions
summary: Read institution
description: >-
This endpoint returns information about the institution specified by
`institution_code`. The `v20250224` update enhances the granularity of
the information provided about the services and products supported by
the institution.
operationId: readInstitution
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/institutionCode'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionResponseBody'
description: OK
components:
parameters:
acceptVersion:
name: Accept-Version
in: header
required: true
schema:
type: string
default: v20250224
example: v20250224
description: MX Platform API version.
institutionCode:
description: A unique identifier for each institution, defined by MX.
example: mxbank
in: path
name: institution_code
required: true
schema:
type: string
schemas:
InstitutionResponseBody:
properties:
institution:
$ref: '#/components/schemas/InstitutionResponse'
type: object
InstitutionResponse:
properties:
client_status:
description: >
The client-level status of the institution, indicating restrictions
on member connections.
example: AVAILABLE
type: string
enum:
- AVAILABLE
- PREVENT_ALL
- PREVENT_NEW
- PREVENT_ALL_AND_DISCONNECT
- PREVENT_VERIFICATION
- PREVENT_BACKGROUND_AGG
code:
description: The code identifying a financial institution.
example: mxbank
nullable: true
type: string
created_at:
description: >-
The date and time the institution was created, represented in ISO
8601 format with a timestamp.
example: '2025-02-13T18:08:00+00:00'
type: string
forgot_password_url:
description: URL for the forgot password page of the institution.
example: https://example.url.mxbank.com/forgot-password
nullable: true
type: string
forgot_username_url:
description: URL for the forgot username page of the institution.
example: https://example.url.mxbank.com/forgot-username
nullable: true
type: string
guid:
description: The unique identifier for the institution. Defined by MX.
example: INS-1572a04c-912b-59bf-5841-332c7dfafaef
type: string
instructional_text:
description: >-
Render this text when end users are asked for their credentials, as
it helps end users provide the correct credentials when creating a
new member. May contain `` tags to link to explanatory
material.
example: >-
Some instructional text for end users.
nullable: true
type: string
instructional_text_steps:
type: array
items:
type: string
description: An array of instructional steps that may contain html elements.
example:
- 'Step 1: Do this.'
- 'Step 2: Do that.'
nullable: true
is_disabled_by_client:
description: Indicates whether the institution is disabled by the client.
example: false
nullable: true
type: boolean
is_hidden:
example: true
type: boolean
description: >-
If the institution is available for creating new member connections,
this field will be `false`. Otherwise, this field will be `true`.
iso_country_code:
description: The ISO country code associated with the institution.
example: US
type: string
enum:
- US
- CA
medium_logo_url:
description: >-
The URL for a 100px X 100px logo for each `institution`. A generic
logo is returned for institutions that don't have one.
example: >-
https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
nullable: true
type: string
name:
description: The name of the institution.
example: MX Bank
nullable: true
type: string
small_logo_url:
description: >-
The URL for a 50px X 50px logo for each `institution`. A generic
logo is returned for institutions that don't have one.
example: >-
https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
nullable: true
type: string
status:
description: |
The operational status of the institution.
example: OPERATIONAL
type: string
enum:
- OPERATIONAL
- MAINTENANCE
- DEGRADED
- UNAVAILABLE
supported_products:
items:
$ref: '#/components/schemas/SupportedProducts'
supports_oauth:
description: >
If true, this indicates that the institution supports OAuth and that
you have been properly registered for OAuth with that institution.
example: true
nullable: true
type: boolean
supports_tax_document:
description: This indicates whether the institution supports tax documents.
example: true
nullable: true
type: boolean
trouble_signing_in_url:
description: >-
The URL of the institution for helping users troubleshoot any other
sign-in issue.
example: https://example.url.mxbank.com/login-trouble
nullable: true
type: string
url:
description: The URL for an institution's website.
example: https://www.mxbank.com
nullable: true
type: string
type: object
SupportedProducts:
type: string
enum:
- account_verification
- identity_verification
- transactions
- transaction_history
- statements
- investments
- rewards
securitySchemes:
basicAuth:
scheme: basic
type: http
description: >
The MX Platform API requires basic access authentication using your
`client_id` and `api_key`. These credentials must be Base64 encoded and
included in the Authorization header of each API request to ensure
secure access.
Here's an example using curl to access `v20250224`. Replace
`https://int-api.mx.com/endpoint` with the actual API endpoint you wish
to access and your Base64 encoded `client_id` and `api_key`.
```
curl -L -X POST `https://int-api.mx.com/endpoint' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Version: v20250224'
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'
```
````