Skip to main content

Passthrough Delete

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

Transparent passthrough for DELETE 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, and query parameters are defined in the MX documentation.

Use this endpoint to:

  • Invoke MX Platform DELETE APIs to remove users, members, accounts, transactions, budgets, categories, goals, taggings, transaction rules, and notifications (for example, deleting a user or removing a member connection).
  • Rely on MX cascading deletion v20250224 and v20111101: deleting a member removes its associated accounts, transactions, and holdings, while deleting a user removes all associated members and their dependent data.
  • Deprovision MX users and related data when no longer required for MX-powered digital experiences. Most deleted objects are soft-deleted and purged after a retention period, while user deletions are permanent and cannot be restored through the API.
  • Access MX Platform delete 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 without modification.

Request​

Responses​

No Content