Read institution - MX Documentation

Authorizations

MD-SESSION-TOKEN

string

header

required

MX Session Token

Request an API token using the read API token endpoint in the MX SSO API.
Exchange an API token for a session token.
- A session token is obtained by sending a POST request to /sessions
- The session token will be used in each request made for the user. It should be passed in an MD-SESSION-TOKEN HTTP header as shown below.
- This session token is valid for 30 minutes from the time it was created. The 30 minute expiration counter is refreshed with each call.
- If you send a request with an expired session token you'll receive an error code of 4011.

curl -i https://int-data.moneydesktop.com/accounts \
-H 'MD-SESSION-TOKEN: CWforZl1Vn2vC_v6H4rnQRT1DoWpDouJAV-_5TBmiQRAtA8rsOG_BoajTiOSsL0A3bd-bmHXlA-eQzc9ywItKg' \
-H 'Content-Type: application/vnd.mx.nexus.v1+json' \
-H 'Accept: application/vnd.mx.nexus.v1+json'

In documentation code examples, replace <API_KEY_VALUE> with the session token.

Path Parameters

institution_guid

string

required

The unique identifier for an institution. Defined by MX.

Response

200 - application/vnd.mx.nexus.v1+json

institution

object

Hide child attributes

institution.code

string

A unique identifier for each institution. Defined by MX.

Example:

"mxbank"

institution.created_at

string

Date and time the institution was created, represented ISO 8601 format with timestamp.

Example:

"2016-09-21T22:03:55.000Z"

institution.guid

string

A unique identifier for the institution. Defined by MX.

Example:

"INS-1572a04c-912b-59bf-5841-332c7dfafaef"

institution.forgot_password_url

string

The URL of the institution for helping users recover a forgotten password.

Example:

"https://www.mx.com/forgot-password"

institution.forgot_username_url

string

The URL of the institution for helping users recover a forgotten username.

Example:

"https://www.mx.com/forgot-username"

institution.has_checking_account

any

Deprecated. If the institution has checking accounts, this field will be true. Otherwise, this field will be false.

Example:

"https://www.mx.com/forgot-username"

institution.has_credit_card_accounts

boolean

(Deprecated) If the institution has credit card accounts, this field will be true. Otherwise, this field will be false.

Example:

true

institution.has_investment_accounts

boolean

(Deprecated) If the institution has investment accounts, this field will be true. Otherwise, this field will be false

Example:

true

institution.has_line_of_credit_accounts

boolean

(Deprecated) If the institution has line of credit accounts, this field will be true. Otherwise, this field will be false.

Example:

true

institution.has_loan_accounts

boolean

(Deprecated) If the institution has loan accounts, this field will be true. Otherwise, this field will be false.

Example:

true

institution.has_mortgage_accounts

boolean

(Deprecated) If the institution has mortgage accounts, this field will be true. Otherwise, this field will be false.

Example:

true

institution.has_savings_accounts

boolean

(Deprecated) If the institution has savings accounts, this field will be true. Otherwise, this field will be false.

Example:

true

institution.is_disabled_by_client

boolean | null

This indicates whether the institution has been disabled by the client.

Example:

false

institution.is_hidden

boolean

If the institution is available for creating new member connections, this field will be false. Otherwise, this field will be true.

Example:

true

institution.is_test

boolean

If the institution represents a test institution such as MX Bank, this field will be true. Otherwise, this field will be false.

Example:

true

institution.iso_country_code

string[]

The institution's country code.

Example:

["US", "CA"]

institution.medium_logo_url

any

The institution's logo (medium size). This may be a generic logo if MX does not have a specific logo for the institution.

Example:

"https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/INS-1572a04c-912b-59bf-5841-332c7dfafaef_100x100.png"

institution.name

string

The name of the institution that is visible to the user.

Example:

"MX Bank"

institution.popularity

integer

The number of member connections to the institution.

Example:

72644

institution.small_logo_url

any

The institution's logo (small size). This may be a generic logo if MX does not have a specific logo for the institution.

Example:

"https://content.moneydesktop.com/storage/MD_AssetsIpad%20Logos/50x50/INS-1572a04c-912b-59bf-5841-332c7dfafaef_50x50.png"

institution.supports_account_identification

boolean

Indicates whether account identification is available for this institution.

Example:

true

institution.supports_account_verification

boolean

Indicates whether account verification is available for this institution.

Example:

true

institution.supports_oauth

boolean

This indicates whether the institution supports OAuth authentication.

Example:

true

institution.supports_transaction_history

boolean

Indicates whether the institution allows access to up to 24 months of transaction data.

Example:

false

institution.trouble_signing_in_url

string

The URL of the institution for helping users troubleshoot any other sign-in issue.

Example:

"https://www.mx.com/trouble-signing-in"

institution.updated_at

string

Date and time the institution was updated, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).

Example:

"2022-04-11T17:38:27.000Z"

institution.url

string

The URL of the institution.

Example:

"https://www.mx.com"

pagination

object

Hide child attributes

pagination.current_page

integer

Example:

1

pagination.per_page

integer

Example:

25

pagination.total_entries

integer

Example:

1

pagination.total_pages

integer

Example:

1