MFA credentials - 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.

Path Parameters

job_guid

string

required

The unique identifier for the job. 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