Sign in
mx_platform

Create member

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

Path parameters

user_guidstring required

The unique id for a user.

Request body

client_redirect_urlstring
enable_app2appboolean
referral_sourcestring
ui_message_webview_url_schemestring

Example request

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

Response

Accepted

Changes