Read Institution Credentials - MX Documentation

curl -i 'https://vestibule.mx.com/institutions/mxbank/credentials' \  -H 'Accept: application/vnd.mx.atrium.v1+json' \  -H 'MX-API-Key: {mx_api_key}' \  -H 'MX-Client-ID: {mx_client_id}'

{
  "credentials": [
    {
      "display_order": 0,
      "field_name": "login_email",
      "guid": "CRD-12ce94ad-032b-5441-8cb3-d7ebe3a35676",
      "label": "Email Address",
      "type": "LOGIN"
    },
    {
      "display_order": 1,
      "field_name": "login_password",
      "guid": "CRD-305767e4-f464-765b-8f83-881b5bd307ec",
      "label": "PayPal password",
      "type": "PASSWORD"
    }
  ]
}

GET

institutions

{institution_code}

credentials

curl -i 'https://vestibule.mx.com/institutions/mxbank/credentials' \  -H 'Accept: application/vnd.mx.atrium.v1+json' \  -H 'MX-API-Key: {mx_api_key}' \  -H 'MX-Client-ID: {mx_client_id}'

{
  "credentials": [
    {
      "display_order": 0,
      "field_name": "login_email",
      "guid": "CRD-12ce94ad-032b-5441-8cb3-d7ebe3a35676",
      "label": "Email Address",
      "type": "LOGIN"
    },
    {
      "display_order": 1,
      "field_name": "login_password",
      "guid": "CRD-305767e4-f464-765b-8f83-881b5bd307ec",
      "label": "PayPal password",
      "type": "PASSWORD"
    }
  ]
}

Use this endpoint to see which credentials will be needed to create a member for a specific institution.

Institution credentials are not the same as member credentials. Use institution credentials to create a new member and member credentials to update an existing member.

display_order

number

The order in which the credential should be displayed to the end user; lower numbers should be displayed first.

field_name

string

Name of the credential field for the institution (e.g.

guid

string

A unique identifier for the credential. Defined by MX.

label

string

A label for the credential, intended to be readable by the end user (e.g.

type

string

A name for the type of field (e.g.

options

string

See explanation that immediately follows.

value

string

A response for the credential prompt.

curl -i 'https://vestibule.mx.com/institutions/mxbank/credentials' \  -H 'Accept: application/vnd.mx.atrium.v1+json' \  -H 'MX-API-Key: {mx_api_key}' \  -H 'MX-Client-ID: {mx_client_id}'

{
  "credentials": [
    {
      "display_order": 0,
      "field_name": "login_email",
      "guid": "CRD-12ce94ad-032b-5441-8cb3-d7ebe3a35676",
      "label": "Email Address",
      "type": "LOGIN"
    },
    {
      "display_order": 1,
      "field_name": "login_password",
      "guid": "CRD-305767e4-f464-765b-8f83-881b5bd307ec",
      "label": "PayPal password",
      "type": "PASSWORD"
    }
  ]
}

Read Institutions

Overview