Users

MX Users APIs expose MX user resources via the gateway: list users and get a user by institution and user ID for MX Platform and MoneyDesktop / SSO flows.

Supported APIs: MX Platform API (user management; institutional ID and API key patterns per MX), SSO API (authentication and widget URL flows work with user context), and alignment with MDX user/member data concepts.

For the latest reference, see MX Documentation.

End-user benefits

• Single view of user profile and status for MX-linked experiences.
• Seamless SSO across Nexus and MoneyMap-style integrations when combined with widget URLs.

Integration capabilities

• List MX users with Accept: application/vnd.mx.api.v1+json.
• Get user by ID with Accept: application/vnd.moneydesktop.sso.v3+json or XML; optional Accept-Version (e.g. v20250224).
• OAuth2 bearer tokens, ext_host routing, and correlationId for tracing.

Required headers

Header	Description
Authorization	Bearer token (OAuth2 authentication)
ext_host	Target MX host for request routing
correlationId	UUID for request tracing
Accept	Required; use MX vendor media types for list vs SSO user responses

Error codes

HTTP Status Code	Message
400	Bad Request. Typical JSON fields: error, message, optional errors[]
401	Unauthorized. Typical JSON fields: error, message
403	Forbidden (e.g. list users). Typical JSON fields: error, message
404	Not Found (e.g. unknown user). Typical JSON fields: error, message

Endpoints

Get MX User by ID

Retrieves an MX user resource for a given institution and user

List MX Users

Retrieves a paginated list of MX users. Required headers: Accept: