Skip to main content

Passthrough Read

Loading...
API endpoint path: /mx/{institutionId}/{mxSsoResourcePath}

Transparent passthrough for GET requests to the MX SSO APIs. The service provides a RESTful interface for authenticating users on the MX platform; endpoint paths, headers, query parameters, and response schemas are defined in the MX documentation.

Use this endpoint to:

  • Invoke MX SSO GET APIs to authenticate users on the MX platform—for example, retrieve a widget URL without configuration options or obtain a single-use api_token to open a Nexus API session. Response bodies support JSON or XML encoding via the Accept header and URL extension (.json or .xml).
  • Obtain widget URLs for MX Personal Finance Management (PFM) and Financial Insights experiences to authenticate users to MoneyMap components and embed those experiences in a webview or iframe without exposing long-lived credentials. Issued widget URLs and API tokens are single-use and expire after 10 minutes; request a new URL or token for each authentication or widget reload.
  • MX recommends the configurable widget URL endpoint because the list urls endpoint is slower, requires parsing multiple URLs from the response, and does not include newly released widgets.
  • Access MX SSO 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, injects MD-API-KEY for MX SSO routing, and removes Candescent-specific headers before forwarding the request to MX.
  • Proxies requests using the path /mx/{institutionId}/{mxSsoResourcePath}, where institutionId corresponds to the MX client_id (used in MX paths such as /{client_id}/...), must match the value in the OAuth V2 token, and is used when forwarding requests to MX.
  • 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 SSO endpoint. Refer to the MX SSO APIs documentation for supported schemas and examples.