MX Platform Status API
The Status API from MX Platform — 1 operation(s) for status.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/mx-platform-status-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.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.'
title: MX Platform Status API
version: 0.1.0
servers:
- url: https://api.mx.com
- url: https://int-api.mx.com
security:
- basicAuth: []
tags:
- name: Status
paths:
/users/{user_guid}/members/{member_guid}/status:
get:
description: This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.
operationId: readMemberStatus
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberStatusResponseBody'
description: OK
summary: Read member status
tags:
- Status
components:
schemas:
ChallengeResponse:
properties:
field_name:
example: Who is this guy?
type:
- string
- 'null'
guid:
example: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
type:
- string
- 'null'
image_data:
example: Who is this guy?
type:
- string
- 'null'
image_options:
items:
$ref: '#/components/schemas/ImageOptionResponse'
type: array
label:
example: Who is this guy?
type:
- string
- 'null'
options:
items:
$ref: '#/components/schemas/OptionResponse'
type: array
type:
example: IMAGE_DATA
type:
- string
- 'null'
type: object
MemberStatusResponseBody:
properties:
member:
$ref: '#/components/schemas/MemberStatusResponse'
type: object
MemberStatusResponse:
properties:
aggregated_at:
example: '2016-10-13T18:07:57.000Z'
type:
- string
- 'null'
challenges:
items:
$ref: '#/components/schemas/ChallengeResponse'
type: array
connection_status:
example: CONNECTED
type:
- string
- 'null'
guid:
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
type:
- string
- 'null'
has_processed_accounts:
example: true
type:
- boolean
- 'null'
has_processed_account_numbers:
example: true
type:
- boolean
- 'null'
has_processed_transactions:
example: false
type:
- boolean
- 'null'
is_authenticated:
example: false
type:
- boolean
- 'null'
is_being_aggregated:
example: false
type:
- boolean
- 'null'
successfully_aggregated_at:
example: '2016-10-13T17:57:38.000Z'
type:
- string
- 'null'
type: object
ImageOptionResponse:
properties:
data_uri:
example: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
type:
- string
- 'null'
label:
example: IMAGE_1
type:
- string
- 'null'
value:
example: image_data
type:
- string
- 'null'
type: object
OptionResponse:
properties:
label:
example: IMAGE_1
type:
- string
- 'null'
value:
example: image_data
type:
- string
- 'null'
type: object
securitySchemes:
basicAuth:
scheme: basic
type: http