Create member

This endpoint allows you to create a new member using the required parameters institution_code, credentials (if creating a non-OAuth member), and data_request.products. When creating a non-OAuth member, 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.

Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data. OAuth members will not begin aggregation until the user completes authorization; aggregation initiates automatically after the OAuth flow is completed.

Response status codes:
- 200 - Member created, no aggregation job initiated.
- 201 - Member created, but one or more products in data_request failed.
- 202 - Member created, aggregation requested. Does not indicate aggregation success or failure.

POST

/users/{user_identifier}/members

Path Parameters

Field	Required	Type
user_identifier Use either the user id you defined or the MX-defined user guid. See MX-Defined GUIDs vs IDs Defined by You​.	Required	String

Header Parameters

Field	Required	Type
Accept-Version MX Platform API version.	Required	String
X-CALLBACK-PAYLOAD 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.	Optional	String

Request Body

Member object to be created

Field	Required	Type
client_redirect_url This determines the redirect destination at the end of OAuth when used with is_mobile_webview: true or oauth_referral_source: 'APP'.	Optional	String
data_request Contains a products array that specifies the products you want to aggregate.	Optional	Object
enable_app2app 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.	Optional	Boolean
member	Optional	Object
referral_source	Optional	String
ui_message_webview_url_scheme A client-defined scheme used in OAuth redirects in WebViews. Defaults to mx.	Optional	String

Loading...