{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/envestnet/json-schema/envestnet-provider-detail-response-schema.json",
  "title": "ProviderDetailResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/envestnet-providers-api-openapi.yml#/components/schemas/ProviderDetailResponse",
  "type": "object",
  "properties": {
    "provider": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/$defs/ProviderDetail"
      }
    }
  },
  "$defs": {
    "Attribute": {
      "title": "Attribute",
      "type": "object",
      "properties": {
        "container": {
          "type": "array",
          "description": "Containers for which the attributes are supported.<br><br><b>Endpoints</b>:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>",
          "items": {
            "type": "string",
            "enum": [
              "bank",
              "creditCard",
              "investment",
              "insurance",
              "loan",
              "reward",
              "bill",
              "realEstate",
              "otherAssets",
              "otherLiabilities"
            ]
          }
        },
        "fromDate": {
          "type": "string",
          "description": "Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>",
          "readOnly": true
        },
        "toFinYear": {
          "type": "string",
          "description": "Applicable only to TAX attribute of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>",
          "readOnly": true
        },
        "fromFinYear": {
          "type": "string",
          "description": "Applicable only to TAX attribute of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>",
          "readOnly": true
        },
        "containerAttributes": {
          "$ref": "#/$defs/ContainerAttributes"
        },
        "toDate": {
          "type": "string",
          "description": "Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "Attributes that are supported for a dataset.<br><br><b>Endpoints</b>:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>",
          "enum": [
            "BASIC_ACCOUNT_INFO",
            "TRANSACTIONS",
            "STATEMENTS",
            "HOLDINGS",
            "ACCOUNT_DETAILS",
            "TAX",
            "EBILLS",
            "FULL_ACCT_NUMBER",
            "BANK_TRANSFER_CODE",
            "HOLDER_NAME",
            "HOLDER_DETAILS",
            "PAYMENT_PROFILE",
            "PAYMENT_DETAILS",
            "INTEREST_DETAILS",
            "COVERAGE"
          ]
        }
      }
    },
    "Capability": {
      "title": "Capability",
      "type": "object",
      "properties": {
        "container": {
          "type": "array",
          "readOnly": true,
          "items": {
            "type": "string",
            "enum": [
              "bank",
              "creditCard",
              "investment",
              "insurance",
              "loan",
              "reward",
              "bill",
              "realEstate",
              "otherAssets",
              "otherLiabilities"
            ]
          }
        },
        "name": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "ContainerAttributes": {
      "title": "ContainerAttributes",
      "type": "object",
      "properties": {
        "BANK": {
          "$ref": "#/$defs/TransactionDays"
        },
        "LOAN": {
          "$ref": "#/$defs/TransactionDays"
        },
        "CREDITCARD": {
          "$ref": "#/$defs/TransactionDays"
        },
        "INVESTMENT": {
          "$ref": "#/$defs/TransactionDays"
        },
        "INSURANCE": {
          "$ref": "#/$defs/TransactionDays"
        }
      }
    },
    "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": "#/$defs/Option"
          }
        }
      }
    },
    "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": "#/$defs/Row"
          }
        }
      }
    },
    "Option": {
      "title": "Option",
      "type": "object",
      "properties": {
        "displayText": {
          "type": "string",
          "description": "The text that is displayed to the user for that option in the provider site.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
        },
        "optionValue": {
          "type": "string",
          "description": "The value that is associated with the option.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
        },
        "isSelected": {
          "type": "boolean",
          "description": "The option that is selected by default in the provider site.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
        }
      }
    },
    "ProviderDetail": {
      "title": "ProviderDetail",
      "type": "object",
      "properties": {
        "languageISOCode": {
          "type": "string",
          "description": "The language in which the provider details are provided. For example, a site supports two languages English and French. English being the primary language, the provider response will be provided in French depending on the user's locale. The language follows the two letter ISO code.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "favicon": {
          "type": "string",
          "description": "Favicon link of the provider.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "accountType": {
          "type": "array",
          "description": "AccountType supported by the provider, eg: Brokerage Cash, Current<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true,
          "items": {
            "type": "string",
            "enum": [
              "CURRENT",
              "BROKERAGE_CASH"
            ]
          }
        },
        "countryISOCode": {
          "type": "string",
          "description": "Country to which the provider belongs.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "isAddedByUser": {
          "type": "string",
          "description": "Indicates that the site has been added by the user at least once.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "PRIORITY": {
          "type": "string",
          "description": "Indicates the priority for which the service is invoked.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul><b>Applicable Values</b><br>",
          "readOnly": true,
          "enum": [
            "POPULAR",
            "SUGGESTED",
            "COBRAND",
            "SEARCH",
            "ALL"
          ]
        },
        "associatedProviderIds": {
          "type": "array",
          "description": "The screen-scraping providers that are associated to the Open Banking provider ID.<br><br><b>Applicable containers</b>: All Containers<br><b>Endpoints</b>:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>",
          "readOnly": true,
          "items": {
            "type": "integer",
            "format": "int64"
          }
        },
        "primaryLanguageISOCode": {
          "type": "string",
          "description": "The primary language of the site.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "help": {
          "type": "string",
          "description": "Text to guide user through linking an account that belongs to the site<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "baseUrl": {
          "type": "string",
          "description": "The base URL of the provider's site.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "capability": {
          "type": "array",
          "description": "Capability of the site<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul><br><b>Note : </b> capability has been deprecated",
          "readOnly": true,
          "items": {
            "$ref": "#/$defs/Capability"
          }
        },
        "loginForm": {
          "type": "array",
          "description": "This entity represents the structure of the login or MFA form that is displayed to the user at the provider site. For performance reasons, this field is returned only when a single provider is requested in the request.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li></ul>",
          "readOnly": true,
          "items": {
            "$ref": "#/$defs/LoginForm"
          }
        },
        "isConsentRequired": {
          "type": "boolean",
          "description": "Indicates if a provider site requires consent.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "loginUrl": {
          "type": "string",
          "description": "The login URL of the provider's site.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "isAutoRefreshEnabled": {
          "type": "boolean",
          "description": "Indicates if a provider site is auto-refreshed.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "The name of a provider site.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "logo": {
          "type": "string",
          "description": "The logo link of the provider institution. The link will return the logo in the PNG format.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "betaContainers": {
          "type": "array",
          "description": "This attribute will show the list of containers which are presently under development for the provider site and their link attempt may be unsuccessful<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true,
          "items": {
            "type": "string"
          }
        },
        "id": {
          "type": "integer",
          "description": "Unique identifier for the provider site(e.g., financial institution sites, biller sites, lender sites, etc.).<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "format": "int64",
          "readOnly": true
        },
        "lastModified": {
          "type": "string",
          "description": "Determines when the provider information was updated by Yodlee. If the customer caches the data, the cache is recommended to be refreshed based on this field.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true
        },
        "authParameter": {
          "type": "array",
          "description": "AuthParameter appears in the response only in case of token-based aggregation sites.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true,
          "items": {
            "type": "string",
            "enum": [
              "authorizationCode",
              "idToken",
              "authResponse",
              "state"
            ]
          }
        },
        "authType": {
          "type": "string",
          "description": "The authentication type enabled at the provider site. <br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul><b>Applicable Values</b><br>",
          "readOnly": true,
          "enum": [
            "OAUTH",
            "CREDENTIALS",
            "MFA_CREDENTIALS"
          ]
        },
        "dataset": {
          "type": "array",
          "description": "Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true,
          "items": {
            "$ref": "#/$defs/ProvidersDataset"
          }
        },
        "status": {
          "type": "string",
          "description": "Determines if the provider is supported for the cobrand (customer), is in the beta stage, etc. <br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "readOnly": true,
          "enum": [
            "Supported",
            "Beta",
            "Unsupported"
          ]
        }
      }
    },
    "ProvidersDataset": {
      "title": "ProvidersDataset",
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the dataset requested from the provider site<br><br><b>Account Type</b>: Manual<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li><li>GET providers</li></ul><b>Applicable Values</b><br>",
          "enum": [
            "BASIC_AGG_DATA",
            "ADVANCE_AGG_DATA",
            "ACCT_PROFILE",
            "DOCUMENT"
          ]
        },
        "attribute": {
          "type": "array",
          "description": "The name of the dataset attribute suported by the provider.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>",
          "items": {
            "$ref": "#/$defs/Attribute"
          }
        }
      }
    },
    "Row": {
      "title": "Row",
      "type": "object",
      "properties": {
        "fieldRowChoice": {
          "type": "string",
          "description": "Fields that belong to a particular choice are collected together using this field.<br><b>Recommendations</b>: All the field row choices label to be grouped and displayed as options to the customer. On choosing a particular choice field, we recommend displaying the fields relevant to them. First field choice could be selected by default.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
        },
        "field": {
          "type": "array",
          "description": "Details of fields that belong to the row.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>",
          "items": {
            "$ref": "#/$defs/Field"
          }
        },
        "form": {
          "type": "string",
          "description": "Form denotes the set of the fields that are related. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
        },
        "id": {
          "type": "string",
          "description": "Unique identifier of the row.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
        },
        "label": {
          "type": "string",
          "description": "The label text displayed for a row in the form.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
        }
      }
    },
    "TransactionDays": {
      "title": "TransactionDays",
      "type": "object",
      "properties": {
        "fullAccountNumberFields": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "paymentAccountNumber",
              "unmaskedAccountNumber"
            ]
          }
        },
        "numberOfTransactionDays": {
          "type": "integer",
          "format": "int32"
        }
      }
    }
  }
}