swagger: '2.0'
info:
  license:
    name: Yodlee Developer License
    url: https://developer.yodlee.com/terms/condition#_Services_1
  contact:
    email: developer@yodlee.com
  description: 'This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform APIs for many different programming languages. Yodlee API v1.1 - Overview</a>.<br><br>You will have to set the header before making the API call. The following headers apply to all the APIs:<ul><li>Authorization: This header holds the access token</li> <li> Api-Version: 1.1</li></ul><b>Note</b>: If there are any API-specific headers, they are mentioned explicitly in the respective API''s description.'
  termsOfService: https://developer.yodlee.com/terms/condition
  title: Yodlee Core APIs Account Token Providers API
  version: 1.1.0
basePath: /
tags:
- name: Providers
  description: Providers API
paths:
  /providers:
    get:
      summary: Get Providers
      deprecated: false
      produces:
      - application/json;charset=UTF-8
      description: 'The get provider service is used to get all the providers that are enabled, search a provider service by name or routing number and get popular sites of a region. <br>Searching for a provider using a routing number is applicable only to the USA and Canada regions.<br>The valid values for priority are: <br>   1. cobrand: Returns providers enabled for the cobrand (Default priority)<br>   2. popular: Returns providers popular among users of the customer<br><br>Only the datasets, attributes, and containers that are enabled for the customer will be returned in the response.<br>Input for the dataset$filter should adhere to the following expression:<br><dataset.name>[<attribute.name>.container[<container> OR <container>] OR <attribute.name>.container[<container>]] <br>OR <dataset.name>[<attribute.name> OR <attribute.name>]<br><b>dataset$filter value examples:</b><br>ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank OR investment OR creditCard]]<br>ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]<br>BASIC_AGG_DATA[ACCOUNT_DETAILS.container[bank OR investment] OR HOLDINGS.container[bank]] OR ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]<br>BASIC_AGG_DATA<br>BASIC_AGG_DATA OR ACCT_PROFILE<br>BASIC_AGG_DATA [ ACCOUNT_DETAILS OR HOLDINGS ]<br>BASIC_AGG_DATA [ ACCOUNT_DETAILS] OR DOCUMENT <br>BASIC_AGG_DATA [ BASIC_ACCOUNT_INFO OR ACCOUNT_DETAILS ] <br><br>The fullAcountNumberFields is specified to filter the providers that have paymentAccountNumber or unmaskedAccountNumber support in the FULL_ACCT_NUMBER dataset attribute.<br><b>Examples for usage of fullAccountNumberFields </b><br>dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] &amp; fullAccountNumberFields=paymentAccountNumber<br>dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] &amp; fullAccountNumberFields=unmaskedAccountNumber<br>dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] &amp; fullAccountNumberFields=unmaskedAccountNumber,paymentAccountNumber<br><br>The skip and top parameters are used for pagination. In the skip and top parameters, pass the number of records to be skipped and retrieved, respectively.<br>The response header provides the links to retrieve the next and previous set of transactions.<br><br><b>Note:</b> <ol><li>In a product flow involving user interaction, Yodlee recommends invoking this service with filters.<li>Without filters, the service may perform slowly as it takes a few minutes to return data in the response.<li>The AuthParameter appears in the response only in case of token-based aggregation sites.<li>The pagination feature only applies when the priority parameter is set as cobrand. If no values are provided in the skip and top parameters, the API will only return the first 500 records.<li>This service supports the localization feature and accepts locale as a header parameter.<li>The capability has been deprecated in query parameter and response.</li></ol>'
      operationId: getAllProviders
      responses:
        200:
          schema:
            $ref: '#/definitions/ProviderResponse'
          description: OK
        400:
          schema:
            $ref: '#/definitions/YodleeError'
          description: 'Y800 : Invalid value for priority<br>Y800 : Invalid value for providerName<br>Y801 : Invalid length for a site search. The search string must have atleast 1 character<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br>Y820 : The additionalDataSet is not supported for Get provider API'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: capability
        description: CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated
        type: string
        required: false
      - in: query
        allowEmptyValue: false
        name: dataset$filter
        description: Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer.
        type: string
        required: false
      - in: query
        allowEmptyValue: false
        name: fullAccountNumberFields
        description: Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber.
        type: string
        required: false
      - in: query
        allowEmptyValue: false
        name: institutionId
        format: int64
        description: Institution Id for Single site selection
        type: integer
        required: false
      - in: query
        allowEmptyValue: false
        name: name
        description: Name in minimum 1 character or routing number.
        type: string
        required: false
      - in: query
        allowEmptyValue: false
        name: priority
        description: Search priority
        type: string
        required: false
      - in: query
        allowEmptyValue: false
        name: providerId
        description: Max 5 Comma seperated Provider Ids
        type: string
        required: false
      - in: query
        allowEmptyValue: false
        name: skip
        format: int32
        description: skip (Min 0) - This is not applicable along with 'name' parameter.
        type: integer
        required: false
      - in: query
        allowEmptyValue: false
        name: top
        format: int32
        description: top (Max 500) - This is not applicable along with 'name' parameter.
        type: integer
        required: false
      tags:
      - Providers
  /providers/{providerId}:
    get:
      summary: Get Provider Details
      deprecated: false
      produces:
      - application/json;charset=UTF-8
      description: The get provider detail service is used to get detailed information including the login form for a provider.<br>The response is a provider object that includes information such as name of the provider, <br>provider's base URL, a list of containers supported by the provider, the login form details of the provider, etc.<br>Only enabled datasets, attributes and containers gets returned in the response.<br><br><b>Note:</b><li>This service supports the localization feature and accepts locale as a header parameter.<li>The capability has been deprecated in the response.
      operationId: getProvider
      responses:
        200:
          schema:
            $ref: '#/definitions/ProviderDetailResponse'
          description: OK
        400:
          schema:
            $ref: '#/definitions/YodleeError'
          description: 'Y800 : Invalid value for providerId'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: path
        name: providerId
        format: int64
        description: providerId
        type: integer
        required: true
      tags:
      - Providers
  /providers/count:
    get:
      summary: Get Providers Count
      deprecated: false
      produces:
      - application/json;charset=UTF-8
      description: The count service provides the total number of providers that get returned in the GET /providers depending on the input parameters passed.<br>If you are implementing pagination for providers, call this endpoint before calling GET /providers to know the number of providers that are returned for the input parameters passed.<br>The functionality of the input parameters remains the same as that of the GET /providers endpoint<br><br><b>Note:</b> <li>The capability has been deprecated in the query parameter.</li>
      operationId: getProvidersCount
      responses:
        200:
          schema:
            $ref: '#/definitions/ProvidersCountResponse'
          description: OK
        400:
          schema:
            $ref: '#/definitions/YodleeError'
          description: 'Y800 : Invalid value for priority<br>Y800 : Invalid value for providerName<br>Y801 : Invalid length for a site search. The search string must have at least 1 character<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br>Y820 : The additionalDataSet is not supported for Get provider API'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: capability
        description: CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated
        type: string
        required: false
      - in: query
        allowEmptyValue: false
        name: dataset$filter
        description: Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer.
        type: string
        required: false
      - in: query
        allowEmptyValue: false
        name: fullAccountNumberFields
        description: Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber.
        type: string
        required: false
      - in: query
        allowEmptyValue: false
        name: name
        description: Name in minimum 1 character or routing number.
        type: string
        required: false
      - in: query
        allowEmptyValue: false
        name: priority
        description: Search priority
        type: string
        required: false
      tags:
      - Providers
definitions:
  UptimeMetrics:
    type: object
    title: UptimeMetrics
    properties:
      thresholdPercentage:
        description: Value is calculated based on number of site failures and the total successful refreshes performed.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>
        readOnly: true
        type: string
      status:
        description: 'Indicates the alert status for the site. ACCOUNT_LINKING_UNAVAILABLE: If the thresholdPercentage value is >= 100. REFRESH_FAILURE_ATTENTION: If the thresholdPercentage value is >= 90 and < 100.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>'
        readOnly: true
        type: string
  ProvidersDataset:
    type: object
    title: ProvidersDataset
    properties:
      name:
        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>'
        type: string
        enum:
        - BASIC_AGG_DATA
        - ADVANCE_AGG_DATA
        - ACCT_PROFILE
        - DOCUMENT
      attribute:
        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>
        type: array
        items:
          $ref: '#/definitions/Attribute'
  LoginForm:
    type: object
    title: LoginForm
    properties:
      mfaInfoTitle:
        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
        type: string
      help:
        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
        type: string
      forgetPasswordURL:
        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>
        type: string
      formType:
        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>
        type: string
        enum:
        - login
        - questionAndAnswer
        - token
        - image
      mfaInfoText:
        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
        type: string
      loginHelp:
        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
        type: string
      mfaTimeout:
        format: int64
        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>
        readOnly: true
        type: integer
      id:
        format: int64
        description: The identifier of the login form.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>
        type: integer
      row:
        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>
        type: array
        items:
          $ref: '#/definitions/Row'
  ProvidersCountResponse:
    type: object
    title: ProvidersCountResponse
    properties:
      provider:
        readOnly: true
        $ref: '#/definitions/ProvidersCount'
  Row:
    type: object
    title: Row
    properties:
      fieldRowChoice:
        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>'
        type: string
      field:
        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>
        type: array
        items:
          $ref: '#/definitions/Field'
      form:
        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>
        type: string
      id:
        description: Unique identifier of the row.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>
        type: string
      label:
        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>
        type: string
  Field:
    type: object
    title: Field
    properties:
      image:
        description: Image displayed at the endsite.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li></ul>
        type: string
      prefix:
        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
        type: string
      minLength:
        format: int64
        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>
        readOnly: true
        type: integer
      valueEditable:
        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
        type: string
      isOptional:
        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
        type: boolean
      suffix:
        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: string
      type:
        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
        type: string
        enum:
        - text
        - password
        - options
        - checkbox
        - radio
        - image
        - option
      isValueProvided:
        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
        type: boolean
      name:
        description: Name of the field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>
        readOnly: true
        type: string
      id:
        minLength: 1
        description: Identifier for the field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>
        type: string
        maxLength: 2147483647
      value:
        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>
        type: string
      maxLength:
        format: int64
        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>
        readOnly: true
        type: integer
      option:
        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
        type: array
        items:
          $ref: '#/definitions/Option'
  TotalCount:
    type: object
    title: TotalCount
    properties:
      count:
        format: int64
        readOnly: true
        type: integer
  ContainerAttributes:
    type: object
    title: ContainerAttributes
    properties:
      BANK:
        $ref: '#/definitions/TransactionDays'
      LOAN:
        $ref: '#/definitions/TransactionDays'
      CREDITCARD:
        $ref: '#/definitions/TransactionDays'
      INVESTMENT:
        $ref: '#/definitions/TransactionDays'
      INSURANCE:
        $ref: '#/definitions/TransactionDays'
  Option:
    type: object
    title: Option
    properties:
      displayText:
        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>
        type: string
      optionValue:
        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>
        type: string
      isSelected:
        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>
        type: boolean
  ProvidersCount:
    type: object
    title: ProvidersCount
    properties:
      TOTAL:
        readOnly: true
        $ref: '#/definitions/TotalCount'
  Capability:
    type: object
    title: Capability
    properties:
      container:
        readOnly: true
        type: array
        items:
          type: string
          enum:
          - bank
          - creditCard
          - investment
          - insurance
          - loan
          - reward
          - bill
          - realEstate
          - otherAssets
          - otherLiabilities
      name:
        readOnly: true
        type: string
  ProviderResponse:
    type: object
    title: ProviderResponse
    properties:
      provider:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/Providers'
  ProviderDetail:
    type: object
    title: ProviderDetail
    properties:
      languageISOCode:
        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
        type: string
      PRIORITY:
        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
        type: string
        enum:
        - POPULAR
        - SUGGESTED
        - COBRAND
        - SEARCH
        - ALL
      associatedProviderIds:
        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
        type: array
        items:
          format: int64
          type: integer
      isTanSupported:
        description: Indicates if a site supports TAN (Tokenized Account Number)<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>
        readOnly: true
        type: boolean
      capability:
        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
        type: array
        items:
          $ref: '#/definitions/Capability'
      isConsentRequired:
        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
        type: boolean
      loginUrl:
        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
        type: string
      isAutoRefreshEnabled:
        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
        type: boolean
      logo:
        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
        type: string
      authTypetestni:
        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
        type: string
        enum:
        - OAUTH
        - CREDENTIALS
        - MFA_CREDENTIALS
      betaContainers:
        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
        type: array
        items:
          type: string
      id:
        format: int64
        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>
        readOnly: true
        type: integer
      authParameter:
        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
        type: array
        items:
          type: string
          enum:
          - authorizationCode
          - idToken
          - authResponse
          - state
      authType:
        description: The authentication type enabled at the provider site. <br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li><li>GET /dataExtracts/userData</li><li>GET providerAccounts</li><li>GET providerAccounts/{providerAccountId}</li></ul><b>Applicable Values</b><br>
        readOnly: true
        type: string
        enum:
        - OAUTH
        - CREDENTIALS
        - MFA_CREDENTIALS
      favicon:
        description: Favicon link of the provider.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>
        readOnly: true
        type: string
      accountType:
        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
        type: array
        items:
          type: string
          enum:
          - CURRENT
          - BROKERAGE_CASH
      countryISOCode:
        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
        type: string
      isAddedByUser:
        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
        type: string
      primaryLanguageISOCode:
        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
        type: string
      help:
        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
        type: string
      baseUrl:
        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
        type: string
      loginForm:
        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
        type: array
        items:
          $ref: '#/definitions/LoginForm'
      name:
        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
        type: string
      lastModified:
        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
        type: string
      dataset:
        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
        type: array
        items:
          $ref: '#/definitions/ProvidersDataset'
      uptimeMetrics:
        description: Indicates the availability of the site for account linking, login attempt<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>
        readOnly: true
        $ref: '#/definitions/UptimeMetrics'
      status:
        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
        type: string
        enum:
        - Supported
        - Beta
        - Unsupported
  Attribute:
    type: object
    title: Attribute
    properties:
      container:
        description: Containers for which the attributes are supported.<br><br><b>Endpoints</b>:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>
        type: array
        items:
          type: string
          enum:
          - bank
          - creditCard
          - investment
          - insurance
          - loan
          - reward
          - bill
          - realEstate
          - otherAssets
          - otherLiabilities
      fromDate:
        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
        type: string
      toFinYear:
        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
        type: string
      fromFinYear:
        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
        type: string
      containerAttributes:
        description: Applicable only to TRANSACTIONS attributes of BASIC_AGG_DATA dataset.<br><br><b>Endpoints</b>:<ul><li>GET providers</li><li>GET providers/{providerId}</li><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>
        readOnly: true
        $ref: '#/definitions/ContainerAttributes'
      toDate:
        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
        type: string
      name:
        description: Attributes that are supported for a dataset.<br><br><b>Endpoints</b>:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>
        type: string
        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
  ProviderDetailResponse:
    type: object
    title: ProviderDetailResponse
    properties:
      provider:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ProviderDetail'
  Providers:
    type: object
    title: Providers
    properties:
      languageISOCode:
        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
        type: string
      forgetPasswordUrl:
        description: The forget password URL of the provider site.<br><br><b>Endpoints</b>:<ul><li>GET providers</li></ul>
        readOnly: true
        type: string
      PRIORITY:
        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
        type: string
        enum:
        - POPULAR
        - SUGGESTED
        - COBRAND
        - SEARCH
        - ALL
      associatedProviderIds:
        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
        type: array
        items:
          format: int64
          type: integer
      loginHelp:
        description: Help text to guide the user to choose the correct provider site.<br><br><b>Endpoints</b>:<ul><li>GET providers</li></ul>
        readOnly: true
        type: string
      isTanSupported:
        description: Indicates if a site supports TAN (Tokenized Account Number)<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>
        readOnly: true
        type: boolean
      capability:
        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
        type: array
        items:
          $ref: '#/definitions/Capability'
      isConsentRequired:
        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
        type: boolean
      loginUrl:
        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
        type: string
      isAutoRefreshEnabled:
        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
        type: boolean
      logo:
        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
        type: string
      authTypetestni:
        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
        type: string
        enum:
        - OAUTH
        - CREDENTIALS
        - MFA_CREDENTIALS
      betaContainers:
        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
        type: array
        items:
          type: string
      id:
        format: int64
        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>
        readOnly: true
        type: integer
      authParameter:
        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
        type: array
        items:
          type: string
          enum:
          - authorizationCode
          - idToken
          - authResponse
          - state
      authType:
        description: The authentication type enabled at the provider site. <br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li><li>GET /dataExtracts/userData</li><li>GET providerAccounts</li><li>GET providerAccounts/{providerAccountId}</li></ul><b>Applicable Values</b><br>
        readOnly: true
        type: string
        enum:
        - OAUTH
        - CREDENTIALS
        - MFA_CREDENTIALS
      favicon:
        description: Favicon link of the provider.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>
        readOnly: true
        type: string
      accountType:
        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
        type: array
        items:
          type: string
          enum:
          - CURRENT
          - BROKERAGE_CASH
      countryISOCode:
        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
        type: string
      isAddedByUser:
        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
        type: string
      primaryLanguageISOCode:
        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
        type: string
      help:
        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
        type: string
      baseUrl:
        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
        type: string
      name:
        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
        type: string
      lastModified:
        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
        type: string
      dataset:
        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
        type: array
        items:
          $ref: '#/definitions/ProvidersDataset'
      uptimeMetrics:
        description: Indicates the availability of the site for account linking, login attempt<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>
        readOnly: true
        $ref: '#/definitions/UptimeMetrics'
      status:
        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
        type: string
        enum:
        - Supported
        - Beta
        - Unsupported
  TransactionDays:
    type: object
    title: TransactionDays
    properties:
      fullAccountNumberFields:
        type: array
        items:
          type: string
          enum:
          - paymentAccountNumber
          - unmaskedAccountNumber
      numberOfTransactionDays:
        format: int32
        type: integer
  YodleeError:
    type: object
    title: YodleeError
    properties:
      errorMessage:
        description: The descriptive message that explains the error scenario.
        readOnly: true
        type: string
      errorCode:
        description: The error code follows the format YNNN. The error codes do not change. New error codes may be added as we introduce new features and enhance functionalities.
        readOnly: true
        type: string
      referenceCode:
        description: Unique Yodlee identifier used to troubleshoot issues at Yodlee's end.
        readOnly: true
        type: string