How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
MX

MX Platform API

The MX Platform API aggregates and enhances financial data, connecting apps and websites to tens of thousands of financial institutions. Covers users, members, accounts, transactions, categorization, insights, verification, and widgets. OpenAPI 3.0 (version v20250224), HTTP Basic authentication.

Documentation Provider Profile APIs.io OpenAPI GitHub

MX Platform API is one of 3 APIs that MX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Financial Data, Aggregation, Data Enhancement, and Verification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 175 operations across 121 paths, organized into 26 resource areas, and defines 204 schemas. It is described by OpenAPI 3.0.0, at version 20250224.

Requests are made against 2 base URLs: https://int-api.mx.com, https://api.mx.com.

175 operations 121 paths 204 schemas 19 DELETE101 GET34 POST21 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
20250224
Base URL
https://api.mx.com
Authentication
HTTP Basic, HTTP Bearer
Contact
MX Platform API
Resource Areas
26

Authentication & Security 2

MX Platform API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • basicAuth — The MX Platform API requires basic access authentication using your clientid and apikey. These credentials must be Base64 encoded and included in the Authoriza…

Paths & Operations 175

Across 121 paths, the API surfaces 175 operations — 19 DELETE, 101 GET, 34 POST, 21 PUT. They span 26 resource areas, including processor token, ach return, categories, institutions, managed data [deprecated], merchants, transactions, users, and 18 more. Each is listed below with its method, path, parameters, and response codes.

processor token 6
POST
/authorization_code
Request an authorization code
requestAuthorizationCode 1 param body → 200
GET
/tokens
View a List of Tokens
listTokens 1 param body → 200
GET
/account/account_numbers
Request an account number (Processors Only)
requestAccountNumber 1 param → 200
POST
/account/check_balance
Check Real Time Account Balance (Processors Only)
checkRealTimeAccountBalance 1 param → 200
GET
/payment_account
Read the account balance (Processors Only)
readAccountBalance 1 param → 200
GET
/account/transactions
Get account owner information (Processors Only)
getAccountOwnerInfo 1 param → 200
ach return 3

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 A…

GET
/ach_returns/{ach_return_guid}
Read ACH Return
readACHRetrun 1 param → 200
GET
/ach_returns
List ACH Returns
listACHRetruns 7 params → 200
POST
/ach_returns
Create ACH Return
createACHReturn body → 200
categories 10

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-refe…

GET
/categories/default
List default categories
listDefaultCategories 3 params → 200
GET
/categories/{category_guid}
Read a default category
readDefaultCategory 2 params → 200
GET
/users/{user_guid}/accounts/{account_guid}/date_range_category_totals
List category totals by account
listDateRangeCategoryTotalsByAccount 5 params → 200
GET
/users/{user_guid}/date_range_category_totals
List category totals by user
listCategoryTotalsByUser 4 params → 200
GET
/users/{user_guid}/categories
List categories
listCategories 4 params → 200
POST
/users/{user_guid}/categories
Create category
createCategory 2 params body → 200
GET
/users/{user_guid}/categories/default
List default categories by user
listDefaultCategoriesByUser 4 params → 200
DELETE
/users/{user_guid}/categories/{category_guid}
Delete category
deleteCategory 3 params → 204
GET
/users/{user_guid}/categories/{category_guid}
Read a custom category
readCategory 3 params → 200
PUT
/users/{user_guid}/categories/{category_guid}
Update category
updateCategory 3 params body → 200
institutions 4

Institutions represent a financial institution. A single real-world financial institution may have several institution objects on the MX platform. For example, the mortgage divisi…

GET
/institutions
List institutions
listInstitutions 7 params → 200
GET
/institutions/favorites
List favorite institutions
listFavoriteInstitutions 3 params → 200
GET
/institutions/{institution_code}
Read institution
readInstitution 2 params → 200
GET
/institutions/{institution_identifier}/credentials
List institution credentials
listInstitutionCredentials 4 params → 200
managed data [deprecated] 16
GET
/managed_institutionsdeprecated
List managed institutions
listManagedInstitutions 3 params → 200
GET
/users/{user_guid}/managed_membersdeprecated
List managed members
listManagedMembers 4 params → 200
POST
/users/{user_guid}/managed_membersdeprecated
Create managed member
createManagedMember 2 params body → 202
DELETE
/users/{user_guid}/managed_members/{member_guid}deprecated
Delete managed member
deleteManagedMember 4 params → 204
GET
/users/{user_guid}/managed_members/{member_guid}deprecated
Read managed member
readManagedMember 3 params → 200
PUT
/users/{user_guid}/managed_members/{member_guid}deprecated
Update managed member
updateManagedMember 3 params body → 200
GET
/users/{user_guid}/managed_members/{member_guid}/accountsdeprecated
List managed accounts
listManagedAccounts 5 params → 200
POST
/users/{user_guid}/managed_members/{member_guid}/accountsdeprecated
Create managed account
createManagedAccount 3 params body → 200
DELETE
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}deprecated
Delete managed account
deleteManagedAccount 4 params → 204
GET
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}deprecated
Read managed account
readManagedAccount 4 params → 200
PUT
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}deprecated
Update managed account
updateManagedAccount 4 params body → 200
GET
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactionsdeprecated
List managed transactions
listManagedTransactions 8 params → 200
POST
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactionsdeprecated
Create managed transaction
createManagedTransaction 4 params body → 200
DELETE
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}deprecated
Delete managed transaction
deleteManagedTransaction 5 params → 204
GET
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}deprecated
Read managed transaction
readManagedTransaction 5 params → 200
PUT
/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}deprecated
Update managed transaction
updateManagedTransaction 5 params body → 200
merchants 3

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 merchantguid and a merc…

GET
/merchant_locations/{merchant_location_guid}
Read merchant location
readMerchantLocation 2 params → 200
GET
/merchants
List merchants
listMerchants 4 params → 200
GET
/merchants/{merchant_guid}
Read merchant
readMerchant 2 params → 200
transactions 20

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 anoth…

POST
/transactions/enhance
Enhance transactions
enhanceTransactions 1 param body → 200
POST
/users/{user_guid}/accounts/{account_guid}/transactions
Create manual transaction
createManualTransaction 3 params body → 200
GET
/users/{user_guid}/accounts/{account_guid}/transactions
List transactions by account
listTransactionsByAccount 12 params → 200
GET
/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions
List transactions by account per member
listTransactionsByAccountPerMember 13 params → 200
POST
/users/{user_identifier}/members/{member_identifier}/extend_history
Extend history
extendHistory 3 params → 202
GET
/users/{user_identifier}/members/{member_identifier}/transactions
List transactions by member
listTransactionsByMember 14 params → 200
GET
/users/{user_identifier}/tags/{tag_guid}/transactions
List transactions by tag
listTransactionsByTag 12 params → 200
DELETE
/users/{user_guid}/transaction_rules/{transaction_rule_guid}
Delete transaction rule
deleteTransactionRule 3 params → 204
GET
/users/{user_identifier}/transactions
List transactions
listTransactions 12 params → 200
GET
/users/{user_guid}/transactions/{transaction_guid}
Read transaction
readTransaction 5 params → 200
PUT
/users/{user_guid}/transactions/{transaction_guid}
Update transaction
updateTransaction 4 params body → 200
DELETE
/users/{user_guid}/transactions/{transaction_guid}
Delete manual transactions
deleteManualTransactions 4 params → 204
GET
/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}
Read transaction by account
readTransactionByAccount 7 params → 200
PUT
/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}
Update transaction by account
updateTransactionByAccount 6 params body → 200
GET
/users/{user_guid}/repeating_transactions
List Repeating Transactions
repeatingTransactions 2 params → 200
GET
/users/{user_guid}/repeating_transactions/{repeating_transaction_guid}
Get a Repeating Transaction
specificRepeatingTransaction 3 params → 200
DELETE
/users/{user_guid}/transactions/{transaction_guid}/split
Delete split transactions
deleteSplitTransactions 3 params → 204
POST
/users/{user_guid}/transactions/{transaction_guid}/split
Create split transactions
createSplitTransactions 3 params body → 200
DELETE
/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/split
Delete split transactions by account
deleteSplitTransactionsbyAccount 5 params → 204
POST
/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/split
Create split transactions by account
createSplitTransactionsbyAccount 5 params body → 200
users 5

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/connectiv…

GET
/users
List users
listUsers 6 params → 200
POST
/users
Create user
createUser 1 param body → 200
DELETE
/users/{user_identifier}
Delete user
deleteUser 3 params → 204
GET
/users/{user_identifier}
Read user
readUser 2 params → 200
PUT
/users/{user_identifier}
Update user
updateUser 2 params body → 200
accounts 13

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 re…

GET
/users/{user_identifier}/accounts
List accounts
listUserAccounts 8 params → 200
POST
/users/{user_identifier}/accounts
Create manual account
createManualAccount 2 params body → 200
GET
/users/{user_guid}/accounts/{account_guid}
Read account
readAccount 3 params → 200
DELETE
/users/{user_guid}/accounts/{account_guid}
Delete manual account
deleteManualAccount 4 params → 204
GET
/users/{user_identifier}/accounts/{account_identifier}/account_numbers
List account numbers by account
listAccountNumbersByAccount 5 params → 200
PUT
/users/{user_guid}/accounts/{account_guid}/block
Block an account
blockAccount 3 params → 200
POST
/users/{user_guid}/accounts/merge
Merge accounts
mergeAccounts 2 params body → 200
GET
/users/{user_guid}/accounts/{account_guid}/monthly_account_balances
List account balances by month
listAccountBalancesByMonth 5 params → 200
GET
/users/{user_guid}/members/{member_guid}/account_numbers
List account numbers by member
listAccountNumbersByMember 5 params → 200
GET
/users/{user_identifier}/members/{member_identifier}/account_owners
List account owners by member
listAccountOwnersByMember 5 params → 200
GET
/users/{user_identifier}/members/{member_identifier}/accounts
List member accounts
listMemberAccounts 6 params → 200
GET
/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}
Read member account
readAccountByMember 4 params → 200
PUT
/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}
Update account by member
updateAccountByMember 4 params body → 200
insights 10

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 ba…

GET
/users/{user_guid}/accounts/{account_guid}/insights
List insights by account
listInsightsByAccount 5 params → 200
GET
/users/{user_guid}/insights
List all insights for a user
listInsightsUser 4 params → 200
GET
/users/{user_guid}/insights/{insight_guid}/categories
List all categories associated with an insight
listCategoriesInsight 5 params → 200
GET
/users/{user_guid}/insights/{insight_guid}/accounts
List all accounts associated with an insight
listAccountsInsight 5 params → 200
GET
/users/{user_guid}/insights/{insight_guid}/merchants
List all merchants associated with an insight
listMerchantsInsight 5 params → 200
GET
/users/{user_guid}/insights/{insight_guid}/scheduled_payments
List all scheduled payments associated with an insight
listScheduledPaymentsInsight 5 params → 200
GET
/users/{user_guid}/insights/{insight_guid}/transactions
List all transactions associated with an insight
listTransactionsInsight 5 params → 200
GET
/users/{user_guid}/insights/{insight_guid}
Read insight
readInsightUser 3 params → 200
PUT
/users/{user_guid}/insights/{insight_guid}
Update insight
updateInsight 3 params body → 200
GET
/users/{user_guid}/transactions/{transaction_guid}/insights
List insights by transaction
listInsightsByTransaction 5 params → 200
jobs 1
GET
/users/{user_identifier}/jobs/{job_guid}
Read job
3 params → 200
members 14

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

GET
/users/{user_identifier}/members
List members
listMembers 5 params → 200
POST
/users/{user_identifier}/members
Create member
createMember 3 params body → 200201202
DELETE
/users/{user_identifier}/members/{member_identifier}
Delete member
deleteMember 3 params → 204
GET
/users/{user_identifier}/members/{member_identifier}
Read member
readMember 3 params → 200
PUT
/users/{user_identifier}/members/{member_identifier}
Update member
updateMember 4 params body → 200
POST
/users/{user_identifier}/members/{member_identifier}/aggregate
Aggregate member
aggregateMember 4 params → 202
POST
/users/{user_identifier}/members/aggregate_all
Aggregate all members
aggregateAllMembers 2 params → 202
GET
/users/{user_identifier}/members/{member_identifier}/challenges
List member challenges
listMemberChallenges 5 params → 200
POST
/users/{user_identifier}/members/{member_identifier}/check_balance
Check balances
checkBalances 3 params → 202
GET
/users/{user_identifier}/members/{member_identifier}/credentials
List member credentials
listMemberCredentials 5 params → 200
POST
/users/{user_identifier}/members/{member_identifier}/identify
Identify member
identifyMember 3 params → 202
PUT
/users/{user_identifier}/members/{member_identifier}/resume
Resume aggregation
resumeAggregation 3 params body → 202
GET
/users/{user_identifier}/members/{member_identifier}/status
Read member status
readMemberStatus 3 params → 200
POST
/users/{user_identifier}/members/{member_identifier}/verify
Verify member
verifyMember 4 params → 200
statements 4

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.

POST
/users/{user_identifier}/members/{member_identifier}/fetch_statements
Fetch statements
fetchStatements 3 params → 202
GET
/users/{user_guid}/members/{member_guid}/statements
List statements by member
listStatementsByMember 5 params → 200
GET
/users/{user_guid}/members/{member_guid}/statements/{statement_guid}
Read statement by member
readStatementByMember 4 params → 200
GET
/users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf
Download statement pdf
downloadStatementPDF 4 params → 200
investment holdings 5

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 ba…

GET
/users/{user_guid}/members/{member_guid}/investment_holdings
List holdings by member
listHoldingsByMember 5 params → 200
GET
/users/{user_guid}/investment_holdings
List holdings by user
listHoldings 4 params → 200
GET
/users/{user_guid}/investment_holdings/{holding_guid}
Read holding
readHolding 3 params → 200
GET
/users/{user_guid}/accounts/{account_guid}/investment_holdings
List holdings by account
listHoldingsByAccount 5 params → 200
GET
/users/{user_guid}/investment_holdings_deactivate
Deactivate user from Investment Holdings
deactivateUser 2 params → 200
widgets 2

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 param…

GET
/users/{user_identifier}/members/{member_identifier}/oauth_window_uri
Request oauth window uri
requestOAuthWindowURI 8 params → 200
POST
/users/{user_identifier}/widget_urls
Request widget URL
requestWidgetURL 4 params body → 200
spending plan 15

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 en…

POST
/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items
Create spending plan iteration item
createSpendingPlanIterationItem 3 params body → 200
GET
/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items
List spending plan iteration items
listSpendingPlanIterationItems 5 params → 200
POST
/users/{user_guid}/spending_plans
Create spending plan
createSpendingPlan 2 params → 200
GET
/users/{user_guid}/spending_plans
List spending plans
listSpendingPlans 4 params → 200
DELETE
/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}
Delete spending plan account
deleteSpendingPlanAccount 4 params → 204
GET
/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}
Read spending plan account
readSpendingPlanAccount 6 params → 200
DELETE
/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}
Delete spending plan iteration item
deleteSpendingPlanIterationItem 4 params → 204
GET
/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}
Read a spending plan iteration item
readSpendingPlanIterationItem 6 params → 200
PUT
/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}
Update a spending plan iteration item
updateSpendingPlanIterationItem 4 params body → 200
DELETE
/users/{user_guid}/spending_plans/{spending_plan_guid}
Delete spending plan
deleteSpendingPlan 3 params → 204
GET
/users/{user_guid}/spending_plans/{spending_plan_guid}
Read a spending plan for a user
readSpendingPlanUser 5 params → 200
GET
/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts
List spending plan accounts
listSpendingPlanAccounts 5 params → 200
GET
/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations
List spending plan iterations
listSpendingPlanIterations 5 params → 200
GET
/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current
Read current spending plan iteration
readCurrentSpendingPlanIteration 5 params → 200
GET
/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}
Read a spending plan iteration
readSpendingPlanIteration 6 params → 200
taggings 5

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 c…

GET
/users/{user_guid}/taggings
List taggings
listTaggings 4 params → 200
POST
/users/{user_guid}/taggings
Create tagging
createTagging 2 params body → 200
DELETE
/users/{user_guid}/taggings/{tagging_guid}
Delete tagging
deleteTagging 3 params → 204
GET
/users/{user_guid}/taggings/{tagging_guid}
Read tagging
readTagging 3 params → 200
PUT
/users/{user_guid}/taggings/{tagging_guid}
Update tagging
updateTagging 3 params body → 200
tags 5

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 c…

GET
/users/{user_guid}/tags
List tags
listTags 4 params → 200
POST
/users/{user_guid}/tags
Create tag
createTag 2 params body → 200
DELETE
/users/{user_guid}/tags/{tag_guid}
Delete tag
deleteTag 4 params → 204
GET
/users/{user_guid}/tags/{tag_guid}
Read tag
readTag 3 params → 200
PUT
/users/{user_guid}/tags/{tag_guid}
Update tag
updateTag 3 params body → 200
transaction rules 4

Transaction Rules allow users to automatically recategorize or rename all similar transactions according to their preferences. This only applies to future transactions. When recat…

GET
/users/{user_guid}/transaction_rules
List transaction rules
listTransactionRules 4 params → 200
POST
/users/{user_guid}/transaction_rules
Create transaction rule
createTransactionRule 2 params body → 200
GET
/users/{user_guid}/transaction_rules/{transaction_rule_guid}
Read transaction rule
readTransactionRule 3 params → 200
PUT
/users/{user_guid}/transaction_rules/{transaction_rule_guid}
Update transaction rule
updateTransactionRule 3 params body → 200
budgets 6

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 exist…

POST
/users/{user_guid}/budgets/generate
Auto-generate budgets
autoGenerateBudgets 2 params → 200
POST
/users/{user_guid}/budgets
Create a budget
createBudget 2 params body → 200
GET
/users/{user_guid}/budgets
List all budgets
listAllBudgets 2 params → 200
GET
/users/{user_guid}/budgets/{budget_guid}
Read a specific budget
readSpecificBudget 3 params → 200
PUT
/users/{user_guid}/budgets/{budget_guid}
Update a specific budget
updateSpecificBudget 3 params body → 200
DELETE
/users/{user_guid}/budgets/{budget_guid}
Delete a budget
deleteBudget 3 params → 204
goals 6

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 t…

POST
/users/{user_guid}/goals
Create a goal
createGoal 2 params body → 200
GET
/users/{user_guid}/goals
List goals
listGoals 5 params → 200
DELETE
/users/{user_guid}/goals/{goal_guid}
Delete a goal
deleteGoal 5 params → 204
GET
/users/{user_guid}/goals/{goal_guid}
Read a goal
readGoal 3 params → 200
PUT
/users/{user_guid}/goals/{goal_guid}
Update a goal
updateGoal 3 params body → 200
PUT
/users/{user_guid}/goals/reposition
Reposition goals
repositionGoals 2 params body → 200
notifications 3

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 APINOTIFICATION, channel…

POST
/users/{user_guid}/notifications
Create a notification
createNotification 2 params body → 200
GET
/users/{user_guid}/notifications
List notifications
listNotifications 4 params → 200
GET
/users/{user_guid}/notifications/{notification_guid}
Read notifications
readNotifications 3 params → 200
monthly cash flow profile 2
GET
/users/{user_identifier}/monthly_cash_flow_profile
Read monthly cash flow profile
readMonthlyCashFlowProfile 2 params → 200
PUT
/users/{user_identifier}/monthly_cash_flow_profile
Update monthly cash flow profile
updateMonthlyCashFlowProfile 2 params body → 200
microdeposits 6

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

GET
/users/{user_guid}/micro_deposits
List all microdeposits for a user
listUserMicrodeposits 2 params → 200
POST
/users/{user_guid}/micro_deposits
Create or pre-initiate a microdeposit
createMicrodeposit 2 params body → 200
DELETE
/users/{user_guid}/micro_deposits/{micro_deposit_guid}
Delete a microdeposit
deleteMicrodeposit 3 params → 204
GET
/users/{user_guid}/micro_deposits/{micro_deposit_guid}
Read a microdeposit for a user
readUserMicrodeposit 3 params → 200
PUT
/micro_deposits/{micro_deposit_guid}/verify
Verify a Microdeposit
verifyMicrodeposit 2 params body → 200
GET
/users/{user_guid}/account_verifications
List all verifications for a user
listUserVerifications 2 params → 200
rewards 4
POST
/users/{user_identifier}/members/{member_identifier}/fetch_rewards
Fetch Rewards
fetchRewards 3 params → 200
GET
/users/{user_guid}/members/{member_guid}/rewards
List Rewards
listRewards 3 params → 200
GET
/users/{user_guid}/members/{member_guid}/rewards/{reward_guid}
Read Reward
readRewards 4 params → 200
GET
/credit_card_products/{credit_card_product_guid}
Read a Credit Card Product
creditCard 2 params → 200
verifiable credentials 3

MX provides Verifiable Credential endpoints that comply with web5 standards. For more info, see [Verifiable Credentials Overview](docs.mx.com/api-reference/reference/verifiable-cr…

GET
/vc/users/{user_guid}/members/{member_guid}/customers
Get Identity Data
getIdentityData 3 params → 200
GET
/vc/users/{user_guid}/members/{member_guid}/accounts
Get Accounts Data
getAccountsData 3 params → 200
GET
/vc/users/{user_guid}/accounts/{account_guid}/transactions
Get Transactions Data
getTransactionsData 5 params → 200

Schemas 204

The contract defines 204 schemas that model the data the API accepts and returns. The most detailed are AccountResponse (58 properties), TransactionResponse (44 properties), TransactionCreateResponseBody (44 properties), InvestmentHoldingResponse (37 properties). Each schema is shown below with its type and property counts.

AuthorizationCodeRequest
object
1 property
AuthorizationCodeRequestBody
object
1 property
AuthorizationCodeResponse
object
1 property
AuthorizationCodeResponseBody
object
1 property
ACHResponse
object
29 properties
ACHReturnResponseBody
object
1 property
PaginationResponse
object
4 properties
ACHReturnsResponseBody
object
2 properties
ACHReturnCreateRequest
object
16 properties 5 required
ACHReturnCreateRequestBody
object
1 property
CategoryResponse
object
8 properties
CategoriesResponseBody
object
2 properties
CategoryResponseBody
object
1 property
SupportedProducts
string
InstitutionResponse
object
20 properties
InstitutionsResponseBody
object
2 properties
InstitutionResponseBody
object
1 property
CredentialResponse
object
6 properties
CredentialsResponseBody
object
2 properties
MerchantLocationResponse
object
12 properties
MerchantLocationResponseBody
object
1 property
MerchantResponse
object
6 properties
MerchantsResponseBody
object
2 properties
MerchantResponseBody
object
1 property
EnhanceTransactionsRequest
object
7 properties 2 required
EnhanceTransactionsRequestBody
object
1 property
EnhanceTransactionResponse
object
25 properties
EnhanceTransactionsResponseBody
object
1 property
UserResponse
object
5 properties
UsersResponseBody
object
2 properties
UserCreateRequest
object
4 properties
UserCreateRequestBody
object
1 property
UserResponseBody
object
1 property
UserUpdateRequest
object
4 properties
UserUpdateRequestBody
object
1 property
AccountResponse
object
58 properties
AccountsResponseBody
object
2 properties
AccountCreateRequest
object
21 properties 2 required
AccountCreateRequestBody
object
1 property
AccountResponseBody
object
1 property
AccountNumberResponse
object
12 properties
AccountNumbersResponseBody
object
2 properties
DateRangeCategoryTotalsResponse
object
5 properties
DateRangeCategoryTotalsResponseBody
object
1 property
InsightResponse
object
21 properties
InsightsResponseBody
object
2 properties
AccountsMergeRequest
object
1 property 1 required
AccountsMergeRequestBody
object
1 property
MonthlyAccountBalance
object
5 properties
MonthlyAccountBalancesResponseBody
object
1 property
TransactionResponse
object
44 properties
TransactionIncludesResponse
object
TransactionsResponseBodyIncludes
object
2 properties
TransactionCreateRequest
object
12 properties 4 required
TransactionCreateRequestBody
object
1 property
TransactionCreateResponseBody
object
44 properties
CategoryCreateRequest
object
3 properties 2 required
CategoryCreateRequestBody
object
1 property
CategoryUpdateRequest
object
2 properties
CategoryUpdateRequestBody
object
1 property
JobResponse
object
12 properties
JobResponseBody
object
1 property
ScheduledPaymentResponse
object
13 properties
ScheduledPaymentsResponseBody
object
2 properties
TransactionsResponseBody
object
2 properties
InsightResponseBody
object
1 property
InsightUpdateRequest
object
2 properties
InsightUpdateRequestBody
object
1 property
MemberResponse
object
24 properties
MembersResponseBody
object
2 properties
ManagedMemberCreateRequest
object
4 properties 1 required
ManagedMemberCreateRequestBody
object
1 property
MemberResponseBody
object
1 property
ManagedMemberUpdateRequest
object
3 properties
ManagedMemberUpdateRequestBody
object
1 property
ManagedAccountCreateRequest
object
31 properties 4 required
ManagedAccountCreateRequestBody
object
1 property
ManagedAccountUpdateRequest
object
31 properties
ManagedAccountUpdateRequestBody
object
1 property
ManagedTransactionCreateRequest
object
20 properties 6 required
ManagedTransactionCreateRequestBody
object
1 property
TransactionResponseBody
object
1 property
ManagedTransactionUpdateRequest
object
20 properties
ManagedTransactionUpdateRequestBody
object
1 property
DataRequest
object
Contains a products array that specifies the products you want to aggregate.
1 property 1 required
CredentialRequest
object
2 properties
MemberCreateRequest
object
7 properties 2 required
MemberCreateRequestBody
object
6 properties
MemberResponseWithJobError
MemberResponseWithJobErrorBody
object
1 property
MemberUpdateRequest
object
5 properties
MemberUpdateRequestBody
object
1 property
AccountOwnerResponse
object
14 properties
AccountOwnersResponseBody
object
2 properties
AccountUpdateRequest
object
21 properties
AccountUpdateRequestBody
object
1 property
ImageOptionResponse
object
4 properties
OptionResponse
object
3 properties
ChallengeResponse
object
7 properties
ChallengesResponseBody
object
2 properties
InvestmentHoldingResponse
object
37 properties
InvestmentHoldingsResponseBody
object
2 properties
InvestmentHoldingResponseBody
object
1 property
InvestmentHoldingsDeactivation
object
2 properties
OAuthWindowResponse
object
2 properties
OAuthWindowResponseBody
object
1 property
MemberResumeRequest
object
1 property
MemberResumeRequestBody
object
1 property
StatementResponse
object
8 properties
StatementsResponseBody
object
2 properties
StatementResponseBody
object
1 property
MemberStatusResponse
object
10 properties
MemberStatusResponseBody
object
1 property
SpendingPlanIterationItemResponse
object
12 properties
SpendingPlanIterationItemsResponseBody
object
2 properties
SpendingPlanIterationItemCreateRequestBody
object
5 properties 1 required
SpendingPlanResponse
object
5 properties
SpendingPlansResponseBody
object
2 properties
SpendingPlanAccountResponse
object
7 properties
SpendingPlanAccountsResponse
object
2 properties
SpendingPlanIterationResponse
object
8 properties
SpendingPlanIterationsResponse
object
2 properties
TaggingResponse
object
5 properties
TaggingsResponseBody
object
2 properties
TaggingCreateRequest
object
2 properties 2 required
TaggingCreateRequestBody
object
1 property
TaggingResponseBody
object
1 property
TaggingUpdateRequest
object
1 property 1 required
TaggingUpdateRequestBody
object
1 property
TagResponse
object
3 properties
TagsResponseBody
object
2 properties
TagCreateRequest
object
1 property 1 required
TagCreateRequestBody
object
1 property
TagResponseBody
object
1 property
TagUpdateRequest
object
1 property 1 required
TagUpdateRequestBody
object
1 property
TransactionRuleResponse
object
7 properties
TransactionRulesResponseBody
object
2 properties
TransactionRuleCreateRequest
object
3 properties 2 required
TransactionRuleCreateRequestBody
object
1 property
TransactionRuleResponseBody
object
1 property
TransactionRuleUpdateRequest
object
3 properties
TransactionRuleUpdateRequestBody
object
1 property
TransactionUpdateRequest
object
1 property 1 required
TransactionUpdateRequestBody
object
1 property
DeepLinkParams
object
Enables widget-specific behavior.
5 properties
Style
object
Contains fields to customize the appearance of a widget.
1 property 1 required
WidgetRequest
object
26 properties 1 required
WidgetResponse
object
3 properties
WidgetResponseBody
object
1 property
BudgetResponse
object
16 properties
BudgetResponseBody
object
1 property
BudgetCreateRequest
object
5 properties 2 required
BudgetCreateRequestBody
object
1 property
BudgetUpdateRequest
object
3 properties
BudgetUpdateRequestBody
object
1 property
GoalsResponse
object
16 properties
GoalsResponseBody
object
2 properties
GoalRequest
object
11 properties 5 required
GoalRequestBody
object
1 property
GoalResponse
object
16 properties
GoalResponseBody
object
1 property
UpdateGoalRequest
object
11 properties
UpdateGoalRequestBody
object
1 property
RepositionRequest
object
2 properties 2 required
RepositionRequestBody
object
1 property
RepositionResponseBody
object
1 property
NotificationResponse
object
12 properties
NotificationsResponseBody
object
1 property
NotificationRequest
object
2 properties 2 required
NotificationRequestBody
object
1 property
NotificationResponseBody
object
1 property
RepeatingTransactionResponse
object
12 properties
RepeatingTransactionsResponseBody
object
1 property
SplitTransactionRequest
object
4 properties 1 required
SplitTransactionRequestBody
object
1 property 1 required
SplitTransactionsResponseBody
object
1 property
MonthlyCashFlowResponse
object
7 properties
MonthlyCashFlowResponseBody
object
1 property
MonthlyCashFlowProfileRequest
object
2 properties
MonthlyCashFlowProfileRequestBody
object
1 property
MemberElements
object
3 properties
TokenRequestBody
object
1 property
TokenResponse
object
4 properties
TokenResponseBody
object
1 property
ProcessorAccountNumber
object
9 properties
ProcessorAccountNumberBody
object
1 property
PaymentAccount
object
9 properties
PaymentAccountBody
object
1 property
ProcessorOwner
object
9 properties
ProcessorOwnerBody
object
2 properties
MicrodepositResponse
object
7 properties
MicrodepositsResponseBody
object
2 properties
MicrodepositElements
object
7 properties 3 required
MicrodepositRequestBody
object
1 property
MicrodepositResponseBody
object
1 property
MicrodepositVerifyRequest
object
2 properties
MicrodepositVerifyRequestBody
object
1 property
RewardElements
object
8 properties
RewardsResponseBody
object
2 properties
RewardResponseBody
object
1 property
CreditCardProduct
object
14 properties
CreditCardProductResponse
object
1 property
VCResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mx-platform-api-openapi.yml Raw ↑

Other APIs MX publishes across the network.

MX Data Access
AE Profile APIs.io
MX Consent Management V4 API
AE Profile APIs.io
#Financial Data#Aggregation#Data Enhancement#Verification
← Back to M APIs
API Details
ID
mx:mx-platform-api
Base URL
https://api.mx.com
Docs
https://docs.mx.com/api-reference/platform-api/reference/mx-platform-api
Provider
MX
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mx-platform-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mx-platform-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of MX Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.