MX Technologies Members API
The members API from MX Technologies — 20 operation(s) for members.
Operations 26
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which financial institution connections does a user have, looked up by their MX user GUID?”
“Can I filter a user's members to only money-movement or PFM use cases on the GUID-based endpoint?”
Tell an agent
List every member for MX user GUID {user}.
Show the {use_case} members connected by user GUID {user}, {per_page} per page.
Ask an LLM
“How do I connect a user's bank login to MX when I only have their MX user GUID?”
“What do I need to send to create a new member with credentials and an institution code on the GUID path?”
Tell an agent
Create a new member for user GUID {user} with these institution credentials: {member}.
Add a bank connection for MX user GUID {user} and send them back to {redirect_url} after OAuth.
DELETE
/users/{user_guid}/members/{member_guid}
Permanently delete a member by GUID · Delete member
#
Ask an LLM
“How do I disconnect and remove a user's bank connection when I only have MX GUIDs?”
“Is deleting a member by its GUID permanent?”
Tell an agent destructive · confirm first
Delete member GUID {member} from user GUID {user} permanently.
Remove the bank connection with member GUID {member} under MX user {user}.
Ask an LLM
“What are the details of a specific member when I have both the user and member GUIDs?”
“Can I see which institution a member GUID is connected to and when it last aggregated?”
Tell an agent
Get member GUID {member} belonging to user GUID {user}.
Show me the attributes of member GUID {member} for MX user {user}.
PUT
/users/{user_guid}/members/{member_guid}
Update a member's credentials by GUID · Update member
#
Ask an LLM
“How do I change the saved login credentials on an existing member using its GUID?”
“Which member fields can be edited on the GUID-based endpoint besides credentials?”
Tell an agent
Update member GUID {member} for user GUID {user} with {member_fields}.
Replace the metadata on member GUID {member} of MX user {user}.
POST
/users/{user_guid}/members/{member_guid}/aggregate
Refresh a member's accounts and transactions by GUID · Aggregate member
#
Ask an LLM
“How do I pull the latest accounts and transactions for a member using its GUID?”
“Can I include investment holdings when I trigger an aggregation on the GUID-based endpoint?”
Tell an agent
Start an aggregation for member GUID {member} of user GUID {user}.
Refresh member GUID {member} for MX user {user} and include holdings: {include_holdings}.
GET
/users/{user_guid}/members/{member_guid}/challenges
List MFA challenges for a member by GUID · List member challenges
#
Ask an LLM
“What multi-factor questions does a member GUID need answered before aggregation can continue?”
“Where do I find the security challenges MX is waiting on for a GUID-identified member?”
Tell an agent
List the MFA challenges pending on member GUID {member} for user GUID {user}.
Show which security questions member GUID {member} of MX user {user} must answer.
POST
/users/{user_guid}/members/{member_guid}/check_balance
Refresh only balances for a member by GUID · Check balances
#
Ask an LLM
“Can I update just account balances for a member GUID without pulling transactions?”
“How do I run a balance-only check on a member identified by its MX GUID?”
Tell an agent
Check balances only for member GUID {member} of user GUID {user}.
Run a balance check without transactions on MX member {member} under user {user}.
GET
/users/{user_guid}/members/{member_guid}/credentials
List a member's saved login fields by GUID · List member credentials
#
Ask an LLM
“What non-MFA credential fields are stored on a member I know by GUID?”
“Can I see the username and password fields tied to an existing member GUID?”
Tell an agent
List the saved credentials on member GUID {member} for user GUID {user}.
Show the login fields stored for MX member {member} under user {user}.
POST
/users/{user_guid}/members/{member_guid}/identify
Start account-owner identification by GUID · Identify member
#
Ask an LLM
“How do I get account owner identity info for a member GUID that already exists?”
“Can I kick off an identification job on a member using the GUID-based path?”
Tell an agent
Start identification on member GUID {member} of user GUID {user}.
Run an account owner identify job for MX member {member} under user {user}.
PUT
/users/{user_guid}/members/{member_guid}/resume
Answer MFA challenges to resume a GUID member · Resume aggregation
#
Ask an LLM
“How do I submit MFA answers so a challenged member GUID can finish aggregating?”
“Once a user responds to a security question, how do I resume the member by GUID?”
Tell an agent
Resume aggregation for member GUID {member} of user GUID {user} with these challenge answers: {answers}.
Submit the MFA responses for MX member {member} under user {user} and continue.
GET
/users/{user_guid}/members/{member_guid}/status
Check a member's latest aggregation status by GUID · Read member status
#
Ask an LLM
“Did the most recent aggregation for a member GUID succeed, fail, or get challenged?”
“How can I tell what to do next after aggregating a member identified by GUID?”
Tell an agent
Get the connection status of member GUID {member} for user GUID {user}.
Check whether MX member {member} under user {user} finished its last aggregation.
POST
/users/{user_guid}/members/{member_guid}/verify
Start account verification by GUID · Verify member
#
Ask an LLM
“How do I retrieve account and routing numbers by starting verification on a member GUID?”
“Can I verify a member's accounts using only the MX user and member GUIDs?”
Tell an agent
Start verification on member GUID {member} of user GUID {user}.
Run account verification for MX member {member} under user {user}.
Ask an LLM
“Which bank connections does a user have if I look them up by the user ID I defined myself?”
“Can the versioned members list be narrowed to money-movement or PFM connections?”
Tell an agent
List members for user {user} on API version {api_version}.
Show the {use_case} connections for my user ID {user}.
POST
/users/{user_identifier}/members
Connect a user to an institution (versioned) · Create member
#
Ask an LLM
“How do I create a member with a data request for a user I identify by my own ID?”
“What goes in the body when adding a bank connection on the versioned members endpoint?”
Tell an agent
Create a member for user {user} with {member} and data request {data_request}.
Add a new institution connection for my user ID {user} using API version {api_version}.
DELETE
/users/{user_identifier}/members/{member_identifier}
Permanently delete a member (versioned) · Delete member
#
Ask an LLM
“How do I remove a bank connection referenced by the member ID I defined?”
“Does the versioned delete call wipe the member for good?”
Tell an agent destructive · confirm first
Delete member {member} of user {user} on API version {api_version}.
Permanently remove my member ID {member} from user ID {user}.
GET
/users/{user_identifier}/members/{member_identifier}
Read a member using your own IDs (versioned) · Read member
#
Ask an LLM
“Can I fetch a member by the ID I assigned instead of the MX GUID?”
“What does a single member record look like on the versioned API?”
Tell an agent
Get member {member} of user {user} on API version {api_version}.
Look up my member ID {member} for my user ID {user}.
PUT
/users/{user_identifier}/members/{member_identifier}
Update a member's credentials (versioned) · Update member
#
Ask an LLM
“How do I fix outdated login credentials on a member referenced by my own ID?”
“Can I change a member's id or metadata through the versioned update call?”
Tell an agent
Update member {member} of user {user} with {member_fields}.
Change the credentials on my member ID {member} for user ID {user} using API version {api_version}.
POST
/users/{user_identifier}/members/{member_identifier}/aggregate
Refresh a member's data (versioned) · Aggregate member
#
Ask an LLM
“How do I trigger fresh account and transaction data for a member I identify by my own ID?”
“Can I start an aggregation through the versioned API with an Accept-Version header?”
Tell an agent
Aggregate member {member} of user {user} on API version {api_version}.
Pull the latest data for my member ID {member} under user ID {user}.
GET
/users/{user_identifier}/members/{member_identifier}/challenges
List a member's MFA challenges (versioned) · List member challenges
#
Ask an LLM
“Which MFA prompts are blocking a member referenced by my own member ID?”
“Can I page through pending security challenges on the versioned API?”
Tell an agent
List MFA challenges for member {member} of user {user} on API version {api_version}.
Show the challenge questions waiting on my member ID {member} for user ID {user}.
POST
/users/{user_identifier}/members/{member_identifier}/check_balance
Refresh only a member's balances (versioned) · Check balances
#
Ask an LLM
“Is there a versioned call to update balances without gathering transactions?”
“How do I get fresh balances for a member I track under my own ID?”
Tell an agent
Check balances for member {member} of user {user} on API version {api_version}.
Update only balances for my member ID {member} under user ID {user}.
GET
/users/{user_identifier}/members/{member_identifier}/credentials
List a member's credential fields (versioned) · List member credentials
#
Ask an LLM
“What credentials are saved on a member when I reference it by my own ID?”
“Can I list non-MFA login fields for a member through the versioned API?”
Tell an agent
List credentials for member {member} of user {user} on API version {api_version}.
Show saved login fields for my member ID {member} under user ID {user}.
POST
/users/{user_identifier}/members/{member_identifier}/identify
Start identification on a member (versioned) · Identify member
#
Ask an LLM
“How do I begin identifying account owners for a member referenced by my own ID?”
“Is there a versioned endpoint to run identify on an existing member?”
Tell an agent
Identify member {member} of user {user} on API version {api_version}.
Start owner identification for my member ID {member} under user ID {user}.
PUT
/users/{user_identifier}/members/{member_identifier}/resume
Answer MFA to resume a member (versioned) · Resume aggregation
#
Ask an LLM
“How do I send a user's MFA answers for a member I track under my own ID?”
“Can the versioned API resume a member that is stuck on a challenge?”
Tell an agent
Resume member {member} of user {user} with challenge answers {answers}.
Submit MFA responses for my member ID {member} under user ID {user} using API version {api_version}.
GET
/users/{user_identifier}/members/{member_identifier}/status
Check a member's aggregation status (versioned) · Read member status
#
Ask an LLM
“What is the latest connection status of a member referenced by my own member ID?”
“Can the versioned API tell me if a member needs user action after aggregating?”
Tell an agent
Get the status of member {member} of user {user} on API version {api_version}.
Check how the last aggregation went for my member ID {member} under user ID {user}.
POST
/users/{user_identifier}/members/{member_identifier}/verify
Start account verification (versioned) · Verify member
#
Ask an LLM
“How do I verify account and routing numbers for a member identified by my own ID?”
“Is there a versioned call to begin verification on a member?”
Tell an agent
Verify member {member} of user {user} on API version {api_version}.
Start account verification for my member ID {member} under user ID {user}.