API Evangelist conversational phrasing for Mx Technologies Members API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mx Technologies Members API
  version: 1.0.0
extends: openapi/mx-technologies-members-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 26
- target: $.paths['/users/{user_guid}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's connected members by MX GUID
      effect: read
      questions:
      - 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?
      instructions:
      - text: List every member for MX user GUID {user}.
        slots:
          user: path.user_guid
      - text: Show the {use_case} members connected by user GUID {user}, {per_page} per page.
        slots:
          use_case: query.use_case
          user: path.user_guid
          per_page: query.records_per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a user to an institution by GUID
      effect: write
      questions:
      - 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?
      instructions:
      - text: 'Create a new member for user GUID {user} with these institution credentials: {member}.'
        slots:
          user: path.user_guid
          member: requestBody.member
      - text: Add a bank connection for MX user GUID {user} and send them back to {redirect_url} after OAuth.
        slots:
          user: path.user_guid
          redirect_url: requestBody.client_redirect_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one member by its MX GUID
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get member GUID {member} belonging to user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Show me the attributes of member GUID {member} for MX user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a member's credentials by GUID
      effect: write
      questions:
      - 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?
      instructions:
      - text: Update member GUID {member} for user GUID {user} with {member_fields}.
        slots:
          member: path.member_guid
          user: path.user_guid
          member_fields: requestBody.member
      - text: Replace the metadata on member GUID {member} of MX user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a member by GUID
      effect: destructive
      questions:
      - 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?
      instructions:
      - text: Delete member GUID {member} from user GUID {user} permanently.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Remove the bank connection with member GUID {member} under MX user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a member's accounts and transactions by GUID
      effect: write
      questions:
      - 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?
      instructions:
      - text: Start an aggregation for member GUID {member} of user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: 'Refresh member GUID {member} for MX user {user} and include holdings: {include_holdings}.'
        slots:
          member: path.member_guid
          user: path.user_guid
          include_holdings: query.include_holdings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/challenges'].get
  update:
    x-apievangelist-phrasing:
      intent: List MFA challenges for a member by GUID
      effect: read
      questions:
      - 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?
      instructions:
      - text: List the MFA challenges pending on member GUID {member} for user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Show which security questions member GUID {member} of MX user {user} must answer.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/check_balance'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh only balances for a member by GUID
      effect: write
      questions:
      - 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?
      instructions:
      - text: Check balances only for member GUID {member} of user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Run a balance check without transactions on MX member {member} under user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's saved login fields by GUID
      effect: read
      questions:
      - 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?
      instructions:
      - text: List the saved credentials on member GUID {member} for user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Show the login fields stored for MX member {member} under user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/identify'].post
  update:
    x-apievangelist-phrasing:
      intent: Start account-owner identification by GUID
      effect: write
      questions:
      - 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?
      instructions:
      - text: Start identification on member GUID {member} of user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Run an account owner identify job for MX member {member} under user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/resume'].put
  update:
    x-apievangelist-phrasing:
      intent: Answer MFA challenges to resume a GUID member
      effect: write
      questions:
      - 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?
      instructions:
      - text: 'Resume aggregation for member GUID {member} of user GUID {user} with these challenge answers: {answers}.'
        slots:
          member: path.member_guid
          user: path.user_guid
          answers: requestBody.member
      - text: Submit the MFA responses for MX member {member} under user {user} and continue.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a member's latest aggregation status by GUID
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get the connection status of member GUID {member} for user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Check whether MX member {member} under user {user} finished its last aggregation.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/members/{member_guid}/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Start account verification by GUID
      effect: write
      questions:
      - 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?
      instructions:
      - text: Start verification on member GUID {member} of user GUID {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      - text: Run account verification for MX member {member} under user {user}.
        slots:
          member: path.member_guid
          user: path.user_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's members on the versioned API
      effect: read
      questions:
      - 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?
      instructions:
      - text: List members for user {user} on API version {api_version}.
        slots:
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Show the {use_case} connections for my user ID {user}.
        slots:
          use_case: query.use_case
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a user to an institution (versioned)
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a member for user {user} with {member} and data request {data_request}.
        slots:
          user: path.user_identifier
          member: requestBody.member
          data_request: requestBody.data_request
      - text: Add a new institution connection for my user ID {user} using API version {api_version}.
        slots:
          user: path.user_identifier
          api_version: header.Accept-Version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a member using your own IDs (versioned)
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get member {member} of user {user} on API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Look up my member ID {member} for my user ID {user}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a member's credentials (versioned)
      effect: write
      questions:
      - 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?
      instructions:
      - text: Update member {member} of user {user} with {member_fields}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          member_fields: requestBody.member
      - text: Change the credentials on my member ID {member} for user ID {user} using API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a member (versioned)
      effect: destructive
      questions:
      - How do I remove a bank connection referenced by the member ID I defined?
      - Does the versioned delete call wipe the member for good?
      instructions:
      - text: Delete member {member} of user {user} on API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Permanently remove my member ID {member} from user ID {user}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a member's data (versioned)
      effect: write
      questions:
      - 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?
      instructions:
      - text: Aggregate member {member} of user {user} on API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Pull the latest data for my member ID {member} under user ID {user}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/challenges'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's MFA challenges (versioned)
      effect: read
      questions:
      - Which MFA prompts are blocking a member referenced by my own member ID?
      - Can I page through pending security challenges on the versioned API?
      instructions:
      - text: List MFA challenges for member {member} of user {user} on API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Show the challenge questions waiting on my member ID {member} for user ID {user}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/check_balance'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh only a member's balances (versioned)
      effect: write
      questions:
      - 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?
      instructions:
      - text: Check balances for member {member} of user {user} on API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Update only balances for my member ID {member} under user ID {user}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's credential fields (versioned)
      effect: read
      questions:
      - 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?
      instructions:
      - text: List credentials for member {member} of user {user} on API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Show saved login fields for my member ID {member} under user ID {user}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/identify'].post
  update:
    x-apievangelist-phrasing:
      intent: Start identification on a member (versioned)
      effect: write
      questions:
      - 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?
      instructions:
      - text: Identify member {member} of user {user} on API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Start owner identification for my member ID {member} under user ID {user}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/resume'].put
  update:
    x-apievangelist-phrasing:
      intent: Answer MFA to resume a member (versioned)
      effect: write
      questions:
      - 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?
      instructions:
      - text: Resume member {member} of user {user} with challenge answers {answers}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          answers: requestBody.member
      - text: Submit MFA responses for my member ID {member} under user ID {user} using API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a member's aggregation status (versioned)
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get the status of member {member} of user {user} on API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Check how the last aggregation went for my member ID {member} under user ID {user}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_identifier}/members/{member_identifier}/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Start account verification (versioned)
      effect: write
      questions:
      - 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?
      instructions:
      - text: Verify member {member} of user {user} on API version {api_version}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
          api_version: header.Accept-Version
      - text: Start account verification for my member ID {member} under user ID {user}.
        slots:
          member: path.member_identifier
          user: path.user_identifier
      method: generated
      generated: '2026-09-26'