Skip to main content

Passthrough Read

Loading...
API endpoint path: /mx/{mxPlatformResourcePath}

Transparent passthrough for GET requests to the MX Platform APIs v20250224 and MX Platform APIs v20111101. The service provides RESTful operations for users, members, institutions, accounts, transactions, statements, and related resources; endpoint paths, headers, query parameters, and response schemas are defined in the MX documentation.

Use this endpoint to:

  • Invoke MX Platform GET APIs to retrieve users, members, institutions, accounts, transactions, statements, budgets, categories, goals, insights, investment holdings, taggings, transaction rules, and widgets (for example, listing users or retrieving an account, member, or transaction by ID).
  • Access aggregated and enhanced financial data from external institutions connected through MX, including balances, transaction history, categorization, and account details to support connect, aggregation, and personalized financial experiences.
  • Request JSON response bodies using Accept: application/json with Accept-Version: v20250224 (or v20111101 for legacy endpoints), or application/vnd.mx.api.v1+json when specified for the target operation (for example, user list operations).
  • Access MX Platform read operations through the Candescent API Gateway instead of calling MX directly.

Behavior and capabilities:

  • The gateway validates the OAuth V2 bearer token, correlationId, and ext_host; replaces the Authorization header with MX Basic authentication, and removes Candescent-specific headers before forwarding the request to MX.
  • Proxies requests using the path /mx/{mxPlatformResourcePath}, where mxPlatformResourcePath corresponds to the MX Platform resource path as defined in the MX documentation.
  • Forwards all MX-supported headers, paths, and query parameters without modification.
  • Returns MX HTTP status codes and response payloads without modification.

Request​

Responses​

Response payload returned by the target MX Platform endpoint. Refer to the MX Platform APIs v20250224 and MX Platform APIs v20111101 documentation for supported schemas and examples.