{ "member": { "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "id": "unique_id", "metadata": "some metadata", "name": "MX Bank", "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "details": { "background_aggregation_is_disabled": false, "is_manual": false, "is_managed_by_user": false, "use_cases": [ "PFM" ] }, "institution": { "code": "mxbank", "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef", "iso_country_code": "US", "name": "MX Bank", "products": [ "account_verification", "identity_verification", "transactions", "transaction_history", "statements", "investments", "rewards" ], "self": "/institutions/INS-1572a04c-912b-59bf-5841-332c7dfafaef" }, "member_status": { "status": "CONNECTED", "error": { "error_type": "MEMBER", "error_code": "REQUEST_FAILED", "error_message": "There was an error attempting to process your request. The Member was created but we were unable to fulfill the data request.", "user_message": "We're having trouble connecting right now. Please try again later.", "locale": "en" }, "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status" }, "oauth": { "is_oauth": true, "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth/authorization_url", "authorization_url": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep" }, "user": { "guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c", "id": "unique_id", "metadata": "some metadata", "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c" }, "mx_record": { "created_at": "2025-05-10T18:08:00Z", "updated_at": "2026-02-12T22:48:21Z" } }}
{
"member": {
"guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
"id": "unique_id",
"metadata": "some metadata",
"name": "MX Bank",
"self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
"details": {
"background_aggregation_is_disabled": false,
"is_manual": false,
"is_managed_by_user": false,
"use_cases": [
"PFM"
]
},
"institution": {
"code": "mxbank",
"guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
"iso_country_code": "US",
"name": "MX Bank",
"products": [
"account_verification",
"identity_verification",
"transactions",
"transaction_history",
"statements",
"investments",
"rewards"
],
"self": "/institutions/INS-1572a04c-912b-59bf-5841-332c7dfafaef"
},
"member_status": {
"status": "CONNECTED",
"error": {
"error_type": "MEMBER",
"error_code": "REQUEST_FAILED",
"error_message": "There was an error attempting to process your request. The Member was created but we were unable to fulfill the data request.",
"user_message": "We're having trouble connecting right now. Please try again later.",
"locale": "en"
},
"self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status"
},
"oauth": {
"is_oauth": true,
"self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth/authorization_url",
"authorization_url": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep"
},
"user": {
"guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
"id": "unique_id",
"metadata": "some metadata",
"self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
},
"mx_record": {
"created_at": "2025-05-10T18:08:00Z",
"updated_at": "2026-02-12T22:48:21Z"
}
}
}
{
"member": {
"guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
"id": "unique_id",
"metadata": "some metadata",
"name": "MX Bank",
"self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
"details": {
"background_aggregation_is_disabled": false,
"is_manual": false,
"is_managed_by_user": false,
"use_cases": [
"PFM"
]
},
"institution": {
"code": "mxbank",
"guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
"iso_country_code": "US",
"name": "MX Bank",
"products": [
"account_verification",
"identity_verification",
"transactions",
"transaction_history",
"statements",
"investments",
"rewards"
],
"self": "/institutions/INS-1572a04c-912b-59bf-5841-332c7dfafaef"
},
"member_status": {
"status": "CONNECTED",
"error": {
"error_type": "MEMBER",
"error_code": "REQUEST_FAILED",
"error_message": "There was an error attempting to process your request. The Member was created but we were unable to fulfill the data request.",
"user_message": "We're having trouble connecting right now. Please try again later.",
"locale": "en"
},
"self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status"
},
"oauth": {
"is_oauth": true,
"self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth/authorization_url",
"authorization_url": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep"
},
"user": {
"guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
"id": "unique_id",
"metadata": "some metadata",
"self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
},
"mx_record": {
"created_at": "2025-05-10T18:08:00Z",
"updated_at": "2026-02-12T22:48:21Z"
}
}
}
Members
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.
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.
The language for localized text in the response, such as the widget and the member_status.error.user_message and member_status.error.error_message fields.
Indicates whether the member uses OAuth to authenticate. Defaults to false. When true, credentials aren't needed. The response's oauth.authorization_url is populated for institutions that support OAuth; pass the optional oauth object to configure it. An authorization URL works once, so if the end user doesn't complete OAuth, request a new one with Create OAuth Authorization URL.
The use case associated with the member. Valid values are PFM and/or MONEY_MOVEMENT. Only set this if you've met with MX and have opted in to using this field.
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.
The base fields for a member, which is a user's connection to an institution. Returned as the member companion on related resources such as accounts and transactions, and as the foundation of full member responses.
The use cases associated with the member. Valid values are PFM and/or MONEY_MOVEMENT. null when the member has no use cases (e.g. the feature is not enabled).
The base fields for a user. Returned as the user companion on related resources such as members, accounts, and transactions, and as the foundation of full user responses.
Timestamps for when MX created and last updated the record. Returned as the mx_record companion on all resources persisted by MX. These describe the MX record, not the underlying resource at the institution.