List members - MX Documentation

Authorizations

MD-SESSION-TOKEN

string

header

required

MX Session Token

Request an API token using the read API token endpoint in the MX SSO API.
Exchange an API token for a session token.
- A session token is obtained by sending a POST request to /sessions
- The session token will be used in each request made for the user. It should be passed in an MD-SESSION-TOKEN HTTP header as shown below.
- This session token is valid for 30 minutes from the time it was created. The 30 minute expiration counter is refreshed with each call.
- If you send a request with an expired session token you'll receive an error code of 4011.

curl -i https://int-data.moneydesktop.com/accounts \
-H 'MD-SESSION-TOKEN: CWforZl1Vn2vC_v6H4rnQRT1DoWpDouJAV-_5TBmiQRAtA8rsOG_BoajTiOSsL0A3bd-bmHXlA-eQzc9ywItKg' \
-H 'Content-Type: application/vnd.mx.nexus.v1+json' \
-H 'Accept: application/vnd.mx.nexus.v1+json'

In documentation code examples, replace <API_KEY_VALUE> with the session token.

Query Parameters

use_case

string

The use case associated with the member.

Response

200 - application/vnd.mx.nexus.v1+json

member

object

Hide child attributes

member.aggregated_at

string | null

The date and time the most recent aggregation-type job was started, given in ISO 8601 format with a time component. A job will automatically be started when a member is created or its credentials are updated, unless the skip_aggregation parameter is used. Jobs can also be started via manual aggregations, background aggregations, API endpoints, or when opening an MX widget. A job can be a normal aggregation, or a premium job such as identification, verification, fetching statements, or fetching an extended transaction history. If a member is deleted and then re-created with the skip_aggregation parameter set to true or if it is re-created within the throttle window (typically three hours), the previous value will be returned.

Example:

"2016-10-13T18:07:57.000Z"

member.background_aggregation_is_disabled

boolean

This field indicates whether background aggregation is disabled for the member.

Example:

false

member.connection_status

string | null

This field indicates the state of a member's aggregation, provided as a string.

Example:

"CONNECTED"

member.external_guid

any | null

Partner created identifier for the member. It must be unique for all members belonging to all users within the client.

Example:

null

member.guid

string | null

Unique identifier for the member. Defined by MX.

Example:

"MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"

member.institution_code

string | null

The code identifier for the institution.

Example:

"chase"

member.institution_guid

string

The unique identifier for the institution. Defined by MX.

Example:

"INS-1572a04c-912b-59bf-5841-332c7dfafaef"

member.is_being_aggregated

boolean | null

This field will be true if the member is being aggregated at the time of the request. Otherwise, this field will be false.

Example:

false

member.is_managed_by_user

boolean | null

If the member is managed by the user, this field will be true. Otherwise, the member is managed by the MX partner, and this field will be false. Members created with Nexus are considered to be managed by the user. This field should be used in place of is_user_created.

Example:

false

member.is_oauth

boolean | null

This indicates whether the member uses OAuth to authenticate the member. Defaults to false. authentication.

Example:

false

member.is_user_created

boolean

If the member is user created, this field will be true. Otherwise, this field will be false. Members created with Nexus are considered user created. You should use the field is_managed_by_user instead of this field as it is being deprecated.

Example:

true

member.most_recent_job_guid

string

Unique identifier for the most recent job. Defined by MX.

Example:

"JOB-d6bb804b-6d12-44f1-b0ad-403441c03372"

member.metadata

string | null

Additional information a partner can store on the member.

Example:

"\\\"credentials_last_refreshed_at\\\": \\\"2015-10-15\\\""

member.name

string | null

Name of the given member. If omitted in a member create request, the institution name within the MX Platform will be used.

Example:

"Chase Bank"

member.successfully_aggregated_at

string | null

Date and time the account was last successfully aggregated, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00).

Example:

"2016-10-13T17:57:38.000Z"

member.use_cases

enum<string>[]

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. For more info, see Member Use Cases.

Available options:

MONEY_MOVEMENT,

PFM

Example:

["PFM"]

member.user_guid

string | null

Unique identifier for the user the member is attached to. Defined by MX.

Example:

"USR-fa7537f3-48aa-a683-a02a-b18940482f54"