List member credentials

curl --request GET \
  --url https://int-data.moneydesktop.com/member/{member_guid}/credentials \
  --header 'MD-SESSION-TOKEN: <api-key>'

import requests

url = "https://int-data.moneydesktop.com/member/{member_guid}/credentials"

headers = {"MD-SESSION-TOKEN": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'MD-SESSION-TOKEN': '<api-key>'}};

fetch('https://int-data.moneydesktop.com/member/{member_guid}/credentials', 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-data.moneydesktop.com/member/{member_guid}/credentials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "MD-SESSION-TOKEN: <api-key>"
  ],
]);

$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-data.moneydesktop.com/member/{member_guid}/credentials"

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

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")

	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-data.moneydesktop.com/member/{member_guid}/credentials")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/member/{member_guid}/credentials")

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

request = Net::HTTP::Get.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'

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

{
  "credentials": [
    {
      "answer_field_type": null,
      "created_at": "2016-09-21T22:08:59.000Z",
      "display_name": null,
      "display_order": 1,
      "editable": true,
      "escaped": null,
      "field_name": "LOGIN",
      "field_type": 3,
      "field_type_name": "LOGIN",
      "guid": "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1",
      "institution_guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "label": "Username",
      "max_length": null,
      "meta_data": null,
      "mfa": false,
      "optional": false,
      "optional_mfa": null,
      "size": null,
      "updated_at": "2016-09-21T22:08:59.000Z",
      "value_identifier": null,
      "value_mask": null
    }
  ]
}

GET

member

{member_guid}

credentials

List member credentials

curl --request GET \
  --url https://int-data.moneydesktop.com/member/{member_guid}/credentials \
  --header 'MD-SESSION-TOKEN: <api-key>'

import requests

url = "https://int-data.moneydesktop.com/member/{member_guid}/credentials"

headers = {"MD-SESSION-TOKEN": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'MD-SESSION-TOKEN': '<api-key>'}};

fetch('https://int-data.moneydesktop.com/member/{member_guid}/credentials', 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-data.moneydesktop.com/member/{member_guid}/credentials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "MD-SESSION-TOKEN: <api-key>"
  ],
]);

$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-data.moneydesktop.com/member/{member_guid}/credentials"

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

	req.Header.Add("MD-SESSION-TOKEN", "<api-key>")

	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-data.moneydesktop.com/member/{member_guid}/credentials")
  .header("MD-SESSION-TOKEN", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://int-data.moneydesktop.com/member/{member_guid}/credentials")

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

request = Net::HTTP::Get.new(url)
request["MD-SESSION-TOKEN"] = '<api-key>'

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

{
  "credentials": [
    {
      "answer_field_type": null,
      "created_at": "2016-09-21T22:08:59.000Z",
      "display_name": null,
      "display_order": 1,
      "editable": true,
      "escaped": null,
      "field_name": "LOGIN",
      "field_type": 3,
      "field_type_name": "LOGIN",
      "guid": "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1",
      "institution_guid": "INS-1572a04c-912b-59bf-5841-332c7dfafaef",
      "label": "Username",
      "max_length": null,
      "meta_data": null,
      "mfa": false,
      "optional": false,
      "optional_mfa": null,
      "size": null,
      "updated_at": "2016-09-21T22:08:59.000Z",
      "value_identifier": null,
      "value_mask": null
    }
  ]
}

Use this endpoint to list all the credentials needed to update a member. Each member’s credentials are subject to change and can differ between members connected to the same institution. The member’s credential list must be requested to know what the end user should be prompted to enter before updating the member.

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.

Path Parameters

member_guid

string

required

The unique identifier for the member. Defined by MX.

Response

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

credentials

object[]

Hide child attributes

credentials.answer_field_type

any | null

The field type for the answer field when this credential is used for MFA challenges.

Example:

null

credentials.created_at

any

Date and time the institution was created, represented in ISO 8601 format with timestamp

Example:

"2016-09-21T22:08:59.000Z"

credentials.display_name

any | null

The human-readable name to display for this credential field.

Example:

null

credentials.display_order

any

The order in which this credential field should be displayed to the user.

Example:

1

credentials.editable

boolean

Indicates whether this credential field can be edited after initial creation.

Example:

true

credentials.escaped

any | null

Indicates whether special characters in the credential value should be escaped.

Example:

null

credentials.field_name

any

The internal name of the credential field type (e.g., LOGIN, PASSWORD).

Example:

"LOGIN"

credentials.field_type

any

The numeric identifier for the credential field type. See credential field types table for mappings.

Example:

3

credentials.field_type_name

any

The string name corresponding to the field_type numeric identifier.

Example:

"LOGIN"

credentials.guid

any

A unique identifier for the institution. Defined by MX.

Example:

"CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1"

credentials.institution_guid

any

The unique identifier for the institution this credential belongs to. Defined by MX.

Example:

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

credentials.label

any

The label text to display next to the credential input field.

Example:

"Username"

credentials.max_length

any | null

The maximum character length allowed for this credential field value.

Example:

null

credentials.meta_data

any | null

Additional metadata associated with this credential field.

Example:

null

credentials.mfa

boolean

Indicates whether this credential is used for multi-factor authentication.

Example:

false

credentials.optional

boolean

Indicates whether this credential field is optional when creating or updating a member.

Example:

false

credentials.optional_mfa

any | null

Indicates whether this credential is optional when answering MFA challenges.

Example:

null

credentials.size

any | null

The display size (width) for the credential input field.

Example:

null

credentials.updated_at

string

Date and time the credential was last updated, represented in ISO 8601 format with timestamp.

Example:

"2016-09-21T22:08:59.000Z"

credentials.value_identifier

any | null

An identifier used to reference the credential value in certain contexts.

Example:

null

credentials.value_mask

any | null

A pattern or mask to apply when displaying the credential value (e.g., for passwords).

Example:

null

List member challenges

List member transactions