Create member

curl --request POST \
  --url https://int-api.mx.com/users/{user_identifier}/members \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data_request": {
    "products": [
      "transactions"
    ]
  },
  "member": {
    "background_aggregation_is_disabled": false,
    "credentials": [
      {
        "guid": "CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f",
        "value": "password"
      }
    ],
    "id": "unique_id",
    "institution_code": "mxbank",
    "is_oauth": false,
    "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
    "use_cases": [
      "PFM"
    ]
  }
}
'

import requests

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

payload = {
    "data_request": { "products": ["transactions"] },
    "member": {
        "background_aggregation_is_disabled": False,
        "credentials": [
            {
                "guid": "CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f",
                "value": "password"
            }
        ],
        "id": "unique_id",
        "institution_code": "mxbank",
        "is_oauth": False,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "use_cases": ["PFM"]
    }
}
headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Accept-Version': '<accept-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data_request: {products: ['transactions']},
    member: {
      background_aggregation_is_disabled: false,
      credentials: [{guid: 'CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f', value: 'password'}],
      id: 'unique_id',
      institution_code: 'mxbank',
      is_oauth: false,
      metadata: '{"credentials_last_refreshed_at": "2015-10-15"}',
      use_cases: ['PFM']
    }
  })
};

fetch('https://int-api.mx.com/users/{user_identifier}/members', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data_request' => [
        'products' => [
                'transactions'
        ]
    ],
    'member' => [
        'background_aggregation_is_disabled' => false,
        'credentials' => [
                [
                                'guid' => 'CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f',
                                'value' => 'password'
                ]
        ],
        'id' => 'unique_id',
        'institution_code' => 'mxbank',
        'is_oauth' => false,
        'metadata' => '{"credentials_last_refreshed_at": "2015-10-15"}',
        'use_cases' => [
                'PFM'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"data_request\": {\n    \"products\": [\n      \"transactions\"\n    ]\n  },\n  \"member\": {\n    \"background_aggregation_is_disabled\": false,\n    \"credentials\": [\n      {\n        \"guid\": \"CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f\",\n        \"value\": \"password\"\n      }\n    ],\n    \"id\": \"unique_id\",\n    \"institution_code\": \"mxbank\",\n    \"is_oauth\": false,\n    \"metadata\": \"{\\\"credentials_last_refreshed_at\\\": \\\"2015-10-15\\\"}\",\n    \"use_cases\": [\n      \"PFM\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://int-api.mx.com/users/{user_identifier}/members")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data_request\": {\n    \"products\": [\n      \"transactions\"\n    ]\n  },\n  \"member\": {\n    \"background_aggregation_is_disabled\": false,\n    \"credentials\": [\n      {\n        \"guid\": \"CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f\",\n        \"value\": \"password\"\n      }\n    ],\n    \"id\": \"unique_id\",\n    \"institution_code\": \"mxbank\",\n    \"is_oauth\": false,\n    \"metadata\": \"{\\\"credentials_last_refreshed_at\\\": \\\"2015-10-15\\\"}\",\n    \"use_cases\": [\n      \"PFM\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data_request\": {\n    \"products\": [\n      \"transactions\"\n    ]\n  },\n  \"member\": {\n    \"background_aggregation_is_disabled\": false,\n    \"credentials\": [\n      {\n        \"guid\": \"CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f\",\n        \"value\": \"password\"\n      }\n    ],\n    \"id\": \"unique_id\",\n    \"institution_code\": \"mxbank\",\n    \"is_oauth\": false,\n    \"metadata\": \"{\\\"credentials_last_refreshed_at\\\": \\\"2015-10-15\\\"}\",\n    \"use_cases\": [\n      \"PFM\"\n    ]\n  }\n}"

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

{
  "member": {
    "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "id": "unique_id",
    "metadata": "some metadata",
    "name": "MX Bank",
    "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "institution": {
      "code": "mxbank",
      "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "iso_country_code": "US",
      "name": "MX Bank",
      "products": [
        "account_verification",
        "identity_verification",
        "transactions",
        "transaction_history",
        "statements",
        "investments",
        "rewards"
      ],
      "self": "/institutions/INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "supports_oauth": true
    },
    "member_status": {
      "status": "CONNECTED",
      "error": null,
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status"
    },
    "oauth": {
      "is_oauth": true,
      "authorization_url": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth/authorization_url"
    },
    "user": {
      "guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
      "id": "unique_id",
      "metadata": "some metadata",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    }
  }
}

{
  "member": {
    "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "id": "unique_id",
    "metadata": "some metadata",
    "name": "MX Bank",
    "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "institution": {
      "code": "mxbank",
      "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "iso_country_code": "US",
      "name": "MX Bank",
      "products": [
        "account_verification",
        "identity_verification",
        "transactions",
        "transaction_history",
        "statements",
        "investments",
        "rewards"
      ],
      "self": "/institutions/INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "supports_oauth": true
    },
    "member_status": {
      "status": "CONNECTED",
      "error": {
        "error_type": "MEMBER",
        "error_code": "REQUEST_FAILED",
        "error_message": "There was an error attempting to process your request. The Member was created but we were unable to fulfill the data request.",
        "user_message": "We're having trouble connecting right now. Please try again later."
      },
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status"
    },
    "oauth": {
      "is_oauth": true,
      "authorization_url": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth/authorization_url"
    },
    "user": {
      "guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
      "id": "unique_id",
      "metadata": "some metadata",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    },
    "mx_record": {
      "created_at": "2025-05-10T18:08:00Z",
      "updated_at": "2026-02-12T22:48:21Z"
    }
  }
}

{
  "member": {
    "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "id": "unique_id",
    "metadata": "some metadata",
    "name": "MX Bank",
    "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "institution": {
      "code": "mxbank",
      "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "iso_country_code": "US",
      "name": "MX Bank",
      "products": [
        "account_verification",
        "identity_verification",
        "transactions",
        "transaction_history",
        "statements",
        "investments",
        "rewards"
      ],
      "self": "/institutions/INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "supports_oauth": true
    },
    "member_status": {
      "status": "CONNECTED",
      "error": null,
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status"
    },
    "oauth": {
      "is_oauth": true,
      "authorization_url": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth/authorization_url"
    },
    "user": {
      "guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
      "id": "unique_id",
      "metadata": "some metadata",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    }
  }
}

Members

Create member

This endpoint allows you to create a new member using the required parameters institution_code, credentials (if creating a non-OAuth member), and data_request.products. When creating a non-OAuth member, 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.

Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data. OAuth members will not begin aggregation until the user completes authorization; aggregation initiates automatically after the OAuth flow is completed.

Response status codes:
- 200 - Member created, no aggregation job initiated.
- 201 - Member created, but one or more products in data_request failed.
- 202 - Member created, aggregation requested. Does not indicate aggregation success or failure.

POST

users

{user_identifier}

members

Create member

curl --request POST \
  --url https://int-api.mx.com/users/{user_identifier}/members \
  --header 'Accept-Version: <accept-version>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data_request": {
    "products": [
      "transactions"
    ]
  },
  "member": {
    "background_aggregation_is_disabled": false,
    "credentials": [
      {
        "guid": "CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f",
        "value": "password"
      }
    ],
    "id": "unique_id",
    "institution_code": "mxbank",
    "is_oauth": false,
    "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
    "use_cases": [
      "PFM"
    ]
  }
}
'

import requests

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

payload = {
    "data_request": { "products": ["transactions"] },
    "member": {
        "background_aggregation_is_disabled": False,
        "credentials": [
            {
                "guid": "CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f",
                "value": "password"
            }
        ],
        "id": "unique_id",
        "institution_code": "mxbank",
        "is_oauth": False,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "use_cases": ["PFM"]
    }
}
headers = {
    "Accept-Version": "<accept-version>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Accept-Version': '<accept-version>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data_request: {products: ['transactions']},
    member: {
      background_aggregation_is_disabled: false,
      credentials: [{guid: 'CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f', value: 'password'}],
      id: 'unique_id',
      institution_code: 'mxbank',
      is_oauth: false,
      metadata: '{"credentials_last_refreshed_at": "2015-10-15"}',
      use_cases: ['PFM']
    }
  })
};

fetch('https://int-api.mx.com/users/{user_identifier}/members', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data_request' => [
        'products' => [
                'transactions'
        ]
    ],
    'member' => [
        'background_aggregation_is_disabled' => false,
        'credentials' => [
                [
                                'guid' => 'CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f',
                                'value' => 'password'
                ]
        ],
        'id' => 'unique_id',
        'institution_code' => 'mxbank',
        'is_oauth' => false,
        'metadata' => '{"credentials_last_refreshed_at": "2015-10-15"}',
        'use_cases' => [
                'PFM'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept-Version: <accept-version>",
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"data_request\": {\n    \"products\": [\n      \"transactions\"\n    ]\n  },\n  \"member\": {\n    \"background_aggregation_is_disabled\": false,\n    \"credentials\": [\n      {\n        \"guid\": \"CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f\",\n        \"value\": \"password\"\n      }\n    ],\n    \"id\": \"unique_id\",\n    \"institution_code\": \"mxbank\",\n    \"is_oauth\": false,\n    \"metadata\": \"{\\\"credentials_last_refreshed_at\\\": \\\"2015-10-15\\\"}\",\n    \"use_cases\": [\n      \"PFM\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Accept-Version", "<accept-version>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://int-api.mx.com/users/{user_identifier}/members")
  .header("Accept-Version", "<accept-version>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data_request\": {\n    \"products\": [\n      \"transactions\"\n    ]\n  },\n  \"member\": {\n    \"background_aggregation_is_disabled\": false,\n    \"credentials\": [\n      {\n        \"guid\": \"CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f\",\n        \"value\": \"password\"\n      }\n    ],\n    \"id\": \"unique_id\",\n    \"institution_code\": \"mxbank\",\n    \"is_oauth\": false,\n    \"metadata\": \"{\\\"credentials_last_refreshed_at\\\": \\\"2015-10-15\\\"}\",\n    \"use_cases\": [\n      \"PFM\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Accept-Version"] = '<accept-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data_request\": {\n    \"products\": [\n      \"transactions\"\n    ]\n  },\n  \"member\": {\n    \"background_aggregation_is_disabled\": false,\n    \"credentials\": [\n      {\n        \"guid\": \"CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f\",\n        \"value\": \"password\"\n      }\n    ],\n    \"id\": \"unique_id\",\n    \"institution_code\": \"mxbank\",\n    \"is_oauth\": false,\n    \"metadata\": \"{\\\"credentials_last_refreshed_at\\\": \\\"2015-10-15\\\"}\",\n    \"use_cases\": [\n      \"PFM\"\n    ]\n  }\n}"

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

{
  "member": {
    "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "id": "unique_id",
    "metadata": "some metadata",
    "name": "MX Bank",
    "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "institution": {
      "code": "mxbank",
      "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "iso_country_code": "US",
      "name": "MX Bank",
      "products": [
        "account_verification",
        "identity_verification",
        "transactions",
        "transaction_history",
        "statements",
        "investments",
        "rewards"
      ],
      "self": "/institutions/INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "supports_oauth": true
    },
    "member_status": {
      "status": "CONNECTED",
      "error": null,
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status"
    },
    "oauth": {
      "is_oauth": true,
      "authorization_url": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth/authorization_url"
    },
    "user": {
      "guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
      "id": "unique_id",
      "metadata": "some metadata",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    }
  }
}

{
  "member": {
    "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "id": "unique_id",
    "metadata": "some metadata",
    "name": "MX Bank",
    "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "institution": {
      "code": "mxbank",
      "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "iso_country_code": "US",
      "name": "MX Bank",
      "products": [
        "account_verification",
        "identity_verification",
        "transactions",
        "transaction_history",
        "statements",
        "investments",
        "rewards"
      ],
      "self": "/institutions/INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "supports_oauth": true
    },
    "member_status": {
      "status": "CONNECTED",
      "error": {
        "error_type": "MEMBER",
        "error_code": "REQUEST_FAILED",
        "error_message": "There was an error attempting to process your request. The Member was created but we were unable to fulfill the data request.",
        "user_message": "We're having trouble connecting right now. Please try again later."
      },
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status"
    },
    "oauth": {
      "is_oauth": true,
      "authorization_url": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth/authorization_url"
    },
    "user": {
      "guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
      "id": "unique_id",
      "metadata": "some metadata",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    },
    "mx_record": {
      "created_at": "2025-05-10T18:08:00Z",
      "updated_at": "2026-02-12T22:48:21Z"
    }
  }
}

{
  "member": {
    "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "id": "unique_id",
    "metadata": "some metadata",
    "name": "MX Bank",
    "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "institution": {
      "code": "mxbank",
      "guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "iso_country_code": "US",
      "name": "MX Bank",
      "products": [
        "account_verification",
        "identity_verification",
        "transactions",
        "transaction_history",
        "statements",
        "investments",
        "rewards"
      ],
      "self": "/institutions/INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "supports_oauth": true
    },
    "member_status": {
      "status": "CONNECTED",
      "error": null,
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status"
    },
    "oauth": {
      "is_oauth": true,
      "authorization_url": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth/authorization_url"
    },
    "user": {
      "guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c",
      "id": "unique_id",
      "metadata": "some metadata",
      "self": "/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    }
  }
}

Authorizations

Authorization

string

header

required

To authenticate with the Platform API, include your Base64-encoded client_id and api_key in the Authorization header of every request:

-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

Headers

Accept-Version

string

default:v20260929

required

MX Platform API version.

Example:

"v20260929"

X-CALLBACK-PAYLOAD

string

The base64 encoded string defined in this header will be returned in the Member and Member Data Updated webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.

Path Parameters

user_identifier

string

required

Use either the user id you defined or the MX-defined user guid. See Assigning Resource IDs.

Body

application/json

Member object to be created

data_request

object

required

Contains a products array that specifies the products you want to aggregate.

Hide child attributes

data_request.products

enum<string>[]

required

Contains the products you want to aggregate upon a successful connection.

Available options:

account_verification,

identity_verification,

transactions,

transaction_history,

statements,

investments

Example:

{
  "products": ["transactions", "statements", "investments"]
}

member

object

required

Hide child attributes

member.credentials

object[]

required

Hide child attributes

member.credentials.guid

string

Example:

"CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f"

member.credentials.value

string

Example:

"password"

member.institution_code

string

required

The code identifying a financial institution.

Example:

"mxbank"

member.background_aggregation_is_disabled

boolean

Indicates whether background aggregation is disabled for the member.

Example:

false

member.id

string

The unique partner-defined identifier for the member.

Example:

"unique_id"

member.is_oauth

boolean

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

Example:

false

member.metadata

string

Additional information you can store about the member.

Example:

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

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"]

oauth

object

Hide child attributes

oauth.client_redirect_url

string

This determines the redirect destination at the end of OAuth when used with is_mobile_webview: true or oauth_referral_source: 'APP'.

Example:

"https://{yoursite.com}"

oauth.enable_app2app

boolean

This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to true. When set to false, any oauth_window_uri generated will not direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions.

Example:

true

oauth.referral_source

string

Example:

"APP"

oauth.ui_message_webview_url_scheme

string

A client-defined scheme used in OAuth redirects in WebViews. Defaults to mx.

Response

member

object

The base fields for a member, which is a user's connection to an institution. Returned as the member companion on related resources such as accounts and transactions, and as the foundation of full member responses.

Hide child attributes

member.guid

string

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

string | null

Additional information you can store about the member.

Example:

"some metadata"

member.name

string | null

The name of the member.

Example:

"MX Bank"

member.self

string

The API URI path for the member.

Example:

"/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b"

member.institution

object

Hide child attributes

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:

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

member.institution.iso_country_code

enum<string>

The ISO country code associated with the institution.

Available options:

US,

CA

Example:

"US"

member.institution.name

string | null

The name of the institution.

Example:

"MX Bank"

member.institution.products

enum<string>[]

The products the institution supports.

Available options:

account_verification,

identity_verification,

transactions,

transaction_history,

statements,

investments,

rewards

Example:

[
  "account_verification",
  "identity_verification",
  "transactions",
  "transaction_history",
  "statements",
  "investments",
  "rewards"
]

member.institution.self

string

The API URI path for the institution.

Example:

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

member.institution.supports_oauth

boolean | null

If true, this indicates that the institution supports OAuth and that you have been properly registered for OAuth with that institution.

Example:

true

member.member_status

object

Hide child attributes

member.member_status.status

enum<string> | null

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

Available options:

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.member_status.error

object | null

Example:

null

member.member_status.self

string

The API URI path for the member's status.

Example:

"/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/status"

member.oauth

object

Hide child attributes

member.oauth.is_oauth

boolean | null

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

Example:

true

member.oauth.authorization_url

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=b8OikQ4Ep"

member.oauth.self

string

The API URI path to generate a new OAuth Authorization URL.

Example:

"/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c/members/MBR-7c6f361b-e582-15b6-60c0-358f12466b4b/oauth/authorization_url"

member.user

object

The base fields for a user. Returned as the user companion on related resources such as members, accounts, and transactions, and as the foundation of full user responses.

Hide child attributes

member.user.guid

string

The unique identifier for the user. Defined by MX.

Example:

"USR-11141024-90b3-1bce-cac9-c06ced52ab4c"

member.user.id

string | null

The unique partner-defined identifier for the user.

Example:

"unique_id"

member.user.metadata

string | null

Additional information you can store about the user.

Example:

"some metadata"

member.user.self

string

The API URI path for the user.

Example:

"/users/USR-11141024-90b3-1bce-cac9-c06ced52ab4c"