Envestnet · Schema

LoginForm

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
mfaInfoTitle string The title for the MFA information demanded from the user.This is the title displayed in the provider site.This field is applicable for MFA form types only.

Endpoints:
  • GET provide
help string The help that can be displayed to the customer in the login form.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
forgetPasswordURL string The forget password URL of the provider site.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
formType string The type of the forms for which the user information is required.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
Applicable Val
mfaInfoText string The text displayed in the provider site while requesting the user's MFA information. This field is applicable for MFA form types only.

Endpoints:
  • GET providerAccounts/{providerAc
loginHelp string The help that can be displayed to the customer in the login form.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
mfaTimeout integer The amount of time before which the user is expected to provide MFA information. This field is applicable for MFA form types only. This would be an useful information that could be displayed to the us
id integer The identifier of the login form.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET providers/{providerId}
row array This indicates one row in the form. The row will have one label. But it may have single or multiple fields.

Endpoints:
  • GET providerAccounts/{providerAccountId}
  • GET provide
View JSON Schema on GitHub

JSON Schema

envestnet-loginform-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LoginForm",
  "title": "LoginForm",
  "type": "object",
  "properties": {
    "mfaInfoTitle": {
      "type": "string",
      "description": "The title for the MFA information demanded from the user.This is the title displayed in the provider site.This field is applicable for MFA form types only. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li></ul>",
      "readOnly": true
    },
    "help": {
      "type": "string",
      "description": "The help that can be displayed to the customer in the login form.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "readOnly": true
    },
    "forgetPasswordURL": {
      "type": "string",
      "description": "The forget password URL of the provider site.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
    },
    "formType": {
      "type": "string",
      "description": "The type of the forms for which the user information is required.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul><b>Applicable Values</b><br>",
      "enum": [
        "login",
        "questionAndAnswer",
        "token",
        "image"
      ]
    },
    "mfaInfoText": {
      "type": "string",
      "description": "The text displayed in the provider site while requesting the user's MFA information. This field is applicable for MFA form types only. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li></ul>",
      "readOnly": true
    },
    "loginHelp": {
      "type": "string",
      "description": "The help that can be displayed to the customer in the login form.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "readOnly": true
    },
    "mfaTimeout": {
      "type": "integer",
      "description": "The amount of time before which the user is expected to provide MFA information. This field is applicable for MFA form types only. This would be an useful information that could be displayed to the users. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "format": "int64",
      "readOnly": true
    },
    "id": {
      "type": "integer",
      "description": "The identifier of the login form.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "format": "int64"
    },
    "row": {
      "type": "array",
      "description": "This indicates one row in the form. The row will have one label. But it may have single or multiple fields.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "items": {
        "$ref": "#/components/schemas/Row"
      }
    }
  }
}