Skip to main content

Passthrough Create

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

Transparent passthrough for POST 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 request/response schemas are defined in the MX documentation.

Use this endpoint to:

  • Invoke MX SSO POST APIs to authenticate users on the MX platform—the primary use case is the get configurable widget URL endpoint, which MX recommends over the deprecated list urls endpoint (see GET) for both testing and production. Pass widget-specific configuration in the request body and set matching Accept and Content-Type headers (application/vnd.moneydesktop.sso.v3+json or application/vnd.moneydesktop.sso.v3+xml), along with a URL extension (.json or .xml) as required by the target endpoint.
  • Obtain embeddable widget URLs for MX Personal Finance Management (PFM), Financial Insights, and other supported widget types with per-request options such as deep_link_params, style, use_cases, or Connect Widget parameters. The configurable widget URL endpoint returns responses faster than list urls and always includes a url field; issued URLs are single-use and expire 10 minutes after creation.
  • Submit request payloads for other MX SSO create operations to authenticate users or provision SSO resources, as defined in the MX documentation.
  • Access MX SSO create 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 the 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, query parameters, and request payloads 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.