MXmx
members

Resume aggregation

Best practice is to use the resume endpoint to answer MFA challenges; however, MX continues to support partners who leverage the update member endpoint for this purpose. This endpoint allows you to respond to multi-factor authentication by providing answers to MFA challenges. Aggregation is automatically resumed if the correct credentials are provided in the request, i.e., if the challenges are answered correctly. A member must have a connection_status of CHALLENGED in order to successfully use the resume aggregation endpoint; a 405 Method Not Allowed error will be returned otherwise. A 400 Bad Request error will be returned if the credentials provided are invalid.

put/members/{member_guid}/resume

Request

  • Base URL
    http://{baseurl}
  • URL
    http://{baseurl}/members/{member_guid}/resume
  • Auth
    HTTP basic

Path parameters

member_guidstring required

The unique identifier for the member. Defined by MX.

Request body

Example request

[
  {
    "challenges": [
      {
        "guid": "institution-credential-guid",
        "value": "user-entered-value"
      }
    ]
  }
]

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.