Overview

The MX SSO API is a RESTful API that is used by our Partners to create users, add and update user credentials, and obtain the SSO login URL to open MoneyDesktop when the user logs in.

The API uses JSON encoding in the body of POST and PUT requests. The Content-Type must be set to application/json in these requests.

Each Client, User, and Member needs a unique identifier, or GUID, to identify them in the MX API calls. The Client GUID is a value that will be agreed upon between MX and the Partner. User GUIDs and Member GUIDs are assigned by the Partner in the User create and Member create SSO API requests. Although MX will assign it's own GUID to each object for internal use, Partners should use their own GUIDs for these elements and avoid saving or storing the MX internal GUIDs.

All GUIDs assigned by the partner are known as external GUIDs in the API calls and will contain the word external in the parameter name (eg: external_member_guid). The Guide shows examples of the use of these external GUIDs. The guide is the best place to start to see an overview of the API with simple, concrete examples.

note

This documentation makes multiple references to "MoneyDesktop," which is the previous name for the MX product currently branded as Personal Finance Management (PFM).