List institutions

curl --request GET \
  --url https://int-api.mx.com/institutions \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/institutions"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/institutions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/institutions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/institutions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/institutions")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/institutions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "institutions": [
    {
      "client_status": "AVAILABLE",
      "code": "mxbank",
      "created_at": "2025-02-13T18:08:00+00:00",
      "forgot_password_url": "https://example.url.mxbank.com/forgot-password",
      "forgot_username_url": "https://example.url.mxbank.com/forgot-username",
      "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "instructional_text": "Some instructional text <a href=\"https://example.url.mxbank.com/instructions\" id=\"instructional_text\">for end users</a>.",
      "instructional_text_steps": [
        "Step 1: Do this.",
        "Step 2: Do that."
      ],
      "is_disabled_by_client": false,
      "is_hidden": true,
      "iso_country_code": "US",
      "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png",
      "name": "MX Bank",
      "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png",
      "status": "OPERATIONAL",
      "supported_products": [],
      "supports_oauth": true,
      "supports_tax_document": true,
      "trouble_signing_in_url": "https://example.url.mxbank.com/login-trouble",
      "url": "https://www.mxbank.com"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

GET

institutions

List institutions

curl --request GET \
  --url https://int-api.mx.com/institutions \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/institutions"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/institutions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/institutions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/institutions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/institutions")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/institutions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "institutions": [
    {
      "client_status": "AVAILABLE",
      "code": "mxbank",
      "created_at": "2025-02-13T18:08:00+00:00",
      "forgot_password_url": "https://example.url.mxbank.com/forgot-password",
      "forgot_username_url": "https://example.url.mxbank.com/forgot-username",
      "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "instructional_text": "Some instructional text <a href=\"https://example.url.mxbank.com/instructions\" id=\"instructional_text\">for end users</a>.",
      "instructional_text_steps": [
        "Step 1: Do this.",
        "Step 2: Do that."
      ],
      "is_disabled_by_client": false,
      "is_hidden": true,
      "iso_country_code": "US",
      "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png",
      "name": "MX Bank",
      "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png",
      "status": "OPERATIONAL",
      "supported_products": [],
      "supports_oauth": true,
      "supports_tax_document": true,
      "trouble_signing_in_url": "https://example.url.mxbank.com/login-trouble",
      "url": "https://www.mxbank.com"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

Lists financial institutions available through the MX platform. This endpoint has been updated in v20250224 to enhance search and filtering capabilities based on the products supported by each institution.

Authorizations

Authorization

string

header

required

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}'

Headers

Accept-Version

string

default:v20250224

required

MX Platform API version.

Example:

"v20250224"

Query Parameters

name

string

This will list only institutions in which the appended string appears.

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).

include_blocked_institutions

boolean

default:false

When set to true, returns all institutions regardless of their operational status. When false or omitted, only returns institutions that are currently operational.

page

integer

Results are paginated. Specify current page.

records_per_page

integer

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

supported_products[]

enum<string>[]

Filters institutions that support specific products. Values may include account_verification, identity_verification, transactions, transaction_history, statements, investments.

For example, institutions that support account_verification and statements, ?supported_products[]=account_verification&supported_products[]=statements.

Available options:

account_verification,

identity_verification,

transactions,

transaction_history,

statements,

investments

Response

200 - application/json

institutions

object[]

Hide child attributes

institutions.client_status

enum<string>

The client-level status of the institution, indicating restrictions on member connections.

Available options:

AVAILABLE,

PREVENT_ALL,

PREVENT_NEW,

PREVENT_ALL_AND_DISCONNECT,

PREVENT_VERIFICATION,

PREVENT_BACKGROUND_AGG

Example:

"AVAILABLE"

institutions.code

string | null

The code identifying a financial institution.

Example:

"mxbank"

institutions.created_at

string

The date and time the institution was created, represented in ISO 8601 format with a timestamp.

Example:

"2025-02-13T18:08:00+00:00"

institutions.forgot_password_url

string | null

URL for the forgot password page of the institution.

Example:

"https://example.url.mxbank.com/forgot-password"

institutions.forgot_username_url

string | null

URL for the forgot username page of the institution.

Example:

"https://example.url.mxbank.com/forgot-username"

institutions.guid

string

The unique identifier for the institution. Defined by MX.

Example:

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

institutions.instructional_text

string | null

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 <a></a> tags to link to explanatory material.

Example:

"Some instructional text <a href=\"https://example.url.mxbank.com/instructions\" id=\"instructional_text\">for end users</a>."

institutions.instructional_text_steps

string[] | null

An array of instructional steps that may contain html elements.

Example:

["Step 1: Do this.", "Step 2: Do that."]

institutions.is_disabled_by_client

boolean | null

Indicates whether the institution is disabled by the client.

Example:

false

institutions.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

institutions.iso_country_code

enum<string>

The ISO country code associated with the institution.

Available options:

US,

CA

Example:

"US"

institutions.medium_logo_url

string | null

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"

institutions.name

string | null

The name of the institution.

Example:

"MX Bank"

institutions.small_logo_url

string | null

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"

institutions.status

enum<string>

The operational status of the institution.

Available options:

OPERATIONAL,

MAINTENANCE,

DEGRADED,

UNAVAILABLE

Example:

"OPERATIONAL"

institutions.supported_products

enum<string>[]

Available options:

account_verification,

identity_verification,

transactions,

transaction_history,

statements,

investments,

rewards

institutions.supports_oauth

boolean | null

If true, this indicates that the institution supports OAuth and that you have been properly registered for OAuth with that institution.

Example:

true

institutions.supports_tax_document

boolean | null

This indicates whether the institution supports tax documents.

Example:

true

institutions.trouble_signing_in_url

string | null

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

Example:

"https://example.url.mxbank.com/login-trouble"

institutions.url

string | null

The URL for an institution's website.

Example:

"https://www.mxbank.com"

pagination

object

Hide child attributes

pagination.current_page

integer

The page delivered by the current response.

Example:

1

pagination.per_page

integer

The number of records delivered with each page.

Example:

25

pagination.total_entries

integer

The total number of records available.

Example:

1

pagination.total_pages

integer

The total number of pages available.

Example:

1

Institutions Overview

List favorite institutions