Field

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Field",
  "title": "Field",
  "type": "object",
  "properties": {
    "image": {
      "type": "string",
      "description": "Image displayed at the endsite.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li></ul>"
    },
    "prefix": {
      "type": "string",
      "description": "The prefix string that has to be displayed before the field value.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "readOnly": true
    },
    "minLength": {
      "type": "integer",
      "description": "The minimum length of the login form field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "format": "int64",
      "readOnly": true
    },
    "valueEditable": {
      "type": "string",
      "description": "Indicates whether the field is editable or not.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "readOnly": true
    },
    "isOptional": {
      "type": "boolean",
      "description": "Indicates if a field is an optional field or a mandatory field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "readOnly": true
    },
    "suffix": {
      "type": "string",
      "description": "The suffix string that has to be displayed next to the field value.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "readOnly": true
    },
    "type": {
      "type": "string",
      "description": "This indicates the display type of the field. For example, text box, image, etc. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul><b>Applicable Values</b><br>",
      "readOnly": true,
      "enum": [
        "text",
        "password",
        "options",
        "checkbox",
        "radio",
        "image",
        "option"
      ]
    },
    "isValueProvided": {
      "type": "boolean",
      "description": "Indicates that the answer to the security question already exists in the Yodlee system.Persuading the user to provide the answer to the security question again during the edit-credential flow can be avoided.<br><br><br><b>Endpoints</b>:<ul><li>GET providerAccounts?include=questions</li><li>GET providerAccounts/{providerAccountId}? include=questions</li></ul>",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "Name of the field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "readOnly": true
    },
    "id": {
      "maxLength": 2147483647,
      "minLength": 1,
      "type": "string",
      "description": "Identifier for the field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
    },
    "value": {
      "type": "string",
      "description": "Value expected from the user for the field. This will be blank and is expected to be filled and sent back when submitting the login or MFA information.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
    },
    "maxLength": {
      "type": "integer",
      "description": "The maximum length of the login form field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "format": "int64",
      "readOnly": true
    },
    "option": {
      "type": "array",
      "description": "Provides the different values that are available for the user to choose. This field is applicable for drop-down or radio field types.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/Option"
      }
    }
  }
}