# MX Documentation: API Reference > Developer documentation for the MX platform. Covers connecting users to their financial institutions and retrieving enhanced account, transaction, and verification data with the Platform API and Connect Widget; Financial Insights, Personal Finance Management (PFM), and mobile banking experiences; and data products including Data Access, Customer Analytics, and Audiences. ## API Reference - [API Reference / Platform API (604 pages)](https://docs.mx.com/_llms/api-reference/platform-api.txt): Documentation for API Reference / Platform API. - [API Reference / Nexus (149 pages)](https://docs.mx.com/_llms/api-reference/nexus.txt): Documentation for API Reference / Nexus. ### Batch #### ##### Overview - [Batch API Overview](https://docs.mx.com/api-reference/more-apis/batch-api/index.md): The Batch API allows you to upload held account data records in properly formatted and encrypted CSV files via SFTP. MX can provide a response file for each batch file submitted. - [Response Files](https://docs.mx.com/api-reference/more-apis/batch-api/response-files.md) ##### File Contents - [File Contents](https://docs.mx.com/api-reference/more-apis/batch-api/file-contents/index.md) - [Account](https://docs.mx.com/api-reference/more-apis/batch-api/file-contents/account-file-contents.md): The account file should contain only accounts belonging to the member objects contained in the Member File. - [Member](https://docs.mx.com/api-reference/more-apis/batch-api/file-contents/member-file-contents.md): Members represent the connection between a user and a financial institution. - [Transactions](https://docs.mx.com/api-reference/more-apis/batch-api/file-contents/transactions-file-contents.md) - [User](https://docs.mx.com/api-reference/more-apis/batch-api/file-contents/user-file-contents.md) ### MDX Real Time and On Demand #### ##### Overview - [MDX Overview](https://docs.mx.com/api-reference/more-apis/mdx/index.md) ##### MDX Real Time - [MDX Real Time](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/index.md) ###### Account Numbers - [Account Number Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/account-numbers/account-number-fields.md): Account number fields for the MDX Real Time API. - [Create or Update Account Number](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/account-numbers/create-update-account-number.md): Use this endpoint to set the full account number, routing number, transit numbers, and banking institution for an account as needed. - [Delete Account Number](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/account-numbers/delete-account-number.md): Use this endpoint to delete an account number. - [Read Account Number](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/account-numbers/read-account-number.md): Use this endpoint to read an account number. ###### Accounts - [Account Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/accounts/account-fields.md): Account fields for the MDX Real Time API. - [Create Account](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/accounts/create-account.md): Use this endpoint to create an account. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. - [Delete Account](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/accounts/delete_account.md): Use this endpoint to delete an account. Deleting an account will automatically delete all transactions associated with that account. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. - [Read Account](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/accounts/read-account.md): Use this endpoint to read an account. - [Remap Account ID](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/accounts/remap-account-id.md): Use this endpoint to remap the ID assigned to the account. - [Update Account](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/accounts/update-account.md): Use this endpoint to update an account. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. ###### Holdings - [Holding Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/holdings/holding-fields.md): Holding fields for the MDX Real Time API. - [Create Holding](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/holdings/create-holding.md): Use this endpoint to create a holding. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. - [Delete Holding](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/holdings/delete-holding.md): Use this endpoint to delete a holding. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. - [Read Holding](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/holdings/read-holding.md): Use this endpoint to read a holding. - [Update Holding](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/holdings/update-holding.md): Use this endpoint to update a holding. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. ###### Members - [Member Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/members/member-fields.md): Member fields for the MDX Real Time API. - [Create Member](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/members/create-member.md): Use this endpoint to create a member. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. Credentials (userkey, or login/password) will be required if you support the On Demand protocol; they should be supplied in the create member request. On Demand requests will fail without valid credent… - [Delete Member](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/members/delete-member.md): Use this endpoint to delete a member. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. - [Read Member](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/members/read-member.md): Use this endpoint to read a member. - [Remap Member ID](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/members/remap-member-id.md): Use this endpoint to remap the ID assigned to the member. - [Update Member](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/members/update-member.md): Use this endpoint to update a member. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. ###### Transactions - [Transaction Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/transactions/transaction-fields.md): Field definitions for the MDX Real Time transaction data model. - [Create Transaction](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/transactions/create-transaction.md): Use this endpoint to create a transaction. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. It is recommended that partners only send dates in one format, using either the `_on` or `_at` fields, but not both. - [Delete Transaction](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/transactions/delete-transaction.md): Use this endpoint to delete a transaction. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. - [Read Transaction](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/transactions/read-transaction.md): Use this endpoint to read a transaction. - [Remap Transaction ID](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/transactions/remap-transaction-id.md): Use this endpoint to remap the ID assigned to the transaction. - [Update Transaction](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/transactions/update-transaction.md): Use this endpoint to update a transaction. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. ###### Users - [User Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/users/user-fields.md): Field definitions for the MDX Real Time user data model. - [Create User](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/users/create-user.md): Use this endpoint to create a user. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. - [Delete user](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/users/delete-user.md) - [Read User](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/users/read-user.md): Use this endpoint to read a user. - [Remap User ID](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/users/remap-user-id.md): This endpoint allows partners to re-assign their partner-defined user ID. - [Update User](https://docs.mx.com/api-reference/more-apis/mdx/mdx-real-time/reference/users/update-user.md): Use this endpoint to update a user. This endpoint accepts the optional `MX-SKIP-WEBHOOK` header. ##### MDX On Demand - [MDX On Demand](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/index.md) ###### Account Numbers - [Account Number Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/account-numbers/account-number-fields.md): Account number fields for the MDX On Demand API. - [List Account Numbers](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/account-numbers/list-account-numbers.md): This endpoint should return a list of account numbers. ###### Account Owners - [Account Owner Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/account-owners/account-owner-fields.md): Account owner fields for the MDX On Demand API. - [List Account Owners](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/account-owners/list-account-owners.md): This endpoint should return a list of account owners. ###### Accounts - [Account Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/accounts/account-fields.md): Account fields for the MDX On Demand API. - [List Accounts](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/accounts/list-accounts.md): Use this endpoint to list all accounts for a user. ###### Holdings - [Holding Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/holdings/holding-fields.md): Holding fields for the MDX On Demand API. - [List Holdings](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/holdings/list-holdings.md): Holdings are retrieved by making a GET request to /accounts/holdings. ###### Members - [Member Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/members/member-fields.md): Member fields for the MDX On Demand API. ###### Sessions - [Sessions Overview](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/sessions/sessions-overview.md): Overview of sessions for the MDX On Demand API. - [Create Session](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/sessions/create-session.md): This endpoint creates a new session. - [Update Session](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/sessions/update-session.md): When an MFA challenge is needed, the partner responds to the initial create session request with one of the available MFA challenge responses. MX will collect the answers and provide them to the partner by making a PUT /sessions request. ###### Transactions - [Transaction Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/transactions/transaction_fields.md): Transaction fields for the MDX On Demand API. - [List Transactions](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/transactions/list-transactions.md): This endpoint should return a list of transactions. ###### Users - [User Fields](https://docs.mx.com/api-reference/more-apis/mdx/mdx-on-demand/reference/users/user-fields.md): User fields for the MDX On Demand API. ### SSO #### v3 ##### ###### Overview - [Overview](https://docs.mx.com/api-reference/sso/v3/index.md) - [API Requirements](https://docs.mx.com/api-reference/sso/v3/api-requirements.md) ###### API Token - [Get API Token](https://docs.mx.com/api-reference/sso/v3/reference/api-token/get-api-token.md): This endpoint returns an api_token to open a Nexus session. ###### Users - [Delete User Session](https://docs.mx.com/api-reference/sso/v3/reference/users/delete-user-session.md): This endpoint closes all open sessions for a user. ###### Widget URLs - [Configuration Options](https://docs.mx.com/api-reference/sso/v3/reference/widget-urls/config-options.md) - [Connect Widget Configuration Scenarios](https://docs.mx.com/api-reference/sso/v3/reference/widget-urls/connect-widget-config-scenarios.md): The following shows several scenarios which partners may wish to present to end users, along with the correct configuration settings for each situation. - [Language Options](https://docs.mx.com/api-reference/sso/v3/reference/widget-urls/language-options.md) - [Widget Types](https://docs.mx.com/api-reference/sso/v3/reference/widget-urls/widget-types.md) - [Get SSO Login URL](https://docs.mx.com/api-reference/sso/v3/reference/widget-urls/get-sso-login-url.md): This endpoint returns an api_token to open a Nexus session - [Get Widget URL With Configuration Options](https://docs.mx.com/api-reference/sso/v3/reference/widget-urls/get-widget-with-config-options.md): This endpoint returns a widget URL with configuration options. - [Get Widget URL Without Configuration Options](https://docs.mx.com/api-reference/sso/v3/reference/widget-urls/get-widgets-without-config-options.md): This endpoint returns a widget URL without configuration options. #### v2 ##### ###### Overview - [Overview](https://docs.mx.com/api-reference/sso/v2/index.md): The MX SSO API is a RESTful API that is used by our Partners to create users, add and update user credentials, and obtain the SSO login URL to open MoneyDesktop when the user logs in. - [Guide](https://docs.mx.com/api-reference/sso/v2/guide.md) - [API Requirements](https://docs.mx.com/api-reference/sso/v2/accessing.md): Partners can gain access to the SSO API by receiving an API Key and having their IP Addresses white-listed on the system. - [Definitions](https://docs.mx.com/api-reference/sso/v2/definitions.md) - [Considerations](https://docs.mx.com/api-reference/sso/v2/considerations.md) - [Errors](https://docs.mx.com/api-reference/sso/v2/errors.md): Errors are returned as a JSON Error object. ###### Members - [Create member](https://docs.mx.com/api-reference/sso/v2/reference/members/create-member.md): Use this endpoint to create a new member. - [Read Member](https://docs.mx.com/api-reference/sso/v2/reference/members/read-member.md): Use this endpoint to read a member. - [Update Member](https://docs.mx.com/api-reference/sso/v2/reference/members/update-member.md): Use this endpoint to update a member. - [Delete Member](https://docs.mx.com/api-reference/sso/v2/reference/members/delete-member.md): Use this endpoint to delete a member. - [Delete Account](https://docs.mx.com/api-reference/sso/v2/reference/members/delete-account.md) ###### Users - [Create User](https://docs.mx.com/api-reference/sso/v2/reference/users/create-user.md): Use this endpoint to create a new user. - [Read User](https://docs.mx.com/api-reference/sso/v2/reference/users/read-user.md): Use this endpoint to read a user. - [Update user](https://docs.mx.com/api-reference/sso/v2/reference/users/update-user.md) - [Delete User](https://docs.mx.com/api-reference/sso/v2/reference/users/delete-user.md): Use this endpoint to delete a user. ### Reporting #### ##### Overview - [Reporting API Overview](https://docs.mx.com/api-reference/more-apis/reporting/index.md) - [API Requirements](https://docs.mx.com/api-reference/more-apis/reporting/requirements.md): Accept headers, authentication, base URLs, and schema evolution for the Reporting API. - [SFTP Delivery](https://docs.mx.com/api-reference/more-apis/reporting/sftp-delivery.md): Optionally have MX deliver your daily reporting files to an SFTP server. - [Snapshots](https://docs.mx.com/api-reference/more-apis/reporting/snapshots.md): The Reporting API does not provide a full snapshot of historical data, but a one-time data snapshot can be generated for an additional cost. - [Using the Reporting API](https://docs.mx.com/api-reference/more-apis/reporting/using-the-api.md): Best practices for consuming and staging Reporting API data in your system. - [Sample Files](https://docs.mx.com/api-reference/more-apis/reporting/sample-files.md): Sample Avro files generated from the Reporting API. ##### Data Specifications - [Base Resources](https://docs.mx.com/api-reference/more-apis/reporting/data-specifications/base-resources.md): Data field specifications for all base Reporting API resources. - [Analytics Events](https://docs.mx.com/api-reference/more-apis/reporting/data-specifications/analytics-events.md) - [Discovered Accounts](https://docs.mx.com/api-reference/more-apis/reporting/data-specifications/discovered-accounts.md): Data field specifications for the Discovered Accounts and Discovered Transactions resources. - [User Communications](https://docs.mx.com/api-reference/more-apis/reporting/data-specifications/user-communications.md) ##### Reference ###### Daily Files - [List Daily Files](https://docs.mx.com/api-reference/more-apis/reporting/reference/daily-files/list-daily-files.md): This endpoint returns a list of daily files. - [Download Daily Files](https://docs.mx.com/api-reference/more-apis/reporting/reference/daily-files/download-daily-files.md): This endpoint downloads a daily reporting file for a specific resource, date, and action. ###### Snapshots - [List Snapshot File URLs](https://docs.mx.com/api-reference/more-apis/reporting/reference/snapshots/list-snapshot-file-urls.md): This endpoint returns a JSON array of snapshot file URLs. - [Download Snapshots](https://docs.mx.com/api-reference/more-apis/reporting/reference/snapshots/download-snapshots.md): The URLs returned in the list snapshot file URLs endpoint should be used to download each file individually. ### Consent Management #### ##### Overview - [Customer Consent Management Dashboard API](https://docs.mx.com/api-reference/consent-management/overview/index.md): Integrate the consumer consent management dashboard into your UX. ##### Tokens - [Request Token](https://docs.mx.com/api-reference/consent-management/reference/01-request-token.md) - [Revoke Token](https://docs.mx.com/api-reference/consent-management/reference/02-revoke-token.md): Revokes token. Using the current token in the path, this endpoint updates the revoked_at field and revokes the token. - [Rotate Credentials](https://docs.mx.com/api-reference/consent-management/reference/03-rotate-credentials.md) ##### Consent Management - [Consent list](https://docs.mx.com/api-reference/consent-management/reference/3-consent-list.md) - [Update Auto Access](https://docs.mx.com/api-reference/consent-management/reference/auto-access-update.md): Set a consented app's auto update status. Use this endpoint to allow or disallow an app to automatically add new accounts to an end user's consent. This sets the consent object's `auto_enable_future_accounts` field to true or false. - [Update Consented Account](https://docs.mx.com/api-reference/consent-management/reference/account-enabled-status.md): Updates a consent by enabling or disabling an account. Use this endpoint when an end user wants to change whether or not an account is shared with an app. - [Revoke Consent](https://docs.mx.com/api-reference/consent-management/reference/revoke-consent.md) ## OpenAPI Specs - [v20260929](/openapi/platform-api/v20260929.yaml) - [v20250224](/openapi/platform-api/v20250224.yaml) - [v20111101](/openapi/platform-api/v20111101.yaml) - [v1](/openapi/nexus/v1.yaml) - [v4](/openapi/consent-management/v4.yaml)