Read member - MX Documentation

Authorizations

Authorization

string

header

required

The MX Platform API requires basic access authentication using your client_id and api_key. These credentials must be Base64 encoded and included in the Authorization header of each API request to ensure secure access.

Here's an example using curl to access v20250224. Replace https://int-api.mx.com/endpoint with the actual API endpoint you wish to access and your Base64 encoded client_id and api_key.

curl -L -X POST `https://int-api.mx.com/endpoint' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Accept-Version: v20250224'
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

Accept-Version

string

default:v20250224

required

MX Platform API version.

Example:

"v20250224"

Path Parameters

member_identifier

string

required

Use either the member id you defined or the MX-defined member guid. See MX-Defined GUIDs vs IDs Defined by You.

user_identifier

string

required

Use either the user id you defined or the MX-defined user guid. See MX-Defined GUIDs vs IDs Defined by You.

Response

200 - application/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

Indicates whether background aggregation is disabled for the member.

Example:

false

member.connection_status

enum<string> | null

The status of a user's connection to an institution. See Member Connection Status.

Available options:

null,

CREATED,

PREVENTED,

DENIED,

CHALLENGED,

REJECTED,

LOCKED,

CONNECTED,

IMPEDED,

RECONNECTED,

DEGRADED,

DISCONNECTED,

DISCONTINUED,

CLOSED,

DELAYED,

FAILED,

UPDATED,

DISABLED,

IMPORTED,

RESUMED,

EXPIRED,

IMPAIRED,

PENDING

Example:

"CONNECTED"

member.connection_status_message

string | null

A human-readable message describing the connection status. See Member Connection Status.

Example:

"Connected to MX Bank"

member.error

object | null

member.guid

string | null

The unique identifier for the member. Defined by MX.

Example:

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

member.id

string | null

The unique partner-defined identifier for the member.

Example:

"unique_id"

member.institution_code

string | null

The code identifying a financial institution.

Example:

"mxbank"

member.institution_guid

string

The unique identifier for the institution. Defined by MX.

Example:

"INST-12345678-90ab-cdef-1234-567890abcdef"

member.is_being_aggregated

boolean | null

Indicates whether the member was being aggregated at the time of the request.

Example:

false

member.is_managed_by_user

boolean | null

Indicates whether the member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to false.

Example:

false

member.is_manual

boolean | null

Indicates whether the transaction was manually created or belongs to a manual account.

Example:

false

member.is_oauth

boolean | null

Indicates whether the member uses OAuth to authenticate. Defaults to false.

Example:

false

member.metadata

string | null

Additional information you stored about the member.

Example:

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

member.most_recent_job_detail_code

integer | null

(Deprecated) This field is no longer used and will be removed at a future date.

Example:

null

member.most_recent_job_detail_text

boolean | null

(Deprecated) This field is no longer used and will be removed at a future date.

Example:

null

member.most_recent_job_guid

string | null

The unique identifier for the most recent job. Defined by MX.

Example:

"JOB-12345678-90ab-cdef-1234-567890abcdef"

member.name

string | null

The name of the member.

Example:

"MX Bank"

member.needs_updated_credentials

boolean | null

Internal field used by MX in some circumstances. When set to true, MX will not attempt to aggregate the member. It will be set to false automatically when the member's credentials are updated.

Example:

false

member.oauth_window_uri

string | null

When connecting a member using OAuth, this field will contain the URL to send the user to in order to authenticate, otherwise it will be blank.

Example:

"https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2"

member.successfully_aggregated_at

string | null

The date and time when the member was last successfully aggregated, represented in ISO 8601 format with a timestamp.

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.

Available options:

MONEY_MOVEMENT,

PFM

Example:

["PFM"]

member.user_guid

string | null

The unique identifier for the user. Defined by MX.

Example:

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

member.user_id

string | null

The unique partner-defined identifier for the user.

Example:

"u-1234"