Operations 8
Documentation
Documentation
https://developer.yodlee.com/resources/yodlee/yodlee-api-overview/docs/overview
GettingStarted
https://developer.yodlee.com/docs/getting-started
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/yodlee-provideraccounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.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 Provider Accounts API
version: 1.1.0
servers:
- url: /
tags:
- name: ProviderAccounts
description: Provider Accounts API
paths:
/providerAccounts/{providerAccountId}/preferences:
put:
summary: Update Preferences
deprecated: false
description: This endpoint is used to update preferences like data extracts and auto refreshes without triggering refresh for the providerAccount.<br>Setting isDataExtractsEnabled to false will not trigger data extracts notification and dataExtracts/events will not reflect any data change that is happening for the providerAccount.<br>Modified data will not be provided in the dataExtracts/userData endpoint.<br>Setting isAutoRefreshEnabled to false will not trigger auto refreshes for the provider account.<br>
operationId: updatePreferences
responses:
400:
description: 'Y800 : Invalid value for preferences<br>Y800 : Invalid value for preferences.isDataExtractsEnabled<br>Y800 : Invalid value for preferences.isAutoRefreshEnabled<br>Y807 : Resource not found<br>Y830 : Data extracts feature has to be enabled to set preferences.isDataExtractsEnabled as true<br>Y830 : Auto refresh feature has to be enabled to set preferences.isAutoRefreshEnabled as true<br>Y868 : No action is allowed, as the data is being migrated to the Open Banking provider<br>'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
204:
description: OK
404:
description: Not Found
parameters:
- in: path
name: providerAccountId
description: providerAccountId
required: true
schema:
type: integer
format: int64
tags:
- ProviderAccounts
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderAccountPreferencesRequest'
description: preferences
required: true
/providerAccounts/{providerAccountId}:
get:
summary: Get Provider Account Details
deprecated: false
description: The get provider account details service is used to learn the status of adding accounts and updating accounts.<br>This service has to be called continuously to know the progress level of the triggered process. This service also provides the MFA information requested by the provider site.<br>When <i>include = credentials</i>, questions is passed as input, the service returns the credentials (non-password values) and questions stored in the Yodlee system for that provider account. <br><br><b>Note:</b> <li>The password and answer fields are not returned in the response.</li>
operationId: getProviderAccount
responses:
200:
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ProviderAccountDetailResponse'
400:
description: 'Y800 : Invalid value for providerAccountId<br>Y816 : questions can only be requested for questionAndAnswer Supported Sites'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: query
allowEmptyValue: false
name: include
description: include credentials,questions
required: false
schema:
type: string
- in: path
name: providerAccountId
description: providerAccountId
required: true
schema:
type: integer
format: int64
- in: query
allowEmptyValue: false
name: requestId
description: The unique identifier for the request that returns contextual data
required: false
schema:
type: string
tags:
- ProviderAccounts
delete:
summary: Delete Provider Account
deprecated: false
description: The delete provider account service is used to delete a provider account from the Yodlee system. This service also deletes the accounts that are created in the Yodlee system for that provider account. <br>This service does not return a response. The HTTP response code is 204 (Success with no content).<br>
operationId: deleteProviderAccount
responses:
200:
description: OK
400:
description: 'Y800 : Invalid value for providerAccountId<br>Y868 : No action is allowed, as the data is being migrated to the Open Banking provider<br>'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: path
name: providerAccountId
description: providerAccountId
required: true
schema:
type: integer
format: int64
tags:
- ProviderAccounts
/providerAccounts:
post:
summary: Add Account
deprecated: false
description: 'The add account service is used to link the user''s account with the provider site in the Yodlee system. Providers that require multifactor authentication or open banking are also supported by this service. The response includes the Yodlee generated ID (providerAccountId) of the account along with the refresh information.<br><br>Open Banking Implementation Notes: <br>To link the user''s account of the Open Banking provider site in the Yodlee system, pass the field entity that contains:<br>1. id - From the authParameters provided in the get provider details service<br>2. value - From the redirect URL of the Open Banking site<br><br>Credential-based Implementation Notes: <br>1. The loginForm or the field array are the objects under the provider object, obtained from the <a href="https://developer.yodlee.com/products/yodlee/link-account-apis/docs/api-reference#link-account-apis-provideraccountsprovideraccountid-get">Get Provider Details</a> service response.<br>2. The credentials provided by the user should be embedded in the loginForm or field array object.<br>3. While testing the <a href="https://developer.yodlee.com/KnowledgeBase/How_to_use_PKI">PKI feature</a>, encrypt the credentials using the <a href="https://developer.yodlee.com/products/yodlee/link-account-apis/docs/rsa-encryption-utility">Encryption Utility</a>.<br>4. The data to be retrieved from the provider site can be passed using datasetName or dataset. If datasetName is passed, all the attributes that are implicitly configured for the dataset will be retrieved.<br>5. If the customer has not subscribed to the REFRESH event webhooks notification for accounts that require multifactor authentication (MFA), the get providerAccount service has to be called continuously till the login form (supported types are token, question & answer, and captcha) is returned in the response.<br>6. The <a href="https://developer.yodlee.com/products/yodlee/link-account-apis/docs/api-reference#link-account-apis-provideraccounts-put">Update Account</a> service should be called to post the MFA information to continue adding the account.<br><br>Generic Implementation Notes:<br>1. Refer to the <a href="https://developer.yodlee.com/products/yodlee/link-account-apis/docs/credential-based-aggregation#documentation-anchor--6">Add Account</a> flow chart for implementation.<br>2. The get provider account details has <a href="https://developer.yodlee.com/products/yodlee/link-account-apis/docs/refresh-webhooks">Webhooks Support</a>. If the customer has subscribed to the REFRESH event notification and has invoked this service to add an account, relevant notifications will be sent to the callback URL.<br>3. If you had not subscribed for notifications, the <a href="https://developer.yodlee.com/products/yodlee/link-account-apis/docs/api-reference#link-account-apis-provideraccounts-get">Get Provider Account</a> details service has to be polled continuously till the account addition status is FAILED or PARTIAL_SUCCESS or SUCCESS. <br>4. A dataset may depend on another dataset for retrieval, so the response will include the requested datasets and the dependent datasets.<br> It is necessary to check all the dataset additional statuses returned in the response, as the provider account status is drawn from the dataset additional statuses.<br>5. Pass linkedProviderAccountId in the input to link a user''s credential-based providerAccount with the open banking providerAccount. Ensure that the credential-based providerAccount belongs to the same institution. <br>6. The content type has to be passed as application/json in the body parameter. <br>7. Only for the REDSYS/PSD2 UK OB integration, passing the state parameter is mandatory during the add or update account process. The state parameter key can be found in the authParameter attribute of the get provider or get provider details API response. The value for the state parameter is present in the Authorization URL. Append the callback URL to the state parameter while adding or updating an account.<br>8. configName is included as an optional parameter in the body of the request, which is used to enable the billing metrics for the customers based on the instance configs, when logged in with client credentials.'
operationId: linkProviderAccount
responses:
200:
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/AddedProviderAccountResponse'
400:
description: 'Y803 : providerId is mandatory<br>Y803 : Invalid value for credentialsParam<br>Y400 : id and value in credentialsParam are mandatory<br>Y901 : Service not supported'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: query
allowEmptyValue: false
name: providerId
description: providerId
required: true
schema:
type: integer
format: int64
tags:
- ProviderAccounts
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderAccountRequest'
description: loginForm or field entity
required: true
get:
summary: Get Provider Accounts
deprecated: false
description: The get provider accounts service is used to return all the provider accounts added by the user. <br>This includes the failed and successfully added provider accounts.<br>
operationId: getAllProviderAccounts
responses:
200:
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ProviderAccountResponse'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: query
name: include
description: include
required: false
schema:
type: string
- in: query
allowEmptyValue: false
name: providerIds
description: Comma separated providerIds.
required: false
schema:
type: string
tags:
- ProviderAccounts
put:
summary: Update Account
deprecated: false
description: '<b>Credential-based Implementation Notes:</b> <br>The update account API is used to: • Retrieve the latest information for accounts that belong to one providerAccount from the provider site. You must allow at least 15 min between requests. <br> • Update account credentials when the user has changed the authentication information at the provider site. <br> • Post MFA information for the MFA-enabled provider accounts during add and update accounts. <br> • Retrieve the latest information of all the eligible accounts that belong to the user. <br><br><b>Edit Credentials - Notes: </b> <br> • If credentials have to be updated in the Yodlee system, one of the following should be provided: <br> ◦ LoginForm <br> ◦ Field array <br> • LoginForm or the field array, can be obtained from the GET providerAccounts/{providerAccountId}?include=credentials API response. <br> • The credentials provided by the user should be embedded in the loginForm or field array object before you pass to this API. <br><b>Posting MFA Info - Notes: </b> <br>1. You might receive the MFA request details to be presented to the end user in the GET providerAccounts/{providerAccount} API during polling or through REFRESH webhooks notificaiton. <br>2. After receiving the inputs from your user: <br> a.Embed the MFA information provided by the user in the loginForm or field array object.<br> b.Pass one of the following objects as input to this API:<br> • LoginForm<br> • Field array<br/><br><b>Points to consider:</b><br>• Data to be retrieved from the provider site can be overridden using datasetName or dataset. If you do pass datasetName, all the datasets that are implicitly configured for <br>the dataset will be retrieved. This action is allowed for edit credentials and single provider account refresh flows only. <br>• Encrypt the credentials and MFA information using the public key.<br>• While testing the PKI feature in sandbox environment, encrypt the password credentials and answers to the MFA questions using the encryption tool.<br/><br><b>--------------------------------------------------------------------------------------------------------------------------------</b><br><b>Open Banking (OB)-based Authentication - Notes:</b><br>The update account API is used to:<br>• Retrieve the latest information for accounts from the provider site.<br>• Update the renewed consent for an existing provider account.<br>• Retrieve the latest information for all the eligible accounts that belong to the user.<br/><br>Yodlee recommendations: <br/>• Create the field entity with the authParameters provided in the get provider details API.<br>• Populate the field entity with the values received from the OB site and pass it to this API.<br/><br><b>--------------------------------------------------------------------------------------------------------------------------------</b><br><b>Update All Eligible Accounts - Notes: </b><br>• This API will trigger a refresh for all the eligible provider accounts(both OB and credential-based accounts).<br>• This API will not refresh closed, inactive, or UAR accounts, or accounts with refreshes in-progress or recently refreshed non-OB accounts.<br>• No parameters should be passed to this API to trigger this action.<br>• Do not call this API often. Our recommendation is to call this only at the time the user logs in to your app because it can hamper other API calls performance. <br>• The response only contains information for accounts that were refreshed. If no accounts are eligible for refresh, no response is returned.<br/><br><b>--------------------------------------------------------------------------------------------------------------------------------</b><br><b>What follows are common to both OB and credential-based authentication implementations: </b><br>• Check the status of the providerAccount before invoking this API. Do not call this API to trigger any action on a providerAccount when an action is already in progress for the providerAccount. <br>• If the customer has subscribed to the REFRESH event notification and invoked this API, relevant notifications will be sent to the customer.<br>• A dataset may depend on another dataset for retrieval, so the response will include the requested and dependent datasets.<br>• Check all the dataset additional statuses returned in the response because the provider account status is drawn from the dataset additional statuses.<br>• Updating preferences using this API will trigger refreshes.<br>• Pass linkedProviderAccountId in the input to link a user''s credential-based providerAccount with the OB providerAccount or viceversa. Ensure that the both the providerAccounts belong to the same institution. <br>• The content type has to be passed as application/json for the body parameter.<br>• configName is included as an optional parameter in the body of the request, which is used to enable the billing metrics for the customers based on the instance configs, when logged in with client credentials.<br><b>--------------------------------------------------------------------------------------------------------------------------------</b><br><b>Note:</b>Only for the REDSYS/PSD2 UK OB integration, passing the state parameter is mandatory during the add or update account process. The state parameter key can be found in the authParameter attribute of the get provider or get provider details API response. The value for the state parameter is present in the Authorization URL. Append the callback URL to the state parameter while adding or updating an account.'
operationId: editCredentialsOrRefreshProviderAccount
responses:
200:
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/UpdatedProviderAccountResponse'
400:
description: 'Y805 : Multiple providerAccountId not supported for updating credentials<br>Y800 : Invalid value for credentialsParam<br>Y400 : id and value in credentialsParam are mandatory<br>Y806 : Invalid input<br>Y823 : Credentials are not applicable for real estate aggregated / manual accounts<br>Y868 : No action is allowed, as the data is being migrated to the Open Banking provider<br>'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: query
allowEmptyValue: false
name: providerAccountIds
description: comma separated providerAccountIds
required: true
schema:
type: string
tags:
- ProviderAccounts
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderAccountRequest'
description: loginForm or field entity
/providerAccounts/refresh:
put:
summary: Refresh Provider Account
deprecated: false
description: 'This api service will allow you to refresh the Non-MFA provider accounts against a configName, i.e refresh will respect the configurations of the configName while refreshing the account.<br>Note: this service will only work with FastLink 4 users.<br>'
operationId: refreshProviderAccount
responses:
201:
description: CREATED
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/RefreshProviderAccountResponse'
400:
description: 'Y800 : Invalid value for configName<br>Y803 : configName required<br>Y812 : Required field/value providerAccountId missing in the request<br>Y800 : Invalid value for providerAccountId<br>Y825 : Update not allowed. Reason: providerAccountId {id} REFRESHED_RECENTLY<br>'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
404:
description: Not Found
tags:
- ProviderAccounts
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderAccountRefreshRequest'
description: refreshRequest
required: true
/providerAccounts/profile:
get:
summary: Get User Profile Details
deprecated: true
description: <b>Refer GET /verification/holderProfile</b><br>The get provider accounts profile service is used to return the user profile details that are associated to the provider account. <br>
operationId: getProviderAccountProfiles
responses:
200:
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ProviderAccountUserProfileResponse'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: query
allowEmptyValue: false
name: providerAccountId
description: Comma separated providerAccountIds.
required: false
schema:
type: string
tags:
- ProviderAccounts
components:
schemas:
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: '#/components/schemas/Option'
ProviderAccountPreferences:
type: object
title: ProviderAccountPreferences
properties:
isDataExtractsEnabled:
description: Indicates if the updates to the provider account should be part of the data extracts event notification or the data extract data retrieval service.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts?include=preferences</li><li>GET providerAccounts/{providerAccountId}?include=preferences</li></ul>
type: boolean
linkedProviderAccountId:
format: int64
description: LinkedproviderAccountd is a providerAccountId linked by the user to the primary provider account. <br>LinkedProviderAccountId and the providerAccountId belongs to the same institution.<br><br><b>Endpoints</b>:<ul><li>POST Provider Account</li><li>PUT Provider Account</li><li>GET Provider Accounts</li></ul>
type: integer
isAutoRefreshEnabled:
description: Indicates if auto-refreshes have to be triggered for the provider account.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts?include=preferences</li><li>GET providerAccounts/{providerAccountId}?include=preferences</li></ul>
type: boolean
ProviderAccountUserProfileResponse:
type: object
title: ProviderAccountUserProfileResponse
properties:
providerAccount:
readOnly: true
type: array
items:
$ref: '#/components/schemas/ProviderAccountProfile'
AddedProviderAccount:
type: object
title: AddedProviderAccount
properties:
lastUpdated:
description: 'Indicate when the providerAccount is last updated successfully.<br><br><b>Account Type</b>: Aggregated<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>'
readOnly: true
type: string
aggregationSource:
description: The source through which the providerAccount is added in the system.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>
readOnly: true
type: string
enum:
- SYSTEM
- USER
oauthMigrationStatus:
description: Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>GET providerAccounts/{providerAccountId}</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>
readOnly: true
type: string
enum:
- IN_PROGRESS
- TO_BE_MIGRATED
- COMPLETED
- MIGRATED
providerId:
format: int64
description: Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>
readOnly: true
type: integer
requestId:
description: Unique id generated to indicate the request.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>
readOnly: true
type: string
isManual:
description: Indicates whether account is a manual or aggregated provider account.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>
readOnly: true
type: boolean
id:
format: int64
description: Unique identifier for the provider account resource. This is created during account addition.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>
readOnly: true
type: integer
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
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 providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>
readOnly: true
type: array
items:
$ref: '#/components/schemas/AccountDataset'
status:
description: The status of last update attempted for the account. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>
readOnly: true
type: string
enum:
- LOGIN_IN_PROGRESS
- USER_INPUT_REQUIRED
- IN_PROGRESS
- PARTIAL_SUCCESS
- SUCCESS
- FAILED
- MIGRATION_IN_PROGRESS
- DATA_RETRIEVAL_FAILED
Email:
type: object
title: Email
properties:
type:
readOnly: true
type: string
enum:
- PRIMARY
- SECONDARY
- PERSONAL
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yodlee/refs/heads/main/openapi/yodlee-provideraccounts-api-openapi.yml