Skip to main content

Passthrough Create

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

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

Use this endpoint to:

  • Invoke MX Platform POST APIs to create users, members, accounts, transactions, budgets, categories, goals, taggings, transaction rules, widgets, microdeposits, and jobs (for example, creating a user or adding a member connection for aggregation).
  • Provision MX users and dependent resources to support connect, aggregation, and personalized financial experiences across external institutions.
  • Create dependent resources in the required orchestration order (for example, create a user before members, then create accounts and transactions after institution connection and aggregation, as documented by MX).
  • Submit JSON request bodies with Content-Type: application/json, Accept: application/json, and Accept-Version: v20250224 (or v20111101 for legacy endpoints), or application/vnd.mx.api.v1+json when specified for the target operation.
  • Access MX Platform 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; 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, 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 Platform endpoint. Refer to the MX Platform APIs v20250224 and MX Platform APIs v20111101 documentation for supported schemas and examples.