members

Read member status

Changed on

This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.

get/users/{user_guid}/members/{member_guid}/status

Request

  • Base URL
    https://int-api.mx.com
  • URL
    https://int-api.mx.com/users/{user_guid}/members/{member_guid}/status
  • Auth
    HTTP basic

Path parameters

member_guidstring required

The unique id for a member.

user_guidstring required

The unique identifier for a user, beginning with the prefix USR-.

Response

OK

Changes

  • c76801438c92Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • e74cd2b059b5Revision changes
    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • info

      api tag members added

    • info

      api tag mx_platform removed