Read member status

curl --request GET \
  --url https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "member": {
    "aggregated_at": "2016-10-13T18:07:57.000Z",
    "challenges": [
      {
        "field_name": "Who is this guy?",
        "guid": "CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5",
        "image_data": "Who is this guy?",
        "image_options": [
          {
            "data_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...",
            "guid": "CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5",
            "label": "IMAGE_1",
            "value": "image_data"
          }
        ],
        "label": "Who is this guy?",
        "options": [
          {
            "guid": "CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5",
            "label": "IMAGE_1",
            "value": "image_data"
          }
        ],
        "type": "IMAGE_DATA"
      }
    ],
    "connection_status": "CONNECTED",
    "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "has_processed_account_numbers": true,
    "has_processed_accounts": true,
    "has_processed_transactions": false,
    "is_authenticated": false,
    "is_being_aggregated": false,
    "successfully_aggregated_at": "2016-10-13T17:57:38.000Z"
  }
}

GET

users

{user_identifier}

members

{member_identifier}

status

Read member status

curl --request GET \
  --url https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status"

headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Accept-Version': '<accept-version>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-api.mx.com/users/{user_identifier}/members/{member_identifier}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "member": {
    "aggregated_at": "2016-10-13T18:07:57.000Z",
    "challenges": [
      {
        "field_name": "Who is this guy?",
        "guid": "CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5",
        "image_data": "Who is this guy?",
        "image_options": [
          {
            "data_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...",
            "guid": "CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5",
            "label": "IMAGE_1",
            "value": "image_data"
          }
        ],
        "label": "Who is this guy?",
        "options": [
          {
            "guid": "CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5",
            "label": "IMAGE_1",
            "value": "image_data"
          }
        ],
        "type": "IMAGE_DATA"
      }
    ],
    "connection_status": "CONNECTED",
    "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "has_processed_account_numbers": true,
    "has_processed_accounts": true,
    "has_processed_transactions": false,
    "is_authenticated": false,
    "is_being_aggregated": false,
    "successfully_aggregated_at": "2016-10-13T17:57:38.000Z"
  }
}

This endpoint provides the status of the members most recent aggregation event. The results returned by this endpoint should determine what you do next in order to successfully aggregate a member.

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.challenges

object[]

Hide child attributes

member.challenges.field_name

string | null

Example:

"Who is this guy?"

member.challenges.guid

string | null

Example:

"CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5"

member.challenges.image_data

string | null

Example:

"Who is this guy?"

member.challenges.image_options

object[]

Hide child attributes

member.challenges.image_options.data_uri

string | null

Example:

"data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ..."

member.challenges.image_options.guid

string | null

Example:

"CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5"

member.challenges.image_options.label

string | null

Example:

"IMAGE_1"

member.challenges.image_options.value

string | null

Example:

"image_data"

member.challenges.label

string | null

Example:

"Who is this guy?"

member.challenges.options

object[]

Hide child attributes

member.challenges.options.guid

string | null

Example:

"CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5"

member.challenges.options.label

string | null

Example:

"IMAGE_1"

member.challenges.options.value

string | null

Example:

"image_data"

member.challenges.type

string | null

Example:

"IMAGE_DATA"

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.guid

string | null

The unique identifier for the member. Defined by MX.

Example:

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

member.has_processed_account_numbers

boolean | null

Indicates whether the member has processed account numbers.

Example:

true

member.has_processed_accounts

boolean | null

Indicates whether the member has processed accounts.

Example:

true

member.has_processed_transactions

boolean | null

Indicates whether the member has processed transactions.

Example:

false

member.is_authenticated

boolean | null

Example:

false

member.is_being_aggregated

boolean | null

Example:

false

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"

Resume aggregation

Verify member