Platform

Platform APIs are exposed as a transparent passthrough to the MX Platform APIs v20250224 and MX Platform APIs v20111101 via the Candescent APIs Gateway. After OAuth V2 token validation and routing, the gateway forwards request headers, paths, query parameters, and payloads to MX and returns responses unchanged.

The MX Platform APIs are MX’s core REST interface for aggregating and enhancing financial data across institutions. It covers users, members, institutions, accounts, transactions, statements, and related resources as documented by MX.

For complete schemas and the full set of supported operations, see the MX Platform APIs v20250224 and MX Platform APIs v20111101 documentations.

End-user benefits

• Unified access to balances, transactions, and account context aggregated from external financial institutions.
• End-to-end MX user lifecycle support, including connect, aggregation, and personalized financial experiences.
• Data enhancement, including cleansing, categorization, and insights, provided through MX Platform pipeline.

Integration capabilities

• Transparent passthrough ensures that Platform headers, paths, query parameters, and payloads are forwarded to MX, and that HTTP status codes and responses are returned unchanged.
• Gateway controls are applied by Candescent, including OAuth V2 Bearer token validation, spike arrest, and quota enforcement, before requests are forwarded to MX.
• MX routing is configured by setting ext_host to the MX Platform host, such as api.mx.com (production) or int-api.mx.com (sandbox).
• Content negotiation is supported through MX vendor-specific Accept headers, such as application/vnd.mx.api.v1+json for user list operations. Include Accept-Version header when MX documents version negotiation for an endpoint.

Required headers

Header	Description
Authorization	Bearer {token} (OAuth V2)
correlationId	UUID used to trace and correlate requests across services for debugging and logging.
ext_host	MX Platform upstream host (for example, api.mx.com (production) or int-api.mx.com (sandbox)). Required for gateway routing; stripped before forwarding to MX.
Accept	MX vendor media type (for example, application/vnd.mx.api.v1+json). Required by MX; forwarded unchanged.
Content-Type	application/json. Required by MX for POST and PUT requests; forwarded unchanged.
Accept-Version	MX API version (for example, v20250224). Required by MX for version negotiation; forwarded unchanged.

Error codes

Candescent API Gateway

Code	Message	HTTP Status Code
CMN_90000	Internal server error	500
CMN_90001	Client not authorized to access this resource	401
CMN_90001	Quota limit violation	500
CMN_90002	Spike limit violation	500
CMN_90008	Header correlationId is invalid	400
CMN_90010	Header correlationId is required	400
CMN_90010	Header ext_host is required	400
CMN_90011	Invalid or unsupported ext_host	400
CMN_90018	Invalid token	400

MX Platform APIs

For detailed descriptions and error semantics, refer to the MX documentations:

• MX Platform APIs v20250224
• MX Platform APIs v20111101

Endpoints

Passthrough Read

Transparent passthrough for **GET** requests to the [MX Platform APIs v20250224](https://docs.mx.com/api-reference/platform-api/reference/mx-platform-api)

Passthrough Create

Transparent passthrough for **POST** requests to the [MX Platform APIs v20250224](https://docs.mx.com/api-reference/platform-api/reference/mx-platform-api)

Passthrough Update

Transparent passthrough for **PUT** requests to the [MX Platform APIs v20250224](https://docs.mx.com/api-reference/platform-api/reference/mx-platform-api)

Passthrough Delete

Transparent passthrough for **DELETE** requests to the [MX Platform APIs v20250224](https://docs.mx.com/api-reference/platform-api/reference/mx-platform-api)