diff --git a/swagger.yaml b/swagger.yaml index c737a91..a43b156 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -7,7 +7,7 @@ paths: deprecated: false produces: - "application/json;charset=UTF-8" - description: "The Transaction service is used to get a list of transactions for a user.
By default, this service returns the last 30 days of transactions from today's date.
The keyword parameter performs a contains search on the original, consumer, and simple description attributes, replace the special characters #, &, and + with percent-encoding values %23, %26, and %2B respectively. Eg: for -Debit# , pass the input as -Debit%23.
Values for categoryId parameter can be fetched from get transaction category list service.
The categoryId is used to filter transactions based on system-defined category as well as user-defined category.
User-defined categoryIds should be provided in the filter with the prefix ''U''. E.g. U10002
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. The response header provides the links to retrieve the next and previous set of transactions.
Double quotes in the merchant name will be prefixed by backslashes (\) in the response, e.g. Toys \"R\" Us.
sourceId is a unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts. Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.

Note" + description: "The Transaction service is used to get a list of transactions for a user.
By default, this service returns the last 30 days of transactions from today's date.
API will only return up to 2 years of transaction history. If the difference between fromDate and toDate is more than 2 years, API will return only last 2 years from the toDate.
The keyword parameter performs a contains search on the original, consumer, and simple description attributes, replace the special characters #, &, and + with percent-encoding values %23, %26, and %2B respectively. Eg: for -Debit# , pass the input as -Debit%23.
Values for categoryId parameter can be fetched from get transaction category list service.
The categoryId is used to filter transactions based on system-defined category as well as user-defined category.
User-defined categoryIds should be provided in the filter with the prefix ''U''. E.g. U10002
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. The response header provides the links to retrieve the next and previous set of transactions.
Double quotes in the merchant name will be prefixed by backslashes (\) in the response, e.g. Toys \"R\" Us.
sourceId is a unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts. Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.

Note" operationId: "getTransactions" responses: 200: @@ -17,7 +17,7 @@ paths: 400: schema: $ref: "#/definitions/YodleeError" - description: "Y800 : Invalid value for baseType
Y800 : Invalid value for fromDate
Y800 : Invalid value for category
Y800 : Invalid value for toDate
Y800 : Invalid value for container
Y809 : Invalid date range
Y804 : Permitted values of top between 1 - 500
Y805 : Multiple containers not supported
Y800 : Invalid value for transaction type
Y824 : The maximum number of accountIds permitted is 100
Y824 : The maximum number of categoryIds permitted is 100
Y824 : The maximum number of highLevelCategoryIds permitted is 100
Y848 : detailCategoryId cannot be provided as input, as the detailedCategory feature is not enabled
Y823 : detailCategoryId is not for applicable containers other than bank and card
Y824 : The maximum number of detailCategoryIds permitted is 100
Y800 : Invalid value for detailCategoryId" + description: "Y800 : Invalid value for baseType
Y800 : Invalid value for fromDate
Y800 : Invalid value for category
Y800 : Invalid value for toDate
Y800 : Invalid value for container
Y809 : Invalid date range
Y804 : Permitted values of top between 1 - 500
Y805 : Multiple containers not supported
Y800 : Invalid value for transaction type
Y824 : The maximum number of accountIds permitted is 100
Y824 : The maximum number of categoryIds permitted is 100
Y824 : The maximum number of highLevelCategoryIds permitted is 100
Y848 : detailCategoryId cannot be provided as input, as the detailedCategory feature is not enabled
Y823 : detailCategoryId is not for applicable containers other than bank and card
Y824 : The maximum number of detailCategoryIds permitted is 100
Y800 : Invalid value for detailCategoryId
Y800 : Invalid value for convertToCurrency
Y820 : The currency value is not supported for convertToCurrency
" 401: description: "Unauthorized" 404: @@ -44,7 +44,7 @@ paths: - in: "query" allowEmptyValue: false name: "categoryType" - description: "Transaction Category Type(UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)" + description: "Transaction Category Type(LOAN, UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)" type: "string" required: false - in: "query" @@ -53,6 +53,12 @@ paths: description: "bank/creditCard/investment/insurance/loan" type: "string" required: false + - in: "query" + allowEmptyValue: false + name: "convertToCurrency" + description: "On-demand currency conversion parameter" + type: "string" + required: false - in: "query" allowEmptyValue: false name: "detailCategoryId" @@ -166,7 +172,7 @@ paths: - in: "query" allowEmptyValue: false name: "isSelected" - description: "Comma separated isSelected. Allowed values are true, false
Note: If no value is passed, the implicit default value is true." + description: "Comma separated isSelected. Allowed values are true, false.
" type: "string" required: false - in: "query" @@ -509,6 +515,48 @@ paths: - "CREDIT_ACCELERATOR_REPORT_UPDATES" tags: - "Configs" + /consents/history/count: + get: + summary: "Get Consent History Count" + deprecated: false + produces: + - "application/json;charset=UTF-8" + description: "The count service provides the total number of history records for a specific consent.
If you are implementing pagination for consent history, call this endpoint before calling GET /consents/history to know the number of records for the given consent that are returned for the input parameters passed.
" + operationId: "getConsentHistoryCount" + responses: + 200: + schema: + $ref: "#/definitions/ConsentHistoryCountResponse" + description: "OK" + 400: + schema: + $ref: "#/definitions/YodleeError" + description: "Y800 : Invalid value for consentId
Y803 : consentId is required
Y800 : Invalid value for fromDate
Y800 : Invalid value for toDate
Y809 : Invalid date range
" + 401: + description: "Unauthorized" + 404: + description: "Not Found" + parameters: + - in: "query" + allowEmptyValue: false + name: "consentId" + description: "Consent Id generated through POST Consent." + type: "string" + required: true + - in: "query" + allowEmptyValue: false + name: "fromDate" + description: "Consent History from date(YYYY-MM-DD)" + type: "string" + required: false + - in: "query" + allowEmptyValue: false + name: "toDate" + description: "Consent History end date (YYYY-MM-DD)" + type: "string" + required: false + tags: + - "Consents" /providers/count: get: summary: "Get Providers Count" @@ -637,6 +685,62 @@ paths: required: false tags: - "Derived" + /consents/history: + get: + summary: "Get Consent History " + deprecated: false + produces: + - "application/json;charset=UTF-8" + description: "The get consent history service is used to retrieve all the history related to the consent.
All history event details for few fields like userDataPurge, deidentificationPreference and consentCollectionPeriod may not be available for older AU Open Banking consents and other Open Banking regions.
For any consent, history will be captured and available from consent authorization (consent status Active) event onwards.
Note:
i. Duration (fromDate and toDate) is optional. In the absence of duration, one year history is retrieved from today's date.
ii. The pagination feature is available by default. If no values are passed in the skip and top parameters, the API will only return the first 500 records.
" + operationId: "getConsentHistory" + responses: + 200: + schema: + $ref: "#/definitions/ConsentHistoryResponse" + description: "OK" + 400: + schema: + $ref: "#/definitions/YodleeError" + description: "Y800 : Invalid value for consentId
Y803 : consentId is required
Y804 : Permitted values of top between 1 - 500
Y800 : Invalid value for skip
Y800 : Invalid value for fromDate
Y800 : Invalid value for toDate
Y809 : Invalid date range
" + 401: + description: "Unauthorized" + 404: + description: "Not Found" + parameters: + - in: "query" + allowEmptyValue: false + name: "consentId" + description: "Consent Id generated through POST Consent." + type: "string" + required: true + - in: "query" + allowEmptyValue: false + name: "fromDate" + description: "Consent History from date(YYYY-MM-DD)" + type: "string" + required: false + - in: "query" + allowEmptyValue: false + name: "skip" + format: "int32" + description: "skip (Min 0)" + type: "integer" + required: false + - in: "query" + allowEmptyValue: false + name: "toDate" + description: "Consent History end date (YYYY-MM-DD)" + type: "string" + required: false + - in: "query" + allowEmptyValue: false + name: "top" + format: "int32" + description: "top (Max 500)" + type: "integer" + required: false + tags: + - "Consents" /user/samlLogin: post: summary: "Saml Login" @@ -1193,7 +1297,7 @@ paths: deprecated: false produces: - "application/json;charset=UTF-8" - description: "The update user details service is used to update user details like name, address, currency preference, etc.
Currency provided in the input will be respected in the derived services and the amount fields in the response will be provided in the preferred currency.
The HTTP response code is 204 (Success without content).

Login Name Change Feature: loginName can be passed to update the user’s login name. Once the loginName is updated, to access the user's data, a token with the changed loginName must be created. This feature is supported only Client Credentials authentication methods.
Note:
  • We strongly recommend to immediately delete the old access token once the user’s loginName is successfully changed to avoid misuse.
  • After updating the login name, the already sent data extract events with the old login name will no more be functional. Replace the loginName with new loginName or try polling method to retrieve the data.

    • " + description: "The update user details service is used to update user details like name, address, currency preference, etc.
    Currency provided in the input will be respected in the derived services and the amount fields in the response will be provided in the preferred currency.
    The HTTP response code is 204 (Success without content).

    Login Name Change Feature: loginName can be passed to update the user's login name. Once the loginName is updated, to access the user's data, a token with the changed loginName must be created. This feature is supported only Client Credentials authentication methods.
    Note:
  • We strongly recommend to immediately delete the old access token once the user's loginName is successfully changed to avoid misuse.
  • After updating the login name, the already sent data extract events with the old login name will no more be functional. Replace the loginName with new loginName or try polling method to retrieve the data.

    • " operationId: "updateUser" responses: 401: @@ -1278,6 +1382,12 @@ paths: description: "bank/creditCard/investment/insurance/loan/reward/realEstate/otherAssets/otherLiabilities" type: "string" required: false + - in: "query" + allowEmptyValue: false + name: "convertToCurrency" + description: "On-demand currency conversion parameter" + type: "string" + required: false - in: "query" allowEmptyValue: false name: "include" @@ -1518,7 +1628,7 @@ paths: deprecated: false produces: - "application/json;charset=UTF-8" - 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.

    Open Banking Implementation Notes:
    To link the user's account of the Open Banking provider site in the Yodlee system, pass the field entity that contains:
    1. id - From the authParameters provided in the get provider details service
    2. value - From the redirect URL of the Open Banking site

    Credential-based Implementation Notes:
    1. The loginForm or the field array are the objects under the provider object, obtained from the get provider details service response.
    2. The credentials provided by the user should be embedded in the loginForm or field array object.
    3. While testing the PKI feature, encrypt the credentials using the encryption utility.
    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.
    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.
    6. The update account service should be called to post the MFA information to continue adding the account.

    Generic Implementation Notes:
    1. Refer to the add account flow chart for implementation.
    2. The get provider account details has webhooks support. 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.
    3. If you had not subscribed for notifications, the get provider account details service has to be polled continuously till the account addition status is FAILED or PARTIAL_SUCCESS or SUCCESS.
    4. A dataset may depend on another dataset for retrieval, so the response will include the requested datasets and the dependent datasets.
    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.
    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.
    6. The content type has to be passed as application/json in the body parameter.
    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." + 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.

    Open Banking Implementation Notes:
    To link the user's account of the Open Banking provider site in the Yodlee system, pass the field entity that contains:
    1. id - From the authParameters provided in the get provider details service
    2. value - From the redirect URL of the Open Banking site

    Credential-based Implementation Notes:
    1. The loginForm or the field array are the objects under the provider object, obtained from the Get Provider Details service response.
    2. The credentials provided by the user should be embedded in the loginForm or field array object.
    3. While testing the PKI feature, encrypt the credentials using the Encryption Utility.
    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.
    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.
    6. The Update Account service should be called to post the MFA information to continue adding the account.

    Generic Implementation Notes:
    1. Refer to the Add Account flow chart for implementation.
    2. The get provider account details has Webhooks Support. 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.
    3. If you had not subscribed for notifications, the Get Provider Account details service has to be polled continuously till the account addition status is FAILED or PARTIAL_SUCCESS or SUCCESS.
    4. A dataset may depend on another dataset for retrieval, so the response will include the requested datasets and the dependent datasets.
    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.
    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.
    6. The content type has to be passed as application/json in the body parameter.
    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." operationId: "linkProviderAccount" responses: 200: @@ -1655,7 +1765,7 @@ paths: - in: "query" allowEmptyValue: false name: "categoryType" - description: "INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION" + description: "LOAN, INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION" type: "string" required: false - in: "query" @@ -1739,7 +1849,7 @@ paths: - in: "query" allowEmptyValue: false name: "categoryType" - description: "Transaction Category Type(UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)" + description: "Transaction Category Type(LOAN, UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)" type: "string" required: false - in: "query" @@ -2074,6 +2184,12 @@ paths: description: "accountId" type: "integer" required: true + - in: "query" + allowEmptyValue: false + name: "convertToCurrency" + description: "On-demand currency conversion parameter" + type: "string" + required: false - in: "query" allowEmptyValue: false name: "include" @@ -2577,6 +2693,41 @@ paths: tags: - "Cobrand" /holdings: + post: + summary: "Add Holding" + deprecated: false + produces: + - "application/json;charset=UTF-8" + description: "The add manual holding service is used to add manual holdings. The response of add manual holding service includes the Yodlee generated holding id.

    Add manual holding can only be added to a manual account of investment type container only." + operationId: "addHolding" + responses: + 200: + schema: + $ref: "#/definitions/HoldingIdListResponse" + description: "OK" + 201: + schema: + $ref: "#/definitions/HoldingIdListResponse" + description: "Created Successfully" + 400: + schema: + $ref: "#/definitions/YodleeError" + description: "Y800 : Invalid value for accountId
    Y800 : Invalid value for symbol
    Y800 : Invalid value for exercisedQuantity
    Y800 : Invalid value for cusipNumber
    Y800 : Invalid value for vestedQuantity
    Y800 : Invalid value for unvestedValue
    Y800 : Invalid value for vestedValue
    Y800 : Invalid value for option
    Y800 : Invalid value for holdingType
    Y800 : Invalid value for maturityDate
    Y800 : Invalid value for price
    Y800 : Invalid value for term
    Y800 : Invalid value for contractQuantity
    Y800 : Invalid value for isShort
    Y800 : Invalid value for value
    Y800 : Invalid value for expirationDate
    Y800 : Invalid value for interestRate
    Y800 : Invalid value for quantity
    Y800 : Invalid value for grantDate
    Y800 : Invalid value for sedol
    Y800 : Invalid value for vestedSharesExercisable
    Y800 : Invalid value for spread
    Y800 : Invalid value for couponRate
    Y800 : Invalid value for unvestedQuantity
    Y800 : Invalid value for costBasis
    Y800 : Invalid value for vestingDate
    Y800 : Invalid value for isin
    Y800 : Invalid value for strikePrice
    Y801 : Invalid length for symbol
    Y801 : Invalid length for term
    Y801 : Invalid length for description
    Y801 : Required field/value - description missing in the request
    Y812 : Required field/value - accountId missing in the request
    " + 401: + description: "Unauthorized" + 404: + description: "Not Found" + parameters: + - schema: + $ref: "#/definitions/HoldingRequest" + in: "body" + name: "addHoldingRequest" + description: "addHoldingRequest" + required: true + tags: + - "Holdings" + consumes: + - "application/json" get: summary: "Get Holdings" deprecated: false @@ -3165,7 +3316,7 @@ paths: deprecated: false produces: - "application/json;charset=UTF-8" - description: "The get extracts events service is used to learn about occurrences of data extract related events. This service currently supports only the DATA_UPDATES event.
    Passing the event name as DATA_UPDATES provides information about users for whom data has been modified in the system for the specified time range. To learn more, please refer to the dataExtracts page.
    You can retrieve data in increments of no more than 60 minutes over the period of the last 7 days from today's date.
    This service is only invoked with either admin access token or a cobrand session.
    " + description: "The get extracts events service is used to learn about occurrences of data extract related events. This service currently supports only the DATA_UPDATES event.
    Passing the event name as DATA_UPDATES provides information about users for whom data has been modified in the system for the specified time range. To learn more, please refer to the Data Extracts page.
    You can retrieve data in increments of no more than 60 minutes over the period of the last 7 days from today's date.
    This service is only invoked with either admin access token or a cobrand session.
    " operationId: "getDataExtractsEvents" responses: 200: @@ -3371,6 +3522,14 @@ definitions: description: "Unique identifier for the provider account resource. This is created during account addition.

    Endpoints:" readOnly: true type: "integer" + authType: + description: "The authentication type enabled at the provider site.

    Endpoints:Applicable Values
    " + 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.

    Endpoints:" readOnly: true @@ -3449,6 +3608,13 @@ definitions: type: "array" items: $ref: "#/definitions/AssetClassificationList" + ConsentHistoryCount: + type: "object" + title: "ConsentHistoryCount" + properties: + TOTAL: + readOnly: true + $ref: "#/definitions/TotalCount" ClassificationSummaryTransactionSummary: type: "object" title: "ClassificationSummaryTransactionSummary" @@ -4162,6 +4328,14 @@ definitions: description: "Unique identifier for the provider account resource. This is created during account addition.

    Endpoints:" readOnly: true type: "integer" + authType: + description: "The authentication type enabled at the provider site.

    Endpoints:Applicable Values
    " + 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.

    Endpoints:" readOnly: true @@ -4279,6 +4453,15 @@ definitions: type: "array" items: $ref: "#/definitions/CreateConsent" + ConsentHistoryResponse: + type: "object" + title: "ConsentHistoryResponse" + properties: + consentHistory: + readOnly: true + type: "array" + items: + $ref: "#/definitions/ConsentHistory" UpdateAccountRequest: type: "object" title: "UpdateAccountRequest" @@ -4487,27 +4670,6 @@ definitions: description: "The forget password URL of the provider site.

    Endpoints:" readOnly: true type: "string" - favicon: - description: "Favicon link of the provider.

    Endpoints:" - readOnly: true - type: "string" - accountType: - description: "AccountType supported by the provider, eg: Brokerage Cash, Current

    Endpoints:" - readOnly: true - type: "array" - items: - type: "string" - enum: - - "CURRENT" - - "BROKERAGE_CASH" - countryISOCode: - description: "Country to which the provider belongs.

    Endpoints:" - readOnly: true - type: "string" - isAddedByUser: - description: "Indicates that the site has been added by the user at least once.

    Endpoints:" - readOnly: true - type: "string" PRIORITY: description: "Indicates the priority for which the service is invoked.

    Endpoints:Applicable Values
    " readOnly: true @@ -4529,18 +4691,6 @@ definitions: description: "Help text to guide the user to choose the correct provider site.

    Endpoints:" readOnly: true type: "string" - primaryLanguageISOCode: - description: "The primary language of the site.

    Endpoints:" - readOnly: true - type: "string" - help: - description: "Text to guide user through linking an account that belongs to the site

    Endpoints:" - readOnly: true - type: "string" - baseUrl: - description: "The base URL of the provider's site.

    Endpoints:" - readOnly: true - type: "string" capability: description: "Capability of the site

    Endpoints:
    Note : capability has been deprecated" readOnly: true @@ -4559,23 +4709,21 @@ definitions: description: "Indicates if a provider site is auto-refreshed.

    Endpoints:" readOnly: true type: "boolean" - name: - description: "The name of a provider site.

    Endpoints:" - readOnly: true - type: "string" logo: description: "The logo link of the provider institution. The link will return the logo in the PNG format.

    Endpoints:" readOnly: true type: "string" + 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

    Endpoints:" + 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.).

    Endpoints:" readOnly: true type: "integer" - 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.

    Endpoints:" - readOnly: true - type: "string" authParameter: description: "AuthParameter appears in the response only in case of token-based aggregation sites.

    Endpoints:" readOnly: true @@ -4595,6 +4743,47 @@ definitions: - "OAUTH" - "CREDENTIALS" - "MFA_CREDENTIALS" + favicon: + description: "Favicon link of the provider.

    Endpoints:" + readOnly: true + type: "string" + accountType: + description: "AccountType supported by the provider, eg: Brokerage Cash, Current

    Endpoints:" + readOnly: true + type: "array" + items: + type: "string" + enum: + - "CURRENT" + - "BROKERAGE_CASH" + countryISOCode: + description: "Country to which the provider belongs.

    Endpoints:" + readOnly: true + type: "string" + isAddedByUser: + description: "Indicates that the site has been added by the user at least once.

    Endpoints:" + readOnly: true + type: "string" + primaryLanguageISOCode: + description: "The primary language of the site.

    Endpoints:" + readOnly: true + type: "string" + help: + description: "Text to guide user through linking an account that belongs to the site

    Endpoints:" + readOnly: true + type: "string" + baseUrl: + description: "The base URL of the provider's site.

    Endpoints:" + readOnly: true + type: "string" + name: + description: "The name of a provider site.

    Endpoints:" + 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.

    Endpoints:" + readOnly: true + type: "string" dataset: description: "Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents

    Endpoints:" readOnly: true @@ -4952,6 +5141,14 @@ definitions: description: "Unique identifier for the provider account resource. This is created during account addition.

    Endpoints:" readOnly: true type: "integer" + authType: + description: "The authentication type enabled at the provider site.

    Endpoints:Applicable Values
    " + 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.

    Endpoints:" readOnly: true @@ -6164,6 +6361,15 @@ definitions: description: description: "After we have finished using your data or you have withdraw your consent to use the data, it will be de-identified as per our" type: "string" + HoldingId: + type: "object" + title: "HoldingId" + properties: + id: + format: "int64" + description: "Unique identifier for the security added in the system. This is the primary key of the holding resource.

    Applicable containers: investment, insurance
    " + readOnly: true + type: "integer" RuleClause: type: "object" title: "RuleClause" @@ -7503,6 +7709,45 @@ definitions: title: description: "Title for the Data Cluster." type: "string" + ConsentHistory: + type: "object" + title: "ConsentHistory" + required: + - "consentStatus" + - "eventDateTime" + - "startDateTime" + properties: + eventDateTime: + description: "History logged datetime." + type: "string" + expirationDateTime: + description: "Consent expiry datetime where supported by the provider." + type: "string" + userDataPurge: + format: "int64" + description: "Applicable data deletion preference for consent as per AU OB onboarding model and user's "delete my data instead" option. This data point is applicable for AU Open Banking region only." + type: "integer" + deidentificationPreference: + description: "whether user has given consent to use deidentified data or not. This data point is applicable for AU Open Banking region only. Oauthpref id = 4" + type: "boolean" + startDateTime: + description: "Consent start datetime." + type: "string" + consentStatus: + description: "Status of the consent in each history event. Statuses will be shown as applicable for Open Banking regions." + type: "string" + enum: + - "ACTIVE" + - "EXPIRED" + - "REVOKED" + - "CONSENT_REPEALED" + revokedDateTime: + description: "Revoked datetime for the consent if consent is revoked." + type: "string" + consentCollectionPeriod: + format: "int32" + description: "Consent duration period selected by user for recurring consents during the new account addition or consent renewal. This data point is applicable for AU Open Banking region only. Oauthpref id = 6" + type: "integer" VerifyAccountRequest: type: "object" title: "VerifyAccountRequest" @@ -8185,6 +8430,15 @@ definitions: description: "The monthly or periodic payment on a loan that is recurring in nature. The recurring payment amount is usually same as the amount due, unless late fees or other charges are added eventually changing the amount due for a particular month.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:" readOnly: true $ref: "#/definitions/Money" + HoldingIdListResponse: + type: "object" + title: "HoldingIdListResponse" + properties: + holding: + readOnly: true + type: "array" + items: + $ref: "#/definitions/HoldingId" ApiKeyResponse: type: "object" title: "ApiKeyResponse" @@ -8241,7 +8495,7 @@ definitions: readOnly: true type: "string" type: - description: "The nature of the transaction, i.e., deposit, refund, payment, etc.
    Note: The transaction type field is available only for the United States, Canada, United Kingdom, and India based provider sites.

    Applicable containers: bank,creditCard,investment
    " + description: "The nature of the transaction, i.e., deposit, refund, payment, etc.
    Note: The transaction type field is available only for the United States, Canada, United Kingdom, New Zealand and India based provider sites.

    Applicable containers: bank,creditCard,investment
    " readOnly: true type: "string" intermediary: @@ -8384,7 +8638,7 @@ definitions: readOnly: true type: "integer" subType: - description: "The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.
    Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, and India.

    Applicable containers: bank,creditCard,investment,insurance,loan
    " + description: "The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.
    Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, New Zealand and India.

    Applicable containers: bank,creditCard,investment,insurance,loan
    " readOnly: true type: "string" enum: @@ -9264,7 +9518,7 @@ definitions: readOnly: true type: "string" referenceCode: - description: "Unique Yodlee identifier used to troubleshoot issues at Yodlee’s end." + description: "Unique Yodlee identifier used to troubleshoot issues at Yodlee's end." readOnly: true type: "string" DocumentDownload: @@ -9488,6 +9742,7 @@ definitions: - "UNCATEGORIZE" - "INCOME" - "EXPENSE" + - "LOAN" categorySummary: description: "Summary of transaction amouts at category level.

    Applicable containers: creditCard, bank, investment
    " readOnly: true @@ -10351,6 +10606,16 @@ definitions: description: "URL to which the notification should be posted.

    Endpoints:" type: "string" maxLength: 2147483647 + HoldingRequest: + type: "object" + title: "HoldingRequest" + required: + - "holding" + properties: + holding: + type: "array" + items: + $ref: "#/definitions/HoldingRequestInfo" ThirdPartyADR: type: "object" title: "ThirdPartyADR" @@ -10529,6 +10794,14 @@ definitions: description: "Unique identifier for the provider account resource. This is created during account addition.

    Endpoints:" readOnly: true type: "integer" + authType: + description: "The authentication type enabled at the provider site.

    Endpoints:Applicable Values
    " + 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.

    Endpoints:" readOnly: true @@ -10746,7 +11019,7 @@ definitions: readOnly: true type: "string" type: - description: "The nature of the transaction, i.e., deposit, refund, payment, etc.
    Note: The transaction type field is available only for the United States, Canada, United Kingdom, and India based provider sites.

    Applicable containers: bank,creditCard,investment
    " + description: "The nature of the transaction, i.e., deposit, refund, payment, etc.
    Note: The transaction type field is available only for the United States, Canada, United Kingdom, New Zealand and India based provider sites.

    Applicable containers: bank,creditCard,investment
    " readOnly: true type: "string" intermediary: @@ -10893,7 +11166,7 @@ definitions: readOnly: true type: "integer" subType: - description: "The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.
    Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, and India.

    Applicable containers: bank,creditCard,investment,insurance,loan
    " + description: "The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.
    Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, New Zealand and India.

    Applicable containers: bank,creditCard,investment,insurance,loan
    " readOnly: true type: "string" enum: @@ -11165,6 +11438,108 @@ definitions: user: readOnly: true $ref: "#/definitions/DataExtractsUser" + HoldingRequestInfo: + type: "object" + title: "HoldingRequestInfo" + required: + - "accountId" + - "description" + - "value" + properties: + symbol: + type: "string" + exercisedQuantity: + format: "double" + type: "number" + cusipNumber: + type: "string" + vestedQuantity: + format: "double" + type: "number" + description: + minLength: 1 + type: "string" + maxLength: 2147483647 + unvestedValue: + $ref: "#/definitions/Money" + vestedValue: + $ref: "#/definitions/Money" + optionType: + type: "string" + enum: + - "put" + - "call" + - "unknown" + - "other" + holdingType: + type: "string" + enum: + - "stock" + - "mutualFund" + - "bond" + - "CD" + - "option" + - "moneyMarketFund" + - "other" + - "remic" + - "future" + - "commodity" + - "currency" + - "unitInvestmentTrust" + - "employeeStockOption" + - "insuranceAnnuity" + - "unknown" + - "preferredStock" + - "ETF" + - "warrants" + - "digitalAsset" + maturityDate: + type: "string" + price: + $ref: "#/definitions/Money" + term: + type: "string" + contractQuantity: + format: "double" + type: "number" + isShort: + type: "boolean" + value: + $ref: "#/definitions/Money" + expirationDate: + type: "string" + interestRate: + format: "double" + type: "number" + quantity: + format: "double" + type: "number" + grantDate: + type: "string" + sedol: + type: "string" + vestedSharesExercisable: + format: "double" + type: "number" + spread: + $ref: "#/definitions/Money" + accountId: + format: "int64" + type: "integer" + couponRate: + format: "double" + type: "number" + unvestedQuantity: + format: "double" + type: "number" + costBasis: + $ref: "#/definitions/Money" + vestingDate: + type: "string" + isin: + type: "string" + strikePrice: + $ref: "#/definitions/Money" AddedProviderAccountResponse: type: "object" title: "AddedProviderAccountResponse" @@ -11220,6 +11595,13 @@ definitions: description: "Link of the transaction API service that corresponds to the value derivation.

    Applicable containers: creditCard, bank, investment
    " readOnly: true type: "string" + ConsentHistoryCountResponse: + type: "object" + title: "ConsentHistoryCountResponse" + properties: + consentHistory: + readOnly: true + $ref: "#/definitions/ConsentHistoryCount" Transaction: type: "object" title: "Transaction" @@ -11263,7 +11645,7 @@ definitions: readOnly: true type: "string" type: - description: "The nature of the transaction, i.e., deposit, refund, payment, etc.
    Note: The transaction type field is available only for the United States, Canada, United Kingdom, and India based provider sites.

    Applicable containers: bank,creditCard,investment
    " + description: "The nature of the transaction, i.e., deposit, refund, payment, etc.
    Note: The transaction type field is available only for the United States, Canada, United Kingdom, New Zealand and India based provider sites.

    Applicable containers: bank,creditCard,investment
    " readOnly: true type: "string" intermediary: @@ -11402,7 +11784,7 @@ definitions: readOnly: true type: "integer" subType: - description: "The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.
    Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, and India.

    Applicable containers: bank,creditCard,investment,insurance,loan
    " + description: "The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.
    Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, New Zealand and India.

    Applicable containers: bank,creditCard,investment,insurance,loan
    " readOnly: true type: "string" enum: @@ -11805,6 +12187,12 @@ definitions: description: "The logo link of the provider institution. The link will return the logo in the PNG format.

    Endpoints:" readOnly: true type: "string" + 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

    Endpoints:" + 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.).

    Endpoints:" @@ -11983,6 +12371,14 @@ definitions: description: "Unique identifier for the provider account resource. This is created during account addition.

    Endpoints:" readOnly: true type: "integer" + authType: + description: "The authentication type enabled at the provider site.

    Endpoints:Applicable Values
    " + 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.

    Endpoints:" readOnly: true