members

Create member

Changed on

This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the /institutions/{institution_code}/credentials endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.

post/users/{user_guid}/members

Request

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

Path parameters

user_guidstring required

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

Headers

X-CALLBACK-PAYLOADstring

The base64 encoded string defined in this header will be returned in the Member and Member Data Updated webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.

Request body

client_redirect_urlstring
enable_app2appboolean

This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to true. When set to false, any oauth_window_uri generated will not direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions.

referral_sourcestring
ui_message_webview_url_schemestring

Example request

{
  "client_redirect_url": "https://{yoursite.com}",
  "member": {
    "credentials": [
      {
        "guid": "CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f",
        "value": "password"
      }
    ],
    "id": "unique_id",
    "institution_code": "mxbank",
    "metadata": "\\\"credentials_last_refreshed_at\\\": \\\"2015-10-15\\",
    "use_cases": [
      "PFM"
    ]
  },
  "referral_source": "APP"
}

Response

OK

Changes

  • 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

    • info

      added the new optional header request parameter X-CALLBACK-PAYLOAD

    • info

      added the new optional request property /

  • b904662f5441Revision changes
    • breaking

      the / response's property type changed from string to integer for status

    • breaking

      the / response's property type changed from string to integer for status

    • breaking

      the / response's property type changed from string to boolean for status

    • breaking

      the / response's property type changed from string to boolean for status

    • warning

      added the new MONEY_MOVEMENT enum value to the // response property for the response status

    • warning

      added the new MONEY_MOVEMENT enum value to the // response property for the response status

    • warning

      added the new PFM enum value to the // response property for the response status

    • warning

      added the new PFM enum value to the // response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status