MX Platform Members API
The Members API from MX Platform — 29 operation(s) for members.
OpenAPI Specification
openapi: 3.0.0
info:
contact:
name: MX Platform API
url: https://www.mx.com/products/platform-api
description: '
The MX Platform API is a powerful, fully-featured API designed to make
aggregating and enhancing financial data easy and reliable. It can
seamlessly connect your app or website to tens of thousands of financial
institutions.'
title: MX Platform Members API
version: 0.1.0
servers:
- url: https://api.mx.com
- url: https://int-api.mx.com
security:
- basicAuth: []
tags:
- name: Members
paths:
/users/{user_guid}/members:
get:
description: This endpoint returns an array which contains information on every member associated with a specific user.
operationId: listMembers
parameters:
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MembersResponseBody'
description: OK
summary: List members
tags:
- Members
post:
description: 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.
operationId: createMember
parameters:
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MemberCreateRequestBody'
description: Member object to be created with optional parameters (id and metadata) and required parameters (credentials and institution_code)
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: Accepted
summary: Create member
tags:
- Members
/users/{user_guid}/members/{member_guid}:
delete:
description: Accessing this endpoint will permanently delete a member.
operationId: deleteMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'204':
description: No Content
summary: Delete member
tags:
- Members
get:
description: Use this endpoint to read the attributes of a specific member.
operationId: readMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Read member
tags:
- Members
put:
description: Use this endpoint to update a members attributes. Only the credentials, id, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint.
operationId: updateMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MemberUpdateRequestBody'
description: Member object to be updated (While no single parameter is required, the request body can't be empty)
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Update member
tags:
- Members
/users/{user_guid}/members/{member_guid}/account_numbers:
get:
description: This endpoint returns a list of account numbers associated with the specified `member`.
operationId: listAccountNumbersByMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountNumbersResponseBody'
description: OK
summary: List account numbers by member
tags:
- Members
/users/{user_guid}/members/{member_guid}/account_owners:
get:
description: This endpoint returns an array with information about every account associated with a particular member.
operationId: listAccountOwnersByMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountOwnersResponseBody'
description: OK
summary: List account owners by member
tags:
- Members
/users/{user_guid}/members/{member_guid}/accounts:
get:
description: This endpoint returns a list of all the accounts associated with the specified `member`.
operationId: listMemberAccounts
parameters:
- description: List only accounts whose member is managed by the user.
example: true
in: query
name: member_is_managed_by_user
schema:
type: boolean
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountsResponseBody'
description: OK
summary: List accounts by member
tags:
- Members
/users/{user_guid}/members/{member_guid}/accounts/{account_guid}:
get:
description: This endpoint allows you to read the attributes of an `account` resource.
operationId: readAccountByMember
parameters:
- description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountResponseBody'
description: OK
summary: Read account by member
tags:
- Members
put:
description: This endpoint allows you to update certain attributes of an `account` resource, including manual accounts. For manual accounts, you can update every field listed. For aggregated accounts, you can only update `is_business`, `is_hidden` and `metadata`.
operationId: updateAccountByMember
parameters:
- description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountUpdateRequestBody'
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountResponseBody'
description: OK
summary: Update account by member
tags:
- Members
/users/{user_guid}/members/{member_guid}/aggregate:
post:
description: Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.
operationId: aggregateMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: Accepted
summary: Aggregate member
tags:
- Members
/users/{user_guid}/members/{member_guid}/challenges:
get:
description: Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of `CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of `CHALLENGED`, then code `200 OK` will be returned - along with the corresponding credentials.
operationId: listMemberChallenges
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/ChallengesResponseBody'
description: OK
summary: List member challenges
tags:
- Members
/users/{user_guid}/members/{member_guid}/check_balance:
post:
description: This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.
operationId: checkBalances
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: Accepted
summary: Check balances
tags:
- Members
/users/{user_guid}/members/{member_guid}/credentials:
get:
description: This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
operationId: listMemberCredentials
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/CredentialsResponseBody'
description: OK
summary: List member credentials
tags:
- Members
/users/{user_guid}/members/{member_guid}/extend_history:
post:
description: Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.
operationId: extendHistory
parameters:
- description: The unique identifier for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique identifier for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: Accepted
summary: Extend history
tags:
- Members
/users/{user_guid}/members/{member_guid}/fetch_rewards:
post:
description: Calling this endpoint initiates an aggregation-type event which will gather the member's rewards information, as well as account and transaction information. Rewards data is also gathered with daily background aggregations.
operationId: fetchRewards
parameters:
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
- description: The unique identifier for the member. Defined by MX.
example: MBR-fa7537f3-48aa-a683-a02a-b18345562f54
in: path
name: member_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Fetch Rewards
tags:
- Members
/users/{user_guid}/members/{member_guid}/fetch_statements:
post:
description: Use this endpoint to fetch the statements associated with a particular member.
operationId: fetchStatements
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: Accepted
summary: Fetch statements
tags:
- Members
/users/{user_guid}/members/{member_guid}/fetch_tax_documents:
post:
description: Use this endpoint to fetch (aggregate) the tax documents associated with the specified member. This request **does not** return the latest tax documents. It just starts the document aggregation process and returns the initial state of the process. You must interact with the newly aggregated data using the other document endpoints in this reference. This request may also trigger multi-factor authentication which requires end-user input and a specific process for answering authentication challenges.
operationId: fetchTaxDocuments
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: Accepted
summary: Fetch Tax Documents
tags:
- Members
/users/{user_guid}/members/{member_guid}/holdings:
get:
description: This endpoint returns all holdings associated with the specified `member` across all accounts.
operationId: listHoldingsByMember
parameters:
- description: Filter holdings from this date.
example: '2015-09-20'
in: query
name: from_date
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: Filter holdings to this date.
example: '2019-10-20'
in: query
name: to_date
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/HoldingsResponseBody'
description: OK
summary: List holdings by member
tags:
- Members
/users/{user_guid}/members/{member_guid}/identify:
post:
description: The identify endpoint begins an identification process for an already-existing member.
operationId: identifyMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: Accepted
summary: Identify member
tags:
- Members
/users/{user_guid}/members/{member_guid}/oauth_window_uri:
get:
description: This endpoint will generate an `oauth_window_uri` for the specified `member`.
operationId: requestOAuthWindowURI
parameters:
- description: A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`.
example: https://mx.com
in: query
name: client_redirect_url
schema:
type: string
- description: This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. This setting is not persistent.
example: false
in: query
name: enable_app2app
schema:
type: string
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
example: APP
in: query
name: referral_source
schema:
type: string
- description: Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
example: false
in: query
name: skip_aggregation
schema:
type: boolean
- description: A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`.
example: mx
in: query
name: ui_message_webview_url_scheme
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/OAuthWindowResponseBody'
description: OK
summary: Request oauth window uri
tags:
- Members
/users/{user_guid}/members/{member_guid}/resume:
put:
description: This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
operationId: resumeAggregation
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MemberResumeRequestBody'
description: Member object with MFA challenge answers
required: true
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: Accepted
summary: Resume aggregation
tags:
- Members
/users/{user_guid}/members/{member_guid}/rewards:
get:
description: Use this endpoint to list all the `rewards` associated with a specified `member`.
operationId: listRewards
parameters:
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
- description: The unique identifier for the member. Defined by MX.
example: MBR-fa7537f3-48aa-a683-a02a-b18345562f54
in: path
name: member_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/RewardsResponseBody'
description: OK
summary: List Rewards
tags:
- Members
/users/{user_guid}/members/{member_guid}/rewards/{reward_guid}:
get:
description: Use this endpoint to read a specific `reward` based on its unique GUID..
operationId: readRewards
parameters:
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
- description: The unique identifier for the member. Defined by MX.
example: MBR-fa7537f3-48aa-a683-a02a-b18345562f54
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique identifier for the rewards. Defined by MX.
example: RWD-fa7537f3-48aa-a683-a02a-b324322f54
in: path
name: reward_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/RewardResponseBody'
description: OK
summary: Read Reward
tags:
- Members
/users/{user_guid}/members/{member_guid}/statements:
get:
description: Use this endpoint to get an array of available statements.
operationId: listStatementsByMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: Specify current page.
example: 1
in: query
name: page
schema:
type: integer
- description: Specify records per page.
example: 10
in: query
name: records_per_page
schema:
type: integer
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/StatementsResponseBody'
description: OK
summary: List statements by member
tags:
- Members
/users/{user_guid}/members/{member_guid}/statements/{statement_guid}:
get:
description: Use this endpoint to read a JSON representation of the statement.
operationId: readStatementByMember
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
type: string
- description: The unique id for a `statement`.
example: STA-737a344b-caae-0f6e-1384-01f52e75dcb1
in: path
name: statement_guid
required: true
schema:
type: string
- description: The unique id for a `user`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/StatementResponseBody'
description: OK
summary: Read statement by member
tags:
- Members
/users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf:
get:
description: Use this endpoint to download a specified statement PDF.
operationId: downloadStatementPDF
parameters:
- description: The unique id for a `member`.
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
in: path
name: member_guid
required: true
schema:
# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mx-platform/refs/heads/main/openapi/mx-platform-members-api-openapi.yml