Skip to main content
POST
/
institutions
/
search
Search institutions
curl --request POST \
  --url https://int-data.moneydesktop.com/institutions/search \
  --header 'Content-Type: application/vnd.mx.nexus.v1+json' \
  --header 'MD-SESSION-TOKEN: <api-key>' \
  --data '
{
  "institution": {
    "account_types": "deprecated",
    "name": "MX Bank",
    "supports_account_identification": false,
    "supports_account_verification": false,
    "supports_transaction_history": true,
    "url": "https://mx.com"
  }
}
'
{
  "institutions": [
    {
      "code": "mxbank",
      "created_at": "2016-09-21T22:03:55.000Z",
      "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "forgot_password_url": "https://www.mx.com/forgot-password",
      "forgot_username_url": "https://www.mx.com/forgot-username",
      "has_checking_account": "https://www.mx.com/forgot-username",
      "has_credit_card_accounts": true,
      "has_investment_accounts": true,
      "has_line_of_credit_accounts": true,
      "has_loan_accounts": true,
      "has_mortgage_accounts": true,
      "has_savings_accounts": true,
      "is_disabled_by_client": false,
      "is_hidden": true,
      "is_test": true,
      "iso_country_code": [
        "US",
        "CA"
      ],
      "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/INS-1572a04c-912b-59bf-5841-332c7dfafaef_100x100.png",
      "name": "MX Bank",
      "popularity": 72644,
      "small_logo_url": "https://content.moneydesktop.com/storage/MD_AssetsIpad%20Logos/50x50/INS-1572a04c-912b-59bf-5841-332c7dfafaef_50x50.png",
      "supports_account_identification": true,
      "supports_account_verification": true,
      "supports_oauth": true,
      "supports_transaction_history": false,
      "trouble_signing_in_url": "https://www.mx.com/trouble-signing-in",
      "updated_at": "2022-04-11T17:38:27.000Z",
      "url": "https://www.mx.com"
    }
  ]
}
This endpoint will return a list of institutions which can be filtered. Responses are paginated. A list of all supported institutions can be obtained by sending a request with only the name parameter and setting the value to an empty string. If you cache this list, you must update the cached version at least once each day. We recommend you use this endpoint rather than the deprecated list institutions endpoint to get updated information about institutions.

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.

Query Parameters

​
iso_country_code
string[]

An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include US, CA, and MX (Mexico).

​
page
string

Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified.

​
records_per_age
string

List from 10 to 1000 to determine how many records per page will be used.

Body

application/vnd.mx.nexus.v1+json
​
institution
object

Response

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

OK

​
institutions
object[]