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

Field	Required	Type
user_guid The unique identifier for a user, beginning with the prefix USR-.	Required	String

Header Parameters

Field	Required	Type
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 with optional parameters (id and metadata) and required parameters (credentials and institution_code)

Field	Required	Type
client_redirect_url	Optional	String
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	Optional	String

Loading...