openapi: 3.0.1
info:
title: Envestnet Aggregation APIs Account Token CreditAcceleratorFile API
description: 'This file describes the Yodlee Aggregation product APIs using the swagger notation that you can use to build your financial application. You can generate the client SDK in Python, JavaScript, PHP, or any other languages according to your development needs. For more details about the APIs, refer to Yodlee API v1.1 - Overview.
You will have to set the header before making the API call. The following headers apply to all the APIs:
- Authorization: This header holds the access token
- Api-Version: 1.1
Note: If there are any API-specific headers, they are mentioned explicitly in the respective API''s description.'
termsOfService: https://developer.yodlee.com/terms/condition
contact:
email: developer@yodlee.com
license:
name: Yodlee Developer License
url: https://developer.yodlee.com/terms/condition#_Services_1
version: 1.1.0
servers:
- url: /
tags:
- name: CreditAcceleratorFile
description: CreditAcceleratorFile API
paths:
/creditAccelerator/report/refresh:
put:
tags:
- CreditAcceleratorFile
summary: Envestnet Refresh Credit Accelerator File
description: This service allows you to refresh the already generated credit accelerator file
operationId: refreshFile
requestBody:
description: requestBody
content:
application/json:
schema:
$ref: '#/components/schemas/CreditAcceleratorRefreshRequest'
required: true
responses:
201:
description: Created Successfully
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CreditAcceleratorFileResponse'
400:
description: 'Y800 : Invalid value for configName
Y800 : Invalid value for requestingFirm
Y802 : requestingFirm not allowed
Y802 : refresh not allowed
Y802 : The report is not available, and refresh is not allowed
Y806 : Invalid input
Y812 : Required field/value - configName missing in the request
Y847 : resource cannot be requested, as feature not enabled'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
content: {}
404:
description: Not Found
content: {}
500:
description: 'Y904 : Internal exception'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
deprecated: false
/creditAccelerator/report/status:
get:
tags:
- CreditAcceleratorFile
summary: Envestnet Get File Status
description: You can use this service to check the status of the credit accelerator file using either reportId or configName as query parameters where configName will only give the status for latest requested credit accelerator file. We recommend polling at a 2 second interval.
operationId: getFileStatus
parameters:
- name: configName
in: query
description: Unique identifier for the credit accelerator file
required: true
allowEmptyValue: false
schema:
type: string
- name: reportId
in: query
description: Unique identifier for the credit accelerator file
allowEmptyValue: false
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CreditAcceleratorStatusResponse'
400:
description: 'Y812 : Required field/value - configName or reportId missing in the request
Y802 : configName and reportId together is not allowed'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
content: {}
404:
description: Not Found
content: {}
500:
description: 'Y904 : Internal exception'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
deprecated: false
/creditAccelerator/report/statements:
get:
tags:
- CreditAcceleratorFile
summary: Envestnet Get Statements
description: Partner can poll the below API to see a list of financial statements which were downloading during the application process on behalf of the consumer. We recommend polling at a 2 second interval.
operationId: getFileStatements
parameters:
- name: configName
in: query
description: The config name using which the credit accelerator file generation was requested
required: true
allowEmptyValue: false
schema:
type: string
- name: reportId
in: query
description: Unique identifier for the credit accelerator file
allowEmptyValue: false
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CreditAcceleratorStatementResponse'
400:
description: 'Y806 : Invalid input
Y812 : Required field/value - configName or reportId missing in the request
Y802 : configName and reportId together is not allowed'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
content: {}
404:
description: Not Found
content: {}
500:
description: 'Y904 : Internal exception'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
deprecated: false
/creditAccelerator/report:
get:
tags:
- CreditAcceleratorFile
summary: Envestnet Get Credit Accelerator File
description: Using this service you can retrieve the Credit Accelerator file in JSON or PDF format. Once the file generation has finished processing i.e. status is COMPLETED, you can retrieve call this api service by passign values "json" or pdf" in "format" query parameter
operationId: getFile
parameters:
- name: configName
in: query
description: The config name using which the credit accelerator file generation was requested
required: true
allowEmptyValue: false
schema:
type: string
- name: format
in: query
description: Format in which credit accelerator report shall be provided. Valid values JSON and PDF
allowEmptyValue: false
schema:
type: string
- name: reportId
in: query
description: Unique identifier for the credit accelerator file
allowEmptyValue: false
schema:
type: string
responses:
200:
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CreditAcceleratorFile'
400:
description: 'Y800 : Invalid value for format
Y812 : Required field/value - configName or reportId missing in the request
Y802 : configName and reportId together is not allowed'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
content: {}
404:
description: Not Found
content: {}
500:
description: 'Y904 : Internal exception'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
deprecated: false
/creditAccelerator/report/generate:
post:
tags:
- CreditAcceleratorFile
summary: Envestnet Generate Credit Accelerator File
description: This service allows you to submit a request to generate credit accelerator file for already linked accounts
operationId: generateFile
requestBody:
description: requestBody
content:
application/json:
schema:
$ref: '#/components/schemas/CreditAcceleratorGenerateRequest'
required: true
responses:
201:
description: Created Successfully
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/CreditAcceleratorFileResponse'
400:
description: 'Y800 : Invalid value for configName
Y800 : Invalid value for requestingFirm
Y800 : Invalid value for accountIds
Y806 : Invalid input
Y812 : Required field/value - configName missing in the request
Y812 : Required field/value - accountIds missing in the request
Y847 : resource cannot be requested, as feature not enabled'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
content: {}
404:
description: Not Found
content: {}
500:
description: 'Y904 : Internal exception'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
deprecated: false
components:
schemas:
CreditAcceleratorPaymentBankTransferCode:
title: CreditAcceleratorPaymentBankTransferCode
type: object
properties:
sourceType:
type: string
description: Source type
readOnly: true
id:
type: string
description: 'The FI''s branch identification number.Additional Details: The routing number of the bank account in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom).
Account Type: Aggregated
Applicable containers: bank, investment'
readOnly: true
type:
type: string
description: 'The bank transfer code type varies depending on the region of the account origination.
Account Type: Aggregated
Applicable containers: bank, investment
Endpoints:
- GET accounts
- GET accounts/{accountId}
Applicable Values
* BSB: BSB is a Bank-State-Branch number used to identify the branch in Australia and is required for performing transfers.
* IFSC: IFSC is Indian Financial System Code. It is an alphanumeric code that is used to identify the particular branch in India and is required for electronic funds settlement.
* ROUTING_NUMBER: Bank routing number or routing transit number (RTN) is a nine digit number used in US to identify financial institution in a transaction. Most common transaction types where routing numbers are used are ACH and wire transfers.
* SORT_CODE: The sort code is a six-digit number used in UK to identify both the bank and the branch where the account is held.
'
readOnly: true
enum:
- ROUTING_NUMBER
- BSB
- IFSC
- SORT_CODE
PaymentIdentifier:
title: PaymentIdentifier
type: object
properties:
type:
type: string
description: Type of Identifier
readOnly: true
enum:
- REFERENCE_NUMBER
- PLATFORM_CODE
value:
type: string
description: Value of the identifier
readOnly: true
CreditAcceleratorBalance:
title: CreditAcceleratorBalance
type: object
properties:
date:
type: string
description: Date of balance.
readOnly: true
amount:
type: number
description: Balance amount value.
format: double
readOnly: true
currency:
$ref: '#/components/schemas/CreditAcceleratorData'
CreditAcceleratorAllAccountCashFlow:
title: CreditAcceleratorAllAccountCashFlow
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountCashFlowAnalysis'
currency:
type: string
LoanPayoffDetails:
title: LoanPayoffDetails
type: object
properties:
payByDate:
type: string
description: 'The date by which the payoff amount should be paid.
Account Type: Aggregated
Applicable containers: loan
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
payoffAmount:
$ref: '#/components/schemas/Money'
outstandingBalance:
$ref: '#/components/schemas/Money'
CreditAcceleratorBankTransferCode:
title: CreditAcceleratorBankTransferCode
type: object
properties:
sourceType:
type: string
readOnly: true
id:
type: string
description: 'The FI''s branch identification number.Additional Details: The routing number of the bank account in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom).
Account Type: Aggregated
Applicable containers: bank, investment
Endpoints:
- GET accounts
- GET accounts/{accountId}
- POST verification
'
type:
type: string
description: 'The bank transfer code type varies depending on the region of the account origination.
Account Type: Aggregated
Applicable containers: bank, investment
Endpoints:
- GET accounts
- GET accounts/{accountId}
- POST verification
Applicable Values
'
enum:
- BSB
- IFSC
- ROUTING_NUMBER
- SORT_CODE
CreditAcceleratorDocument:
title: CreditAcceleratorDocument
type: object
properties:
accountID:
type: integer
description: 'The primary key of the account resource and the unique identifier for the account.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET investmentOptions
- GET accounts/historicalBalances
- POST accounts
'
format: int64
readOnly: true
lastUpdated:
type: string
description: 'Indicates the date and time the document was last updated.
Applicable containers: bank and investment
'
readOnly: true
formType:
type: string
description: Indicates the type of the tax form.
readOnly: true
docType:
type: string
description: Indicates the type of the document.
readOnly: true
name:
type: string
description: 'The name of the document.
Applicable containers: bank and investment
'
readOnly: true
statementDate:
type: string
description: 'Indicates the date and time of the document.
Applicable containers: bank and investment
'
readOnly: true
id:
type: string
description: 'The document''s primary key and unique identifier.
Applicable containers: bank and investment
'
readOnly: true
source:
type: string
description: 'Indicates the source of the document download.
Applicable containers: bank and investment
'
readOnly: true
uri:
type: string
description: Relative URI to fetch the actual document
readOnly: true
status:
type: string
description: 'Indicates the status of the document download.
Applicable containers: bank and investment
'
readOnly: true
CreditAcceleratorClassificationType:
title: CreditAcceleratorClassificationType
type: object
properties:
total:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorClassificationValue'
classificationValues:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorClassificationValue'
classificationType:
type: string
CreditAcceleratorSelectedAccount:
title: CreditAcceleratorSelectedAccount
type: object
properties:
providerAccountId:
type: integer
description: Unique identifier for the provider account resource. This is created during account addition.
format: int64
readOnly: true
id:
type: integer
description: The primary key of the account resource and the unique identifier for the account.
format: int64
readOnly: true
CreditAcceleratorAccountAddress:
title: CreditAcceleratorAccountAddress
type: object
properties:
zip:
type: string
description: Zip.
country:
type: string
description: Country.
address3:
type: string
description: Address Line 3.
address2:
type: string
description: Address Line 2.
city:
type: string
description: City.
sourceType:
type: string
description: Address Source.
readOnly: true
address1:
type: string
description: Address Line 1.
street:
type: string
description: Street.
readOnly: true
fullAddress:
type: string
description: Full Address.
readOnly: true
state:
type: string
description: State.
type:
type: string
description: Type of address.
readOnly: true
enum:
- HOME
- BUSINESS
- POBOX
- RETAIL
- OFFICE
- SMALL_BUSINESS
- COMMUNICATION
- PERMANENT
- STATEMENT_ADDRESS
- PAYMENT
- PAYOFF
- UNKNOWN
Name:
title: Name
type: object
properties:
middle:
type: string
description: Middle name.
last:
type: string
description: Last name.
fullName:
type: string
description: Full name.
first:
type: string
description: First name.
CreditAcceleratorReportConfig:
title: CreditAcceleratorReportConfig
type: object
properties:
largeCreditAmt:
type: number
description: Lower limit used to count the number of times the consumer's credit transactions exceeded this amount in Large Deposit Occurrence and Large Transfer Occurrence
format: double
readOnly: true
lowBalAmt3:
type: number
description: 'Third upper limit which is used to count the number of times the consumer''''s Daily Balance amount fell below this amount in Low Balance Occurrence: Segment 3'
format: double
readOnly: true
lowBalAmt4:
type: number
description: 'Fourth upper limit which is used to count the number of times the consumer''''s Daily Balance amount fell below this amount in Low Balance Occurrence: Segment 4'
format: double
readOnly: true
lowBalAmt1:
type: number
description: 'First upper limit which is used to count the number of times the consumer''''s Daily Balance amount fell below this amount in Low Balance Occurrence: Segment 1'
format: double
readOnly: true
requestingFirm:
$ref: '#/components/schemas/CreditAcceleratorRequestingFirm'
lowBalAmt2:
type: number
description: 'Second upper limit which is used to count the number of times the consumer''''s Daily Balance amount fell below this amount in Low Balance Occurrence: Segment 2'
format: double
readOnly: true
days:
type: integer
description: No of days for which the credit accelerator file is requested
format: int32
readOnly: true
PhoneNumber:
title: PhoneNumber
type: object
properties:
type:
type: string
description: type of phone number
readOnly: true
enum:
- HOME
- WORK
- LANDLINE
- MOBILE
value:
type: string
description: Phone Number
readOnly: true
CreditAcceleratorData:
title: CreditAcceleratorData
type: object
properties:
allAccountAnalysis:
$ref: '#/components/schemas/CreditAcceleratorAllAccountAnalysis'
accounts:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorAccountSummary'
CreditAcceleratorClassificationValue:
title: CreditAcceleratorClassificationValue
type: object
properties:
amount:
type: number
format: double
percentage:
type: number
format: double
classificationValue:
type: string
CreditAcceleratorAllAccountIncome:
title: CreditAcceleratorAllAccountIncome
type: object
properties:
regularIncomeTxnSummary:
type: array
description: Sum, count, average and list of salary/regular income transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
otherIncomeTxnSummary:
type: array
description: Sum, count, average and list of other income transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
servicesIncomeTxnSummary:
type: array
description: Sum, count, average and list of sales/services income transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
totalIncomeTxnSummary:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
depositTxnSummary:
type: array
description: Sum, count, average and list of deposit income transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
retirementTxnSummary:
type: array
description: Sum, count, average and list of investment/retirement income transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
YodleeError:
title: YodleeError
type: object
properties:
errorMessage:
type: string
description: The descriptive message that explains the error scenario.
readOnly: true
errorCode:
type: string
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
referenceCode:
type: string
description: Unique Yodlee identifier used to troubleshoot issues at Yodlee's end.
readOnly: true
AccountDataset:
title: AccountDataset
type: object
properties:
lastUpdated:
type: string
description: 'Indicate when the dataset is last updated successfully for the given provider account.
Account Type: Aggregated
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET providerAccounts
- POST providerAccounts
- PUT providerAccounts/{providerAccountId}
- GET providerAccounts/{providerAccountId}
'
readOnly: true
updateEligibility:
type: string
description: 'Indicate whether the dataset is eligible for update or not.
Account Type: Aggregated
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET providerAccounts
- POST providerAccounts
- PUT providerAccounts/{providerAccountId}
- GET providerAccounts/{providerAccountId}
Applicable Values
'
readOnly: true
enum:
- ALLOW_UPDATE
- ALLOW_UPDATE_WITH_CREDENTIALS
- DISALLOW_UPDATE
additionalStatus:
type: string
description: 'The status of last update attempted for the dataset.
Account Type: Aggregated
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET providerAccounts
- POST providerAccounts
- PUT providerAccounts/{providerAccountId}
- GET providerAccounts/{providerAccountId}
Applicable Values
'
readOnly: true
enum:
- LOGIN_IN_PROGRESS
- DATA_RETRIEVAL_IN_PROGRESS
- ACCT_SUMMARY_RECEIVED
- AVAILABLE_DATA_RETRIEVED
- PARTIAL_DATA_RETRIEVED
- DATA_RETRIEVAL_FAILED
- DATA_NOT_AVAILABLE
- ACCOUNT_LOCKED
- ADDL_AUTHENTICATION_REQUIRED
- BETA_SITE_DEV_IN_PROGRESS
- CREDENTIALS_UPDATE_NEEDED
- INCORRECT_CREDENTIALS
- PROPERTY_VALUE_NOT_AVAILABLE
- INVALID_ADDL_INFO_PROVIDED
- REQUEST_TIME_OUT
- SITE_BLOCKING_ERROR
- UNEXPECTED_SITE_ERROR
- SITE_NOT_SUPPORTED
- SITE_UNAVAILABLE
- TECH_ERROR
- USER_ACTION_NEEDED_AT_SITE
- SITE_SESSION_INVALIDATED
- NEW_AUTHENTICATION_REQUIRED
- DATASET_NOT_SUPPORTED
- ENROLLMENT_REQUIRED_FOR_DATASET
- CONSENT_REQUIRED
- CONSENT_EXPIRED
- CONSENT_REVOKED
- INCORRECT_OAUTH_TOKEN
- MIGRATION_IN_PROGRESS
nextUpdateScheduled:
type: string
description: 'Indicates when the next attempt to update the dataset is scheduled.
Account Type: Aggregated
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET providerAccounts
- POST providerAccounts
- PUT providerAccounts/{providerAccountId}
- GET providerAccounts/{providerAccountId}
'
readOnly: true
name:
type: string
description: 'The name of the dataset requested from the provider site
Account Type: Manual
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET providerAccounts
- POST providerAccounts
- PUT providerAccounts/{providerAccountId}
- GET providerAccounts/{providerAccountId}
- GET providers/{providerId}
- GET providers
Applicable Values
'
enum:
- BASIC_AGG_DATA
- ADVANCE_AGG_DATA
- ACCT_PROFILE
- DOCUMENT
lastUpdateAttempt:
type: string
description: 'Indicate when the last attempt was performed to update the dataset for the given provider account
Account Type: Aggregated
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET providerAccounts
- POST providerAccounts
- PUT providerAccounts/{providerAccountId}
- GET providerAccounts/{providerAccountId}
'
readOnly: true
Description:
title: Description
type: object
properties:
security:
type: string
description: 'The description will provide the actual name of the security.
Applicable containers: investment
'
readOnly: true
original:
type: string
description: 'Original transaction description as it appears at the FI site.
Applicable containers: creditCard, insurance, loan
'
readOnly: true
simple:
type: string
description: 'The transaction description that appears at the FI site may not be self-explanatory, i.e., the source, purpose of the transaction may not be evident. Yodlee attempts to simplify and make the transaction meaningful to the consumer, and this simplified transaction description is provided in the simple description field.Note: The simple description field is available only in the United States, Canada, United Kingdom, and India.
Applicable containers: creditCard, insurance, loan
'
readOnly: true
consumer:
type: string
description: The description of the transaction as defined by the consumer. The consumer can define or provide more details of the transaction in this field.
Coordinates:
title: Coordinates
type: object
properties:
latitude:
type: number
description: 'Latitude of the merchant
Applicable containers: bank,creditCard,loan
'
format: double
longitude:
type: number
description: 'Longitude of the merchant
Applicable containers: bank,creditCard,loan
'
format: double
CreditAcceleratorStatement:
title: CreditAcceleratorStatement
type: object
properties:
accountId:
type: integer
description: 'The primary key of the account resource and the unique identifier for the account.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET investmentOptions
- GET accounts/historicalBalances
- POST accounts
'
format: int64
readOnly: true
additionalStatus:
type: string
documents:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorDocument'
status:
type: string
description: Status of the doc download for given configName or reportId
readOnly: true
Money:
title: Money
type: object
properties:
amount:
type: number
description: Value of amount.
format: double
convertedAmount:
type: number
description: Value of the converted amount.
format: double
currency:
type: string
description: Currency should be a valid three-letter ISO Code.
enum:
- USD
- AUD
- BRL
- CAD
- EUR
- GBP
- HKD
- IDR
- INR
- JPY
- NZD
- SGD
- ZAR
- CNY
- VND
- MYR
- CHF
- AED
- AFA
- ALL
- AMD
- ANG
- AOA
- ARS
- AWG
- AZM
- BAM
- BBD
- BDT
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BSD
- BTN
- BWP
- BYR
- BZD
- CDF
- CLP
- COP
- CRC
- CUP
- CVE
- CYP
- CZK
- DJF
- DKK
- DOP
- DZD
- EEK
- EGP
- ERN
- ETB
- FJD
- FKP
- GEL
- GGP
- GHC
- GIP
- GMD
- GNF
- GTQ
- GYD
- HNL
- HRK
- HTG
- HUF
- ILS
- IMP
- IQD
- IRR
- ISK
- JEP
- JMD
- JOD
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGF
- MKD
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXN
- MZM
- NAD
- NGN
- NIO
- NOK
- NPR
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- ROL
- RUR
- RWF
- SAR
- SBD
- SCR
- SDD
- SEK
- SHP
- SIT
- SKK
- SLL
- SOS
- SPL
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TJR
- TMM
- TND
- TOP
- TRL
- TTD
- TVD
- TWD
- TZS
- UAH
- UGX
- UYU
- UZS
- VEB
- VUV
- WST
- XAF
- XAG
- XAU
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- YER
- YUM
- ZMK
- ZWD
- ADP
- ATS
- BEF
- BUK
- CSD
- CSK
- DDM
- DEM
- ECS
- ESP
- FIM
- GRD
- GWP
- IEP
- ITL
- LUF
- MLF
- NLG
- PTE
- SUR
- TPE
- UAK
- XBA
- XBB
- XBC
- XBD
- XEU
- XFO
- XFU
- XGF
- XMK
- XRM
- XTS
- YDD
- YUD
- ZRN
- TJS
- RON
- BGN
- BTC
- XBT
- CNH
- RUB
- TRY
- GHS
- TMT
- ZMW
- VEF
- SSP
- ALK
convertedCurrency:
type: string
description: Currency should be a valid three-letter ISO Code.
enum:
- USD
- AUD
- BRL
- CAD
- EUR
- GBP
- HKD
- IDR
- INR
- JPY
- NZD
- SGD
- ZAR
- CNY
- VND
- MYR
- CHF
- AED
- AFA
- ALL
- AMD
- ANG
- AOA
- ARS
- AWG
- AZM
- BAM
- BBD
- BDT
- BGL
- BHD
- BIF
- BMD
- BND
- BOB
- BSD
- BTN
- BWP
- BYR
- BZD
- CDF
- CLP
- COP
- CRC
- CUP
- CVE
- CYP
- CZK
- DJF
- DKK
- DOP
- DZD
- EEK
- EGP
- ERN
- ETB
- FJD
- FKP
- GEL
- GGP
- GHC
- GIP
- GMD
- GNF
- GTQ
- GYD
- HNL
- HRK
- HTG
- HUF
- ILS
- IMP
- IQD
- IRR
- ISK
- JEP
- JMD
- JOD
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGF
- MKD
- MMK
- MNT
- MOP
- MRO
- MTL
- MUR
- MVR
- MWK
- MXN
- MZM
- NAD
- NGN
- NIO
- NOK
- NPR
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- ROL
- RUR
- RWF
- SAR
- SBD
- SCR
- SDD
- SEK
- SHP
- SIT
- SKK
- SLL
- SOS
- SPL
- SRG
- STD
- SVC
- SYP
- SZL
- THB
- TJR
- TMM
- TND
- TOP
- TRL
- TTD
- TVD
- TWD
- TZS
- UAH
- UGX
- UYU
- UZS
- VEB
- VUV
- WST
- XAF
- XAG
- XAU
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- YER
- YUM
- ZMK
- ZWD
- ADP
- ATS
- BEF
- BUK
- CSD
- CSK
- DDM
- DEM
- ECS
- ESP
- FIM
- GRD
- GWP
- IEP
- ITL
- LUF
- MLF
- NLG
- PTE
- SUR
- TPE
- UAK
- XBA
- XBB
- XBC
- XBD
- XEU
- XFO
- XFU
- XGF
- XMK
- XRM
- XTS
- YDD
- YUD
- ZRN
- TJS
- RON
- BGN
- BTC
- XBT
- CNH
- RUB
- TRY
- GHS
- TMT
- ZMW
- VEF
- SSP
- ALK
CreditAcceleratorFileResponse:
title: CreditAcceleratorFileResponse
type: object
properties:
configName:
type: string
description: The config name using which the credit accelerator file generation was requested
readOnly: true
reportId:
type: integer
description: Unique identifier for the credit accelerator file
format: int64
readOnly: true
submissionDate:
type: string
description: Date on which the request to generate credit accelerator file was submitted
readOnly: true
originalReportId:
type: integer
description: Report id of original report on which refresh is performed. This is not available when report is generated for the first time.
format: int64
readOnly: true
status:
type: string
description: Generation status of the requested credit accelerator file requested
readOnly: true
enum:
- SUBMITTED
- IN_PROGRESS
- COMPLETED
- FAILED
CreditAcceleratorMerchant:
title: CreditAcceleratorMerchant
type: object
properties:
website:
type: string
description: 'The website of the merchant.
Applicable containers: bank,creditCard,investment,loan
'
readOnly: true
address:
$ref: '#/components/schemas/CreditAcceleratorAccountAddress'
contact:
$ref: '#/components/schemas/Contact'
categoryLabel:
type: array
description: 'The business categories of the merchant.
Applicable containers: bank,creditCard
Applicable Values
'
readOnly: true
items:
type: string
coordinates:
$ref: '#/components/schemas/Coordinates'
name:
type: string
description: 'The name of the merchant.
Applicable containers: bank,creditCard,investment,insurance,loan
'
readOnly: true
id:
type: string
description: 'Identifier of the merchant.
Applicable containers: bank,creditCard,investment,insurance,loan
'
readOnly: true
source:
type: string
description: 'The source through which merchant information is retrieved.
Applicable containers: bank,creditCard,investment,insurance,loan
Applicable Values
'
readOnly: true
enum:
- YODLEE
- FACTUAL
logoURL:
type: string
description: 'The logoURL of the merchant.
Applicable containers: bank,creditCard,investment,loan
'
readOnly: true
CreditAcceleratorAllAccountInvestmentHoldingSummary:
title: CreditAcceleratorAllAccountInvestmentHoldingSummary
type: object
properties:
classifications:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorClassification'
totalValues:
type: array
items:
$ref: '#/components/schemas/Money'
CreditAcceleratorAllAccountBalanceSummary:
title: CreditAcceleratorAllAccountBalanceSummary
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorSummary'
currency:
type: string
CreditAcceleratorTransaction:
title: CreditAcceleratorTransaction
type: object
properties:
date:
type: string
description: 'The value provided will be either postDate or transactionDate. postDate takes higher priority than transactionDate, except for the investment container as only transactionDate is available. The availability of postDate or transactionDate depends on the provider site.
Applicable containers: bank,creditCard,investment,insurance,loan
'
readOnly: true
sourceId:
type: string
description: 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.
readOnly: true
symbol:
type: string
description: 'The symbol of the security being traded.
Note: The settle date field applies only to trade-related transactions.
Applicable containers: investment
'
readOnly: true
cusipNumber:
type: string
description: 'The CUSIP (Committee on Uniform Securities Identification Procedures) identifies the financial instruments in the United States and Canada.
Note: The CUSIP number field applies only to trade related transactions.
Applicable containers: investment
'
readOnly: true
highLevelCategoryId:
type: integer
description: 'The high level category assigned to the transaction. The supported values are provided by the GET transactions/categories.
Applicable containers: bank,creditCard,investment,insurance,loan
'
format: int64
readOnly: true
categoryLabel:
type: string
description: Additional category information from the Yodlee reference data, if available.
readOnly: true
detailCategoryId:
type: integer
description: 'The id of the detail category that is assigned to the transaction. The supported values are provided by GET transactions/categories.
Applicable containers: bank,creditCard
'
format: int64
readOnly: true
description:
$ref: '#/components/schemas/Description'
memo:
type: string
description: 'Additional notes provided by the user for a particular transaction through application or API services.
Applicable containers: bank,creditCard,investment,insurance,loan
'
readOnly: true
settleDate:
type: string
description: 'It is the date on which the transaction is finalized, that is, the date the ownership of the security is transferred to the buyer. The settlement date is usually few days after the transaction date.
Applicable containers: investment
'
readOnly: true
type:
type: string
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
'
readOnly: true
intermediary:
type: array
description: 'The intermediary of the transaction.
Applicable containers: bank,creditCard,investment,loan
'
readOnly: true
items:
type: string
baseType:
type: string
description: 'Indicates if the transaction appears as a debit or a credit transaction in the account.
Applicable containers: bank,creditCard,investment,insurance,loan
Applicable Values
'
readOnly: true
enum:
- CREDIT
- DEBIT
categorySource:
type: string
description: 'Indicates the source of the category, i.e., categories derived by the system or assigned/provided by the consumer. This is the source field of the transaction category resource. The supported values are provided by the GET transactions/categories.
Applicable containers: bank,creditCard,investment,insurance,loan
Applicable Values
'
readOnly: true
enum:
- SYSTEM
- USER
principal:
$ref: '#/components/schemas/Money'
lastUpdated:
type: string
description: Last update date and time of transaction
readOnly: true
interest:
$ref: '#/components/schemas/Money'
price:
$ref: '#/components/schemas/Money'
commission:
$ref: '#/components/schemas/Money'
id:
type: integer
description: 'An unique identifier for the transaction. The combination of the id and account container are unique in the system.
Applicable containers: bank,creditCard,investment,insurance,loan
'
format: int64
readOnly: true
merchantLogoURL:
type: string
description: The URL of the merchant logo.
readOnly: true
merchantType:
type: string
description: 'Indicates the merchantType of the transaction.e.g:-BILLERS,SUBSCRIPTION,OTHERS
Applicable containers: bank,creditCard,investment,loan
'
readOnly: true
amount:
$ref: '#/components/schemas/Money'
checkNumber:
type: string
description: 'The checkNumber of the transaction.
Applicable containers: bank
'
readOnly: true
isPhysical:
type: boolean
description: 'Indicates if the transaction is happened online or in-store.
Applicable containers: bank,creditCard,investment,loan
'
readOnly: true
quantity:
type: number
description: 'The quantity associated with the transaction.
Note: The quantity field applies only to trade-related transactions.
Applicable containers: investment
'
format: double
readOnly: true
valoren:
type: string
description: 'It is an identification number that is assigned to financial instruments such as stocks and bonds trading in Switzerland.
Applicable containers: investment
'
readOnly: true
isManual:
type: boolean
description: 'Indicates if the transaction is aggregated from the FI site or the consumer has manually created the transaction using the application or an API.
Applicable containers: bank,creditCard,investment,insurance,loan
'
readOnly: true
merchant:
$ref: '#/components/schemas/CreditAcceleratorMerchant'
sedol:
type: string
description: 'SEDOL stands for Stock Exchange Daily Official List, a list of security identifiers used in the United Kingdom and Ireland for clearing purposes.
Applicable containers: investment
'
readOnly: true
transactionDate:
type: string
description: 'The date the transaction happens in the account.
Applicable containers: bank,creditCard,investment,insurance,loan
'
readOnly: true
logoURL:
type: string
description: The URL of the merchant logo.
readOnly: true
categoryType:
type: string
description: 'The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories.
Applicable containers: bank,creditCard,investment,insurance,loan
'
readOnly: true
enum:
- TRANSFER
- DEFERRED_COMPENSATION
- UNCATEGORIZE
- INCOME
- EXPENSE
accountId:
type: integer
description: 'The account from which the transaction was made. This is basically the primary key of the account resource.
Applicable containers: bank,creditCard,investment,insurance,loan
'
format: int64
readOnly: true
createdDate:
type: string
description: Created date of transaction
readOnly: true
sourceType:
type: string
description: 'The source through which the transaction is added to the Yodlee system.
Applicable containers: bank,creditCard,investment,insurance,loann
Applicable Values:
'
readOnly: true
enum:
- AGGREGATED
- MANUAL
CONTAINER:
type: string
description: 'The account''s container.
Applicable containers: bank,creditCard,investment,insurance,loan
Applicable Values
'
readOnly: true
enum:
- bank
- creditCard
- investment
- insurance
- loan
- reward
- bill
- realEstate
- otherAssets
- otherLiabilities
postDate:
type: string
description: 'The date on which the transaction is posted to the account.
Applicable containers: bank,creditCard,insurance,loan
'
readOnly: true
parentCategoryId:
type: integer
description: 'The parentCategoryId of the category assigned to the transaction.
Note: This field will be provided in the response if the transaction is assigned to a user-created category.
Applicable containers: bank,creditCard,investment,insurance,loan
'
format: int64
readOnly: true
subType:
type: string
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
'
readOnly: true
enum:
- OVERDRAFT_CHARGE
- ONLINE_PURCHASE
- TAX_PAYMENT
- PAYMENT_BY_CHECK
- ATM_CASH_WITHDRAWAL
- SERVICE_CHARGE
- RETURNED_CHECK_CHARGE
- STOP_PAYMENT_CHARGE
- CONVENIENCE_FEE
- AUTO_LOAN
- HOME_LOAN_MORTGAGE
- RECURRING_SUBSCRIPTION_PAYMENT
- INTEREST
- PAYMENT
- PURCHASE
- REFUND
- TRANSFER
- FINANCE_CHARGE
- OTHER_CHARGES_FEES
- ANNUAL_FEE
- DEPOSIT
- DIRECT_DEPOSIT_SALARY
- INVESTMENT_INCOME_CASH
- SSA
- REWARDS
- TAX_REFUND
- CREDIT_CARD_PAYMENT
- INSURANCE_PAYMENT
- UTILITIES_PAYMENT
- CHILD_SUPPORT
- LOAN
- PERSONAL_LOAN
- STUDENT_LOAN
- REIMBURSEMENT
- BALANCE_TRANSFER
- OVERDRAFT_PROTECTION
- CREDIT
- NSF_FEES
category:
type: string
description: 'The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories.
Applicable containers: bank,creditCard,investment,insurance,loan
'
readOnly: true
runningBalance:
$ref: '#/components/schemas/Money'
categoryId:
type: integer
description: 'The id of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories.
Applicable containers: bank,creditCard,investment,insurance,loan
'
format: int64
readOnly: true
holdingDescription:
type: string
description: 'For transactions involving securities, this captures the securities description.
Applicable containers: investment
'
readOnly: true
isin:
type: string
description: 'International Securities Identification Number (ISIN) standard is used worldwide to identify specific securities.
Applicable containers: investment
'
readOnly: true
status:
type: string
description: 'The status of the transaction: pending or posted.
Note: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated.
Applicable containers: bank,creditCard,investment,insurance,loan
Applicable Values
'
readOnly: true
enum:
- POSTED
- PENDING
- SCHEDULED
- FAILED
- CLEARED
AssetClassification:
title: AssetClassification
type: object
properties:
allocation:
type: number
description: 'The allocation percentage of the holding.
Required Feature Enablement: Asset classification feature
Applicable containers: investment
'
format: double
readOnly: true
classificationType:
type: string
description: 'The type of classification to which the investment belongs (assetClass, country, sector, and style).
Required Feature Enablement: Asset classification feature
Applicable containers: investment
'
readOnly: true
classificationValue:
type: string
description: 'The value for each classificationType.
Required Feature Enablement: Asset classification feature
Applicable containers: investment
'
readOnly: true
Coverage:
title: Coverage
type: object
properties:
amount:
type: array
description: 'The coverage amount-related details.
Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
items:
$ref: '#/components/schemas/CoverageAmount'
planType:
type: string
description: 'The plan type for an insurance provided to an individual or an entity.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:- GET accounts
- GET accounts/{accountId}
Applicable Values:
'
readOnly: true
enum:
- PPO
- HMO
- UNKNOWN
endDate:
type: string
description: 'The date on which the coverage for the account ends or expires.
Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
type:
type: string
description: 'The type of coverage provided to an individual or an entity.
Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoints:- GET accounts
- GET accounts/{accountId}
Applicable Values:
'
readOnly: true
enum:
- VISION
- DENTAL
- MEDICAL
- HEALTH
- DEATH_COVER
- TOTAL_PERMANENT_DISABILITY
- ACCIDENTAL_DEATH_COVER
- INCOME_PROTECTION
- DEATH_TOTAL_PERMANENT_DISABILITY
- OTHER
startDate:
type: string
description: 'The date on which the coverage for the account starts.
Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
Identifier:
title: Identifier
type: object
properties:
type:
type: string
description: Type of Identifier
readOnly: true
enum:
- NIE
- DNI
- EIN
- BN
- AADHAR
- NIN
- NRIC
value:
type: string
description: Value of the identifier
readOnly: true
CreditAcceleratorBalanceOccurrenceWithTxn:
title: CreditAcceleratorBalanceOccurrenceWithTxn
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorOccurence'
currency:
type: string
transactions:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorTransaction'
CreditAcceleratorCashFlow:
title: CreditAcceleratorCashFlow
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorCashFlowAnalysis'
currency:
type: string
CreditAcceleratorAccountAnalysis:
title: CreditAcceleratorAccountAnalysis
type: object
properties:
income:
$ref: '#/components/schemas/CreditAcceleratorAccountIncome'
asset:
$ref: '#/components/schemas/CreditAcceleratorAccountAsset'
expense:
$ref: '#/components/schemas/CreditAcceleratorAccountExpense'
CreditAcceleratorStatementResponse:
title: CreditAcceleratorStatementResponse
type: object
properties:
configName:
type: string
description: The config name using which the credit accelerator file generation was requested
readOnly: true
reportId:
type: integer
description: Unique identifier for the credit accelerator file
format: int64
readOnly: true
statements:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorStatement'
submissionDate:
type: string
description: Date on which the request to generate credit accelerator file was submitted
readOnly: true
status:
type: string
description: Generation status of the requested credit accelerator file requested
readOnly: true
enum:
- SUBMITTED
- IN_PROGRESS
- COMPLETED
- FAILED
CreditAcceleratorLowBalanceOccurrence:
title: CreditAcceleratorLowBalanceOccurrence
type: object
properties:
segment2:
$ref: '#/components/schemas/CreditAcceleratorBalanceOccurrence'
segment1:
$ref: '#/components/schemas/CreditAcceleratorBalanceOccurrence'
segment4:
$ref: '#/components/schemas/CreditAcceleratorBalanceOccurrence'
segment3:
$ref: '#/components/schemas/CreditAcceleratorBalanceOccurrence'
Contact:
title: Contact
type: object
properties:
phone:
type: string
description: 'Phone number of the merchant
Applicable containers: bank,creditCard,investment,loan
'
email:
type: string
description: 'Email Id of the merchant
Applicable containers: bank,creditCard,investment,loan
'
CreditAcceleratorAccountHolder:
title: CreditAcceleratorAccountHolder
type: object
properties:
identifier:
type: array
description: 'Identifiers of the account holder.
Aggregated / Manual: Aggregated
Applicable containers: bank
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
items:
$ref: '#/components/schemas/Identifier'
gender:
type: string
description: 'Identifiers of the account holder.
Aggregated / Manual: Aggregated
Applicable containers: bank
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
ownership:
type: string
description: 'Indicates the ownership of the account.
Aggregated / Manual: Aggregated
Applicable containers: bank
Endpoints:- GET accounts
- GET accounts/{accountId}
Applicable Values
'
readOnly: true
enum:
- PRIMARY
- SECONDARY
- CUSTODIAN
- OTHERS
- POWER_OF_ATTORNEY
- TRUSTEE
- JOINT_OWNER
- BENEFICIARY
- AAS
- BUSINESS
- DBA
- TRUST
name:
$ref: '#/components/schemas/Name'
dateOfBirth:
type: string
description: Holder's date of birth
readOnly: true
CreditAcceleratorAllAccountAsset:
title: CreditAcceleratorAllAccountAsset
type: object
properties:
totalBalances:
type: array
description: Total sum of currentBalance (Bank) and totalBalance (Investment) values across all Bank and Investment accounts, grouped by Currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorBalance'
totalInvestmentBalances:
type: array
description: Total sum of Investment Balance values across all Investment accounts, grouped by Currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorBalance'
totalBankBalances:
type: array
description: Total sum of currentBalance values across all Bank accounts, grouped by Currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorBalance'
adjustmentTxnSummary:
type: array
description: Sum, count and average of Refund/Adjustment/Reimbursement Income transactions, grouped by currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
creditTxnWithoutTransferSummary:
type: array
description: Sum, count, and average of all credit transactions (excluding transfers), grouped by Currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
largeTransferOccurrences:
type: array
description: For each time period, the number of times where transactions exceeded the large transaction amount, grouped by Currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceOccurrence'
savingsTxnSummary:
type: array
description: Sum of savings transactions, grouped by currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceTxnSummary'
depositTxnSummary:
type: array
description: Sum, count, and average of all deposit transactions, grouped by Currency..
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
largeDepositOccurrences:
type: array
description: For each time period, the number of times where transactions exceeded the large transaction amount, grouped by Currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceOccurrence'
lowBalanceOccurrence:
$ref: '#/components/schemas/CreditAcceleratorLowBalanceOccurenceALL'
negativeBalanceOccurrences:
type: array
description: For each time period, the number of times where Daily Balance is less than zero, grouped by Currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceOccurrence'
transferTxnSummary:
type: array
description: Sum, count, and average of all transfer transactions, grouped by Currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
creditTxnWithTransferSummary:
type: array
description: Sum, count, and average of all credit transactions (including transfers), grouped by Currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
investmentHoldingSummary:
$ref: '#/components/schemas/CreditAcceleratorAllAccountInvestmentHoldingSummary'
nsfOccurrences:
type: array
description: For each time period, the number of times NSF has occurred, grouped by Currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceOccurrence'
CreditAcceleratorAccountSummary:
title: CreditAcceleratorAccountSummary
type: object
properties:
accountAnalysis:
$ref: '#/components/schemas/CreditAcceleratorAccountAnalysis'
accountVerification:
$ref: '#/components/schemas/CreditAcceleratorAccountVerification'
details:
$ref: '#/components/schemas/CreditAcceleratorAccount'
holdings:
type: array
items:
$ref: '#/components/schemas/Holding'
transactions:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorTransaction'
CreditAcceleratorBalanceAnalysis:
title: CreditAcceleratorBalanceAnalysis
type: object
properties:
daysAboveAverage:
type: number
description: Number of Daily Balances that are above the average for the time period.
format: double
readOnly: true
balanceStandardDeviation:
type: number
description: Standard Deviation of Daily Balance for the time period.
format: double
readOnly: true
timePeriod:
type: string
description: Time intervals to consider up to the number of days the application was requested
readOnly: true
daysBelowAverage:
type: number
description: Number of Daily Balances that are below the average for the time period.
format: double
readOnly: true
CreditAcceleratorDailyBalanceSummary:
title: CreditAcceleratorDailyBalanceSummary
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorDailySummary'
currency:
type: string
CreditAcceleratorAccountIncome:
title: CreditAcceleratorAccountIncome
type: object
properties:
regularIncomeTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
otherIncomeTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
servicesIncomeTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
depositTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
retirementTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
CreditAcceleratorFile:
title: CreditAcceleratorFile
type: object
properties:
configName:
type: string
description: The config name using which the credit accelerator file generation was requested
readOnly: true
docContent:
type: string
description: Contents of the document in Base64 format
readOnly: true
data:
$ref: '#/components/schemas/CreditAcceleratorData'
reportConfig:
$ref: '#/components/schemas/CreditAcceleratorReportConfig'
selectedAccounts:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorSelectedAccount'
submissionDate:
type: string
description: Date on which the request to generate credit accelerator file was submitted
readOnly: true
id:
type: integer
description: Unique identifier for credit accelerator report.
format: int64
readOnly: true
user:
$ref: '#/components/schemas/CreditAcceleratorUser'
originalReportId:
type: integer
description: Report id of original report on which refresh is performed. This is not available when report is generated for the first time.
format: int64
readOnly: true
status:
type: string
description: Generation status of the requested credit accelerator file requested
readOnly: true
enum:
- SUBMITTED
- IN_PROGRESS
- COMPLETED
- FAILED
CreditAcceleratorAccountAsset:
title: CreditAcceleratorAccountAsset
type: object
properties:
dailyBalanceAnalysis:
$ref: '#/components/schemas/CreditAcceleratorDailyBalanceAnalysis'
adjustmentTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
creditTxnWithoutTransferSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
largeTransferOccurrences:
$ref: '#/components/schemas/CreditAcceleratorBalanceOccurrenceWithTxn'
dailyBalanceSummary:
$ref: '#/components/schemas/CreditAcceleratorDailyBalanceSummary'
depositTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
dailyBalances:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorDailyBalance'
largeDepositOccurrences:
$ref: '#/components/schemas/CreditAcceleratorBalanceOccurrenceWithTxn'
lowBalanceOccurrence:
$ref: '#/components/schemas/CreditAcceleratorLowBalanceOccurrence'
negativeBalanceOccurrences:
$ref: '#/components/schemas/CreditAcceleratorBalanceOccurrence'
transferTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
creditTxnWithTransferSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
investmentHoldingSummary:
$ref: '#/components/schemas/CreditAcceleratorInvestmentHoldingSummary'
nsfOccurrences:
$ref: '#/components/schemas/CreditAcceleratorBalanceOccurrenceWithTxn'
CreditAcceleratorRefreshRequest:
title: CreditAcceleratorRefreshRequest
required:
- configName
type: object
properties:
configName:
type: string
description: The config name using which the credit accelerator file generation was requested
CreditAcceleratorBalanceSummary:
title: CreditAcceleratorBalanceSummary
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorSummary'
currency:
type: string
transactions:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorTransaction'
CreditAcceleratorAllAccountBalanceTxnSummary:
title: CreditAcceleratorAllAccountBalanceTxnSummary
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorTxnSummary'
currency:
type: string
CreditAcceleratorTxnSummary:
title: CreditAcceleratorTxnSummary
type: object
properties:
timePeriod:
type: string
description: Time intervals to consider up to the number of days the application was requested.
readOnly: true
sum:
type: number
description: Total amount for the time period.
format: double
readOnly: true
CreditAcceleratorCashFlowAnalysis:
title: CreditAcceleratorCashFlowAnalysis
type: object
properties:
cashInflowIncome:
type: number
description: Sum of cash inflow transactions identified as income.
format: double
readOnly: true
cashOutflowTransfers:
type: number
description: Sum of cash outflow transactions identified as transfers.
format: double
readOnly: true
cashOutflowTotalWithdrawalCountRatio:
type: number
description: Ratio of Total Withdrawal count to total transactions count.
format: double
readOnly: true
cashOutflowWithdrawals:
type: number
description: Sum of cash outflow transactions identified as checks and withdrawals.
format: double
readOnly: true
cashOutflow:
type: number
description: Sum of all cash outflow transactions.
format: double
readOnly: true
cashflowRatio:
type: number
description: Cash inflow divided by cash outflow.
format: double
readOnly: true
cashOutflowExpenses:
type: number
description: Sum of cash outflow transactions identified as expenses.
format: double
readOnly: true
adjustedCashInflow:
type: number
description: Sum of all cash inflow transactions (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashLeftover:
type: number
description: Cash inflow subtracted by cash outflow.
format: double
readOnly: true
cashOutflowDebitServicing:
type: number
description: Sum of cash outflow transactions identified as repayments of debt.
format: double
readOnly: true
cashOutflowWithdrawalToExpenseCountRatio:
type: number
description: Ratio of Cash withdrawal count to Expense transaction count.
format: double
readOnly: true
adjustedCashflowRatio:
type: number
description: Cash inflow (excluding large amounts) divided by cash outflow (excluding large amounts).
format: double
readOnly: true
cashInflowTransfers:
type: number
description: Sum of cash inflow transactions identified as transfers.
format: double
readOnly: true
cashInflowDepositCountRatio:
type: number
description: Ratio of Total Deposit count to total transactions count.
format: double
readOnly: true
adjustedCashOutflow:
type: number
description: Sum of all cash outflow transactions (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashInflowDeposits:
type: number
description: Sum of cash inflow transactions identified as deposits (excluding income).
format: double
readOnly: true
adjustedCashInflowTransfers:
type: number
description: Sum of cash inflow transactions identified as transfers (excluding large amounts), grouped by Currency.
format: double
readOnly: true
adjustedCashOutflowDebitServicing:
type: number
description: Sum of cash outflow transactions identified as repayments of debt (excluding large amounts), grouped by Currency.
format: double
readOnly: true
adjustedCashLeftover:
type: number
description: Cash inflow (excluding large amounts) subtracted by cash outflow (excluding large amounts).
format: double
readOnly: true
adjustedCashOutflowTransfers:
type: number
description: Sum of cash outflow transactions identified as transfers (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashOutflowOtherDebits:
type: number
description: Sum of cash outflow transactions identified as other debits.
format: double
readOnly: true
adjustedCashOutflowOtherDebits:
type: number
description: Sum of cash outflow transactions identified as other debits (excluding large amounts), grouped by Currency.
format: double
readOnly: true
adjustedCashOutflowWithdrawals:
type: number
description: Sum of cash outflow transactions identified as checks and withdrawals (excluding large amounts), grouped by Currency.
format: double
readOnly: true
adjustedCashInflowOtherCredits:
type: number
description: Sum of cash inflow transactions identified as other credits (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashInflow:
type: number
description: Sum of all cash inflow transactions.
format: double
readOnly: true
cashInflowOtherCredits:
type: number
description: Sum of cash inflow transactions identified as other credits.
format: double
readOnly: true
timePeriod:
type: string
description: Time intervals to consider up to the number of days the application was requested.
readOnly: true
adjustedCashInflowDeposits:
type: number
description: Sum of cash inflow transactions identified as deposits (excluding income and large amounts), grouped by Currency.
format: double
readOnly: true
adjustedCashOutflowExpenses:
type: number
description: Sum of cash outflow transactions identified as expenses (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashOutflowCashWithdrawalCountRatio:
type: number
description: Ratio of Cash withdrawal count to total withdrawal count.
format: double
readOnly: true
adjustedCashInflowIncome:
type: number
description: Sum of cash inflow transactions identified as income (excluding large amounts), grouped by Currency.
format: double
readOnly: true
CreditAcceleratorClassification:
title: CreditAcceleratorClassification
type: object
properties:
classificationTypes:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorClassificationType'
currency:
type: string
FullAccountNumberList:
title: FullAccountNumberList
type: object
properties:
paymentAccountNumber:
type: string
description: Payment Account Number of given account.
Endpoints:- GET accounts
- GET accounts/{accountId}
readOnly: true
unmaskedAccountNumber:
type: string
description: Unmasked account number of given account.
Endpoints:- GET accounts
- GET accounts/{accountId}
readOnly: true
CreditAcceleratorAllAccountCashFlowAnalysis:
title: CreditAcceleratorAllAccountCashFlowAnalysis
type: object
properties:
cashInflowIncome:
type: number
description: Sum of cash inflow transactions identified as income.
format: double
readOnly: true
cashOutflowTransfers:
type: number
description: Sum of cash outflow transactions identified as transfers.
format: double
readOnly: true
cashOutflowTotalWithdrawalCountRatio:
type: number
description: Ratio of Total Withdrawal count to total transactions count.
format: double
readOnly: true
cashOutflowWithdrawals:
type: number
description: Sum of cash outflow transactions identified as checks and withdrawals.
format: double
readOnly: true
cashOutflowTravelRatio:
type: number
description: Ratio of Travel Transactions to Income as a percentage.
format: double
readOnly: true
cashOutflow:
type: number
description: Sum of all cash outflow transactions.
format: double
readOnly: true
cashOutflowExpenses:
type: number
description: Sum of cash outflow transactions identified as expenses.
format: double
readOnly: true
adjustedCashInflow:
type: number
description: Sum of all cash inflow transactions (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashLeftover:
type: number
description: Cash inflow subtracted by cash outflow.
format: double
readOnly: true
cashOutflowDebitServicing:
type: number
description: Sum of cash outflow transactions identified as repayments of debt.
format: double
readOnly: true
cashOutflowWithdrawalToExpenseCountRatio:
type: number
description: Ratio of Cash withdrawal count to Expense transaction count.
format: double
readOnly: true
cashOutflowBank:
type: number
description: Sum of all cash outflow transactions for Bank accounts only, grouped by Currency.
format: double
readOnly: true
adjustedCashOutflowBank:
type: number
description: Sum of all cash outflow transactions (excluding large amounts) for Bank accounts only, grouped by Currency.
format: double
readOnly: true
cashInflowTransfers:
type: number
description: Sum of cash inflow transactions identified as transfers (excluding large amounts), grouped by Currency.
format: double
readOnly: true
adjustedCashLeftoverBank:
type: number
description: Bank cash inflow (excluding large amounts) subtracted by Bank cash outflow (excluding large amounts).
format: double
readOnly: true
cashInflowDepositCountRatio:
type: number
description: Ratio of Total Deposit count to total transactions count.
format: double
readOnly: true
adjustedCashOutflow:
type: number
description: Sum of all cash outflow transactions (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashInflowDeposits:
type: number
description: Sum of cash inflow transactions identified as deposits (excluding income).
format: double
readOnly: true
adjustedCashInflowTransfers:
type: number
description: Sum of cash outflow transactions identified as checks and withdrawals.
format: double
readOnly: true
cashInflowBank:
type: number
description: Sum of all cash inflow transactions for Bank accounts only, grouped by Currency.
format: double
readOnly: true
adjustedCashOutflowDebitServicing:
type: number
description: Sum of cash outflow transactions identified as repayments of debt (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashLeftoverBank:
type: number
description: Bank cash inflow subtracted by Bank cash outflow.
format: double
readOnly: true
adjustedCashLeftover:
type: number
description: Cash inflow (excluding large amounts) subtracted by cash outflow (excluding large amounts).
format: double
readOnly: true
adjustedCashOutflowTransfers:
type: number
description: Sum of cash outflow transactions identified as transfers (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashOutflowOtherDebits:
type: number
description: Sum of cash outflow transactions identified as other debits.
format: double
readOnly: true
adjustedCashInflowBank:
type: number
description: Sum of all cash inflow transactions (excluding large amounts) for Bank accounts only, grouped by Currency.
format: double
readOnly: true
cashInflowServicesRatio:
type: number
description: Ratio of Services/Supplies to Income as a percentage.
format: double
readOnly: true
adjustedCashOutflowOtherDebits:
type: number
description: Sum of cash outflow transactions identified as other debits (excluding large amounts), grouped by Currency.
format: double
readOnly: true
adjustedCashOutflowWithdrawals:
type: number
description: Sum of cash outflow transactions identified as checks and withdrawals (excluding large amounts), grouped by Currency.
format: double
readOnly: true
adjustedCashInflowOtherCredits:
type: number
description: Sum of cash inflow transactions identified as other credits (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashInflow:
type: number
description: Sum of all cash inflow transactions.
format: double
readOnly: true
cashInflowOtherCredits:
type: number
description: Sum of cash inflow transactions identified as other credits.
format: double
readOnly: true
timePeriod:
type: string
description: Time intervals to consider up to the number of days the application was requested.
readOnly: true
adjustedCashInflowDeposits:
type: number
description: Sum of cash inflow transactions identified as deposits (excluding income and large amounts), grouped by Currency.
format: double
readOnly: true
adjustedCashOutflowExpenses:
type: number
description: Sum of cash outflow transactions identified as expenses (excluding large amounts), grouped by Currency.
format: double
readOnly: true
cashOutflowCashWithdrawalCountRatio:
type: number
description: Ratio of Cash withdrawal count to total withdrawal count.
format: double
readOnly: true
adjustedCashInflowIncome:
type: number
description: Sum of cash inflow transactions identified as income (excluding large amounts), grouped by Currency.
format: double
readOnly: true
CreditAcceleratorAccount:
title: CreditAcceleratorAccount
type: object
properties:
availableCash:
$ref: '#/components/schemas/Money'
includeInNetWorth:
type: boolean
description: 'Used to determine whether an account to be considered in the networth calculation.
Aggregated / Manual: Aggregated
Applicable containers: bank,creditCard,loan,investment,insurance,realEstate,otherAssets,otherLiabilities
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
moneyMarketBalance:
$ref: '#/components/schemas/Money'
enrollmentDate:
type: string
description: 'Date on which the user is enrolled on the rewards program.
Aggregated / Manual: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
estimatedDate:
type: string
description: 'The date on which the home value was estimated.
Aggregated / Manual: Manual
Applicable containers: realEstate
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
memo:
type: string
description: 'The additional description or notes given by the user.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
guarantor:
type: string
description: 'A nonprofit or state organization that works with lender, servicer, school, and the Department of Education to help successfully repay Federal Family Education Loan Program (FFELP) loans. If FFELP student loans default, the guarantor takes ownership of them.
Aggregated / Manual: Aggregated
Applicable containers: loan
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
interestPaidLastYear:
$ref: '#/components/schemas/Money'
lastUpdated:
type: string
description: 'The date time the account information was last retrieved from the provider site and updated in the Yodlee system.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
balance:
$ref: '#/components/schemas/Money'
homeInsuranceType:
type: string
description: 'Type of home insurance, like -- HOME_OWNER
- RENTAL
- RENTER
- etc..
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- HOME_OWNER
- RENTAL
- RENTER
- UNKNOWN
- OTHER
id:
type: integer
description: 'The primary key of the account resource and the unique identifier for the account.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET investmentOptions
- GET accounts/historicalBalances
- POST accounts
- GET dataExtracts/userData
'
format: int64
readOnly: true
cash:
$ref: '#/components/schemas/Money'
totalCreditLine:
$ref: '#/components/schemas/Money'
providerName:
type: string
description: 'Service provider or institution name where the account originates. This belongs to the provider resource.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
valuationType:
type: string
description: 'The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners.
Aggregated / Manual: Manual
Applicable containers: realEstate
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- SYSTEM
- MANUAL
marginBalance:
$ref: '#/components/schemas/Money'
apr:
type: number
description: 'The annual percentage rate (APR) is the yearly rate of interest on the credit card account.
Additional Details: The yearly percentage rate charged when a balance is held on a credit card. This rate of interest is applied every month on the outstanding credit card balance.
Aggregated / Manual: Aggregated
Applicable containers: creditCard
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
format: double
readOnly: true
availableCredit:
$ref: '#/components/schemas/Money'
currentBalance:
$ref: '#/components/schemas/Money'
isManual:
type: boolean
description: 'Indicates if an account is aggregated from a site or it is a manual account i.e. account information manually provided by the user.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
profile:
$ref: '#/components/schemas/CreditAcceleratorAccountProfile'
escrowBalance:
$ref: '#/components/schemas/Money'
nextLevel:
type: string
description: 'The eligible next level of the rewards program.
Aggregated / Manual: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
classification:
type: string
description: 'The classification of the account such as personal, corporate, etc.
Aggregated / Manual: Aggregated
Applicable containers: bank, creditCard, investment, reward, loan, insurance
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- OTHER
- PERSONAL
- CORPORATE
- SMALL_BUSINESS
- TRUST
- ADD_ON_CARD
- VIRTUAL_CARD
loanPayoffAmount:
$ref: '#/components/schemas/Money'
interestRateType:
type: string
description: 'The type of the interest rate, for example, fixed or variable.
Applicable containers: loan
Aggregated / Manual: Aggregated
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- FIXED
- VARIABLE
- UNKNOWN
- OTHER
loanPayByDate:
type: string
description: 'The date by which the payoff amount should be paid.
Aggregated / Manual: Aggregated
Applicable containers: loan
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
faceAmount:
$ref: '#/components/schemas/Money'
policyFromDate:
type: string
description: 'The date the insurance policy began.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
premiumPaymentTerm:
type: string
description: 'The number of years for which premium payments have to be made in a policy.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
policyTerm:
type: string
description: 'The duration for which the policy is valid or in effect. For example, one year, five years, etc.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
repaymentPlanType:
type: string
description: 'The type of repayment plan that the borrower prefers to repay the loan.
Aggregated / Manual: Aggregated
Applicable containers: loan
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values:
'
readOnly: true
enum:
- STANDARD
- GRADUATED
- EXTENDED
- INCOME_BASED
- INCOME_CONTINGENT
- INCOME_SENSITIVE
- PAY_AS_YOU_EARN
- REVISED_PAY_AS_YOU_EARN
aggregatedAccountType:
type: string
description: The type of account that is aggregated.
readOnly: true
availableBalance:
$ref: '#/components/schemas/Money'
reconciliable:
type: boolean
accountStatus:
type: string
description: 'The status of the account that is updated by the consumer through an application or an API. Valid Values: AccountStatus
Additional Details:
ACTIVE: All the added manual and aggregated accounts status will be made "ACTIVE" by default.
TO_BE_CLOSED: If the aggregated accounts are not found or closed in the data provider site, Yodlee system marks the status as TO_BE_CLOSED
INACTIVE: Users can update the status as INACTIVE to stop updating and to stop considering the account in other services
CLOSED: Users can update the status as CLOSED, if the account is closed with the provider.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- ACTIVE
- INACTIVE
- TO_BE_CLOSED
- CLOSED
- DELETED
lifeInsuranceType:
type: string
description: 'Type of life insurance.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- OTHER
- TERM_LIFE_INSURANCE
- UNIVERSAL_LIFE_INSURANCE
- WHOLE_LIFE_INSURANCE
- VARIABLE_LIFE_INSURANCE
- ULIP
- ENDOWMENT
fullAccountNumber:
type: string
description: 'Full account number of the account that is included only when include = fullAccountNumber is provided in the request. For student loan account the account number that will be used for ACH or fund transfer
Aggregated / Manual: Both
Applicable containers: bank, creditCard, investment, insurance, loan, reward, otherAssets, otherLiabilities
Endpoints:- GET accounts
- GET accounts/{accountId}
Note : fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.
'
readOnly: true
premium:
$ref: '#/components/schemas/Money'
aggregationSource:
type: string
description: 'The source through which the account(s) are added in the system.
Valid Values: SYSTEM, USER
Applicable containers: All Containers
Aggregated / Manual: Both
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- SYSTEM
- USER
overDraftLimit:
$ref: '#/components/schemas/Money'
nickname:
type: string
description: 'The nickname of the account as provided by the consumer to identify an account. The account nickname can be used instead of the account name.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
term:
type: string
description: 'The tenure for which the CD account is valid or in case of loan, the number of years/months over which the loan amount has to be repaid.
Additional Details:
Bank: The Term field is only applicable for the account type CD.Loan: The period for which the loan agreement is in force. The period, before or at the end of which, the loan should either be repaid or renegotiated for another term.
Aggregated / Manual: Aggregated
Applicable containers: bank, loan
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
interestRate:
type: number
description: '
Bank: The interest rate offered by a FI to its depositors on a bank account.
Loan: Interest rate applied on the loan.
Additional Details:
Note: The Interest Rate field is only applicable for the following account types: savings, checking, money market, and certificate of deposit.
Aggregated / Manual: Aggregated
Applicable containers: bank, loan
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
format: double
readOnly: true
deathBenefit:
$ref: '#/components/schemas/Money'
address:
$ref: '#/components/schemas/CreditAcceleratorAccountAddress'
cashValue:
$ref: '#/components/schemas/Money'
holder:
type: array
description: 'Holder details of the account.
Aggregated / Manual: Aggregated
Applicable containers: bank
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAccountHolder'
401kLoan:
$ref: '#/components/schemas/Money'
homeValue:
$ref: '#/components/schemas/Money'
accountNumber:
type: string
description: 'The account number as it appears on the site. (The POST accounts service response return this field as number)
Additional Details: Bank/ Loan/ Insurance/ Investment:
The account number for the bank account as it appears at the site.
Credit Card: The account number of the card account as it appears at the site,
i.e., the card number.The account number can be full or partial based on how it is displayed in the account summary page of the site.In most cases, the site does not display the full account number in the account summary page and additional navigation is required to aggregate it.
Applicable containers: All Containers
Aggregated / Manual: Both
Endpoints:
- GET accounts
- GET accounts/{accountId}
- POST accounts
- GET dataExtracts/userData
'
readOnly: true
createdDate:
type: string
description: 'The date on which the account is created in the Yodlee system.
Additional Details: It is the date when the user links or aggregates the account(s) that are held with the provider to the Yodlee system.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
interestPaidYTD:
$ref: '#/components/schemas/Money'
providerAccountId:
type: integer
description: 'The primary key of the provider account resource.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
format: int64
readOnly: true
collateral:
type: string
description: 'Property or possession offered to support a loan that can be seized on a default.
Applicable containers: loan
Aggregated / Manual: Aggregated
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
dataset:
type: array
readOnly: true
items:
$ref: '#/components/schemas/AccountDataset'
runningBalance:
$ref: '#/components/schemas/Money'
isReconciliable:
type: boolean
readOnly: true
sourceId:
type: string
description: 'A unique ID that the provider site has assigned to the account. The source ID is only available for the HELD accounts.
Applicable containers: bank, creditCard, investment, insurance, loan, reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
dueDate:
type: string
description: 'The date on which the due amount has to be paid.
Additional Details:
Credit Card: The monthly date by when the minimum payment is due to be paid on the credit card account.
Loan: The date on or before which the due amount should be paid.
Note: The due date at the account-level can differ from the due date field at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer.
Aggregated / Manual: Aggregated
Applicable containers: creditCard, loan, insurance
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
frequency:
type: string
description: 'The frequency of the billing cycle of the account in case of card. The frequency in which premiums are paid in an insurance policy such as monthly, quarterly, and annually. The frequency in which due amounts are paid in a loan account.
Aggregated / Manual: Both
Applicable containers: creditCard, insurance, loan
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- DAILY
- ONE_TIME
- WEEKLY
- EVERY_2_WEEKS
- SEMI_MONTHLY
- MONTHLY
- QUARTERLY
- SEMI_ANNUALLY
- ANNUALLY
- EVERY_2_MONTHS
- EBILL
- FIRST_DAY_MONTHLY
- LAST_DAY_MONTHLY
- EVERY_4_WEEKS
- UNKNOWN
- OTHER
maturityAmount:
$ref: '#/components/schemas/Money'
associatedProviderAccountId:
type: array
description: 'The providerAccountIds that share the account with the primary providerAccountId that was created when the user had added the account for the first time.
Additional Details: This attribute is returned in the response only if the account deduplication feature is enabled and the same account is mapped to more than one provider account IDs indicating the account is owned by more than one user, for example, joint accounts.
Aggregated / Manual: Aggregated
Applicable containers: All Containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
items:
type: integer
format: int64
isAsset:
type: boolean
description: 'The account to be considered as an asset or liability.
Applicable containers: All Containers
Aggregated / Manual: Both
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
principalBalance:
$ref: '#/components/schemas/Money'
totalCashLimit:
$ref: '#/components/schemas/Money'
maturityDate:
type: string
description: 'The date when a certificate of deposit (CD/FD) matures or the final payment date of a loan at which point the principal amount (including pending interest) is due to be paid.
Additional Details: The date when a certificate of deposit (CD) matures, i.e., the money in the CD can be withdrawn without paying an early withdrawal penalty.The final payment date of a loan, i.e., the principal amount (including pending interest) is due to be paid.
Aggregated / Manual: Aggregated
Applicable containers: bank, loan
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
minimumAmountDue:
$ref: '#/components/schemas/Money'
annualPercentageYield:
type: number
description: 'Annual percentage yield (APY) is a normalized representation of an interest rate, based on a compounding period of one year. APY generally refers to the rate paid to a depositor by a financial institution on an account.
Applicable containers: bank
Aggregated / Manual: Aggregated
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
format: double
readOnly: true
accountType:
type: string
description: 'The type of account that is aggregated, i.e., savings, checking, credit card, charge, HELOC, etc. The account type is derived based on the attributes of the account.
Valid Values:
Aggregated Account Type
bank- CHECKING
- SAVINGS
- CD
- PPF
- RECURRING_DEPOSIT
- FSA
- MONEY_MARKET
- IRA
- PREPAID
creditCard- OTHER
- CREDIT
- STORE
- CHARGE
- OTHER
investment (SN 1.0)- BROKERAGE_MARGIN
- HSA
- IRA
- BROKERAGE_CASH
- 401K
- 403B
- TRUST
- ANNUITY
- SIMPLE
- CUSTODIAL
- BROKERAGE_CASH_OPTION
- BROKERAGE_MARGIN_OPTION
- INDIVIDUAL
- CORPORATE
- JTTIC
- JTWROS
- COMMUNITY_PROPERTY
- JOINT_BY_ENTIRETY
- CONSERVATORSHIP
- ROTH
- ROTH_CONVERSION
- ROLLOVER
- EDUCATIONAL
- 529_PLAN
- 457_DEFERRED_COMPENSATION
- 401A
- PSP
- MPP
- STOCK_BASKET
- LIVING_TRUST
- REVOCABLE_TRUST
- IRREVOCABLE_TRUST
- CHARITABLE_REMAINDER
- CHARITABLE_LEAD
- CHARITABLE_GIFT_ACCOUNT
- SEP
- UTMA
- UGMA
- ESOPP
- ADMINISTRATOR
- EXECUTOR
- PARTNERSHIP
- SOLE_PROPRIETORSHIP
- CHURCH
- INVESTMENT_CLUB
- RESTRICTED_STOCK_AWARD
- CMA
- EMPLOYEE_STOCK_PURCHASE_PLAN
- PERFORMANCE_PLAN
- BROKERAGE_LINK_ACCOUNT
- MONEY_MARKET
- SUPER_ANNUATION
- REGISTERED_RETIREMENT_SAVINGS_PLAN
- SPOUSAL_RETIREMENT_SAVINGS_PLAN
- DEFERRED_PROFIT_SHARING_PLAN
- NON_REGISTERED_SAVINGS_PLAN
- REGISTERED_EDUCATION_SAVINGS_PLAN
- GROUP_RETIREMENT_SAVINGS_PLAN
- LOCKED_IN_RETIREMENT_SAVINGS_PLAN
- RESTRICTED_LOCKED_IN_SAVINGS_PLAN
- LOCKED_IN_RETIREMENT_ACCOUNT
- REGISTERED_PENSION_PLAN
- TAX_FREE_SAVINGS_ACCOUNT
- LIFE_INCOME_FUND
- REGISTERED_RETIREMENT_INCOME_FUND
- SPOUSAL_RETIREMENT_INCOME_FUND
- LOCKED_IN_REGISTERED_INVESTMENT_FUND
- PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND
- GUARANTEED_INVESTMENT_CERTIFICATES
- REGISTERED_DISABILITY_SAVINGS_PLAN
- DIGITAL_WALLET
- OTHER
investment (SN 2.0)- BROKERAGE_CASH
- BROKERAGE_MARGIN
- INDIVIDUAL_RETIREMENT_ACCOUNT_IRA
- EMPLOYEE_RETIREMENT_ACCOUNT_401K
- EMPLOYEE_RETIREMENT_SAVINGS_PLAN_403B
- TRUST
- ANNUITY
- SIMPLE_IRA
- CUSTODIAL_ACCOUNT
- BROKERAGE_CASH_OPTION
- BROKERAGE_MARGIN_OPTION
- INDIVIDUAL
- CORPORATE_INVESTMENT_ACCOUNT
- JOINT_TENANTS_TENANCY_IN_COMMON_JTIC
- JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP_JTWROS
- JOINT_TENANTS_COMMUNITY_PROPERTY
- JOINT_TENANTS_TENANTS_BY_ENTIRETY
- CONSERVATOR
- ROTH_IRA
- ROTH_CONVERSION
- ROLLOVER_IRA
- EDUCATIONAL
- EDUCATIONAL_SAVINGS_PLAN_529
- DEFERRED_COMPENSATION_PLAN_457
- MONEY_PURCHASE_RETIREMENT_PLAN_401A
- PROFIT_SHARING_PLAN
- MONEY_PURCHASE_PLAN
- STOCK_BASKET_ACCOUNT
- LIVING_TRUST
- REVOCABLE_TRUST
- IRREVOCABLE_TRUST
- CHARITABLE_REMAINDER_TRUST
- CHARITABLE_LEAD_TRUST
- CHARITABLE_GIFT_ACCOUNT
- SEP_IRA
- UNIFORM_TRANSFER_TO_MINORS_ACT_UTMA
- UNIFORM_GIFT_TO_MINORS_ACT_UGMA
- EMPLOYEE_STOCK_OWNERSHIP_PLAN_ESOP
- ADMINISTRATOR
- EXECUTOR
- PARTNERSHIP
- PROPRIETORSHIP
- CHURCH_ACCOUNT
- INVESTMENT_CLUB
- RESTRICTED_STOCK_AWARD
- CASH_MANAGEMENT_ACCOUNT
- EMPLOYEE_STOCK_PURCHASE_PLAN_ESPP
- PERFORMANCE_PLAN
- BROKERAGE_LINK_ACCOUNT
- MONEY_MARKET_ACCOUNT
- SUPERANNUATION
- REGISTERED_RETIREMENT_SAVINGS_PLAN_RRSP
- SPOUSAL_RETIREMENT_SAVINGS_PLAN_SRSP
- DEFERRED_PROFIT_SHARING_PLAN_DPSP
- NON_REGISTERED_SAVINGS_PLAN_NRSP
- REGISTERED_EDUCATION_SAVINGS_PLAN_RESP
- GROUP_RETIREMENT_SAVINGS_PLAN_GRSP
- LOCKED_IN_RETIREMENT_SAVINGS_PLAN_LRSP
- RESTRICTED_LOCKED_IN_SAVINGS_PLAN_RLSP
- LOCKED_IN_RETIREMENT_ACCOUNT_LIRA
- REGISTERED_PENSION_PLAN_RPP
- TAX_FREE_SAVINGS_ACCOUNT_TFSA
- LIFE_INCOME_FUND_LIF
- REGISTERED_RETIREMENT_INCOME_FUND_RIF
- SPOUSAL_RETIREMENT_INCOME_FUND_SRIF
- LOCKED_IN_REGISTERED_INVESTMENT_FUND_LRIF
- PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND_PRIF
- GUARANTEED_INVESTMENT_CERTIFICATES_GIC
- REGISTERED_DISABILITY_SAVINGS_PLAN_RDSP
- DEFINED_CONTRIBUTION_PLAN
- DEFINED_BENEFIT_PLAN
- EMPLOYEE_STOCK_OPTION_PLAN
- NONQUALIFIED_DEFERRED_COMPENSATION_PLAN_409A
- KEOGH_PLAN
- EMPLOYEE_RETIREMENT_ACCOUNT_ROTH_401K
- DEFERRED_CONTINGENT_CAPITAL_PLAN_DCCP
- EMPLOYEE_BENEFIT_PLAN
- EMPLOYEE_SAVINGS_PLAN
- HEALTH_SAVINGS_ACCOUNT_HSA
- COVERDELL_EDUCATION_SAVINGS_ACCOUNT_ESA
- TESTAMENTARY_TRUST
- ESTATE
- GRANTOR_RETAINED_ANNUITY_TRUST_GRAT
- ADVISORY_ACCOUNT
- NON_PROFIT_ORGANIZATION_501C
- HEALTH_REIMBURSEMENT_ARRANGEMENT_HRA
- INDIVIDUAL_SAVINGS_ACCOUNT_ISA
- CASH_ISA
- STOCKS_AND_SHARES_ISA
- INNOVATIVE_FINANCE_ISA
- JUNIOR_ISA
- EMPLOYEES_PROVIDENT_FUND_ORGANIZATION_EPFO
- PUBLIC_PROVIDENT_FUND_PPF
- EMPLOYEES_PENSION_SCHEME_EPS
- NATIONAL_PENSION_SYSTEM_NPS
- INDEXED_ANNUITY
- ANNUITIZED_ANNUITY
- VARIABLE_ANNUITY
- ROTH_403B
- SPOUSAL_IRA
- SPOUSAL_ROTH_IRA
- SARSEP_IRA
- SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP
- OFFSHORE_TRUST
- IRREVOCABLE_LIFE_INSURANCE_TRUST
- INTERNATIONAL_TRUST
- LIFE_INTEREST_TRUST
- EMPLOYEE_BENEFIT_TRUST
- PRECIOUS_METAL_ACCOUNT
- INVESTMENT_LOAN_ACCOUNT
- GRANTOR_RETAINED_INCOME_TRUST
- PENSION_PLAN
- DIGITAL_WALLET
- OTHER
loan- MORTGAGE
- INSTALLMENT_LOAN
- PERSONAL_LOAN
- HOME_EQUITY_LINE_OF_CREDIT
- LINE_OF_CREDIT
- AUTO_LOAN
- STUDENT_LOAN
- HOME_LOAN
insurance- AUTO_INSURANCE
- HEALTH_INSURANCE
- HOME_INSURANCE
- LIFE_INSURANCE
- ANNUITY
- TRAVEL_INSURANCE
- INSURANCE
realEstaterewardManual Account Type
bankcreditloaninsuranceinvestment
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
originationDate:
type: string
description: 'The date on which the loan is disbursed.
Aggregated / Manual: Both
Applicable containers: loan
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
totalVestedBalance:
$ref: '#/components/schemas/Money'
rewardBalance:
type: array
description: 'Information of different reward balances associated with the account.
Aggregated / Manual: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
items:
$ref: '#/components/schemas/RewardBalance'
sourceAccountStatus:
type: string
description: 'Indicates the status of the loan account.
Aggregated / Manual: Aggregated
Applicable containers: loan
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values:
'
readOnly: true
enum:
- IN_REPAYMENT
- DEFAULTED
- IN_SCHOOL
- IN_GRACE_PERIOD
- DELINQUENCY
- DEFERMENT
- FORBEARANCE
linkedAccountIds:
type: array
description: 'List of Loan accountId(s) to which the real-estate account is linked
Aggregated / Manual: Both
Applicable containers: realEstate
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
items:
type: integer
format: int64
derivedApr:
type: number
description: 'Derived APR will be an estimated purchase APR based on consumers credit card transactions and credit card purchase.
Aggregated / Manual / Derived: Derived
Applicable containers: creditCard
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
format: double
readOnly: true
policyEffectiveDate:
type: string
description: 'The date on which the insurance policy coverage commences.
Applicable containers: insurance
Aggregated / Manual: Aggregated
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
totalUnvestedBalance:
$ref: '#/components/schemas/Money'
annuityBalance:
$ref: '#/components/schemas/Money'
accountName:
type: string
description: 'The account name as it appears at the site.
(The POST accounts service response return this field as name)
Applicable containers: All Containers
Aggregated / Manual: Both
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
totalCreditLimit:
$ref: '#/components/schemas/Money'
policyStatus:
type: string
description: 'The status of the policy.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- ACTIVE
- IN_ACTIVE
- OTHER
shortBalance:
$ref: '#/components/schemas/Money'
lender:
type: string
description: 'The financial institution that provides the loan.
Aggregated / Manual: Aggregated
Applicable containers: loan
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
lastEmployeeContributionAmount:
$ref: '#/components/schemas/Money'
providerId:
type: string
description: 'Identifier of the provider site. The primary key of provider resource.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
lastPaymentDate:
type: string
description: 'The date on which the payment for the previous or current billing cycle is done.
Additional Details: If the payment is already done for the current billing cycle, then the field indicates the payment date of the current billing cycle. If payment is yet to be done for the current billing cycle, then the field indicates the date on which the payment was made for any of the previous billing cycles. The last payment date at the account-level can differ from the last payment date at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer.
Aggregated / Manual: Aggregated
Applicable containers: creditCard, loan, insurance
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
primaryRewardUnit:
type: string
description: 'Primary reward unit for this reward program. E.g. miles, points, etc.
Aggregated / Manual: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
lastPaymentAmount:
$ref: '#/components/schemas/Money'
remainingBalance:
$ref: '#/components/schemas/Money'
userClassification:
type: string
description: 'Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities
Endpoints:- GET accounts
- GET accounts/{accountId}
- POST accounts
GET dataExtracts/userDataApplicable Values
'
readOnly: true
enum:
- BUSINESS
- PERSONAL
bankTransferCode:
type: array
description: 'Bank and branch identification information.
Aggregated / Manual: Aggregated
Applicable containers: bank, investment, loan
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorBankTransferCode'
expirationDate:
type: string
description: 'The date on which the insurance policy expires or matures.
Additional Details: The due date at the account-level can differ from the due date field at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
coverage:
type: array
description: 'The coverage-related details of the account.
Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
items:
$ref: '#/components/schemas/Coverage'
cashApr:
type: number
description: 'Annual percentage rate applied to cash withdrawals on the card.
Account Type: Aggregated
Applicable containers: creditCard
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
format: double
autoRefresh:
$ref: '#/components/schemas/AutoRefresh'
oauthMigrationStatus:
type: string
description: Indicates the migration status of the account from screen-scraping provider to the Open Banking provider.
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
readOnly: true
enum:
- IN_PROGRESS
- TO_BE_MIGRATED
- COMPLETED
- MIGRATED
displayedName:
type: string
description: 'The name or identification of the account owner, as it appears at the FI site.
Note: The account holder name can be full or partial based on how it is displayed in the account summary page of the FI site. In most cases, the FI site does not display the full account holder name in the account summary page.
Aggregated / Manual: Aggregated
Applicable containers: bank, creditCard, investment, insurance, loan, reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
fullAccountNumberList:
$ref: '#/components/schemas/FullAccountNumberList'
amountDue:
$ref: '#/components/schemas/Money'
currentLevel:
type: string
description: 'Current level of the reward program the user is associated with. E.g. Silver, Jade etc.
Aggregated / Manual: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
originalLoanAmount:
$ref: '#/components/schemas/Money'
policyToDate:
type: string
description: 'The date to which the policy exists.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:
- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
loanPayoffDetails:
$ref: '#/components/schemas/LoanPayoffDetails'
paymentProfile:
$ref: '#/components/schemas/CreditAcceleratorPaymentProfile'
CONTAINER:
type: string
description: 'The type of service. E.g., Bank, Credit Card, Investment, Insurance, etc.
Aggregated / Manual: Aggregated
Applicable containers: All containers
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- bank
- creditCard
- investment
- insurance
- loan
- reward
- bill
- realEstate
- otherAssets
- otherLiabilities
lastEmployeeContributionDate:
type: string
description: 'The date on which the last employee contribution was made to the 401k account.
Note: The last employee contribution date field is derived from the transaction data and not aggregated from the FI site. The field is only applicable to the 401k account type.
Aggregated / Manual: Aggregated
Applicable containers: investment
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
lastPayment:
$ref: '#/components/schemas/Money'
recurringPayment:
$ref: '#/components/schemas/Money'
CreditAcceleratorRequestingFirm:
title: CreditAcceleratorRequestingFirm
type: object
properties:
requestingFirmId:
type: string
description: Unique identifier for the requesting firm
readOnly: true
referenceNo:
type: string
description: Reference number of requesting firm
readOnly: true
name:
type: string
description: Name of the requesting firm
readOnly: true
broker:
type: string
description: Name of the broker
readOnly: true
CreditAcceleratorAccountProfile:
title: CreditAcceleratorAccountProfile
type: object
properties:
identifier:
type: array
description: 'Identifiers available in the profile page of the account.
Account Type: Aggregated
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
items:
$ref: '#/components/schemas/Identifier'
address:
type: array
description: 'Address available in the profile page of the account.
Account Type: Aggregated
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAccountAddress'
phoneNumber:
type: array
description: 'Phone number available in the profile page of the account.
Account Type: Aggregated
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
items:
$ref: '#/components/schemas/PhoneNumber'
email:
type: array
description: 'Email Id available in the profile page of the account.
Account Type: Aggregated
Endpoints:- GET accounts
- GET accounts/{accountId}
'
readOnly: true
items:
$ref: '#/components/schemas/Email'
CreditAcceleratorAllAccountBalanceOccurrence:
title: CreditAcceleratorAllAccountBalanceOccurrence
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorOccurence'
currency:
type: string
CreditAcceleratorGenerateRequest:
title: CreditAcceleratorGenerateRequest
required:
- configName
type: object
properties:
configName:
type: string
description: The config name using which the credit accelerator file generation was requested
requestingFirm:
$ref: '#/components/schemas/CreditAcceleratorRequestingFirm'
accountIds:
type: array
description: Mention account ids for which credit accelerator file generation is getting requested. mentioned accountid should belong to containers bank or loan or investment
readOnly: true
items:
type: integer
format: int64
CreditAcceleratorInvestmentHoldingSummary:
title: CreditAcceleratorInvestmentHoldingSummary
type: object
properties:
totalValue:
$ref: '#/components/schemas/Money'
classification:
$ref: '#/components/schemas/CreditAcceleratorClassification'
CreditAcceleratorLowBalanceOccurenceALL:
title: CreditAcceleratorLowBalanceOccurenceALL
type: object
properties:
segment2:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceOccurrence'
segment1:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceOccurrence'
segment4:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceOccurrence'
segment3:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceOccurrence'
CreditAcceleratorUser:
title: CreditAcceleratorUser
type: object
properties:
loginName:
type: string
description: The login name of the user used for authentication. This has to be provided as an input to the POST user/login service.
readOnly: true
name:
$ref: '#/components/schemas/Name'
userId:
type: integer
description: The unique identifier of a consumer/user in the Yodlee system for whom the API services would be accessed for.
format: int64
readOnly: true
email:
type: string
description: The email address of the user.
readOnly: true
Holding:
title: Holding
type: object
properties:
symbol:
type: string
description: 'The symbol of the security.
Applicable containers: investment
'
readOnly: true
exercisedQuantity:
type: number
description: 'The quantity of the employee stock options that are already exercised or bought by the employee.
Note: Once the employee stock options is exercised, they are either converted to cash value or equity positions depending on the FI. The exercised quantity field is only applicable to employee stock options.
Applicable containers: investment
'
format: double
readOnly: true
cusipNumber:
type: string
description: 'The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada.
Applicable containers: investment
'
readOnly: true
assetClassification:
type: array
description: 'Asset classification applied to the holding.
Applicable containers: investment
'
readOnly: true
items:
$ref: '#/components/schemas/AssetClassification'
vestedQuantity:
type: number
description: 'The quantity of units or shares that are already vested on a vest date.
Note: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.
Applicable containers: investment
'
format: double
readOnly: true
description:
type: string
description: 'The description (name) for the holding (E.g., Cisco Systems)
For insurance container, the field is only applicable for insurance annuity and variable life insurance types.
Applicable containers: investment, insurance
'
readOnly: true
unvestedValue:
$ref: '#/components/schemas/Money'
securityStyle:
type: string
description: 'Indicates the security style of holding identified through the security service.
Applicable containers: investment, insurance
'
readOnly: true
vestedValue:
$ref: '#/components/schemas/Money'
optionType:
type: string
description: 'The type of the option position (i.e., put or call).
Note: The option type field is only applicable to options.
Applicable containers: investment
Applicable Values
'
readOnly: true
enum:
- put
- call
- unknown
- other
lastUpdated:
type: string
description: 'The date when the information was last updated in the system.
Applicable containers: investment, insurance
'
readOnly: true
matchStatus:
type: string
description: 'Indicates the security match status id of the investment option identified during security normalization.
Applicable containers: investment
'
readOnly: true
holdingType:
type: string
description: 'Type of holding
Applicable containers: investment, insurance
'
readOnly: true
enum:
- stock
- mutualFund
- bond
- CD
- option
- moneyMarketFund
- other
- remic
- future
- commodity
- currency
- unitInvestmentTrust
- employeeStockOption
- insuranceAnnuity
- unknown
- preferredStock
- ETF
- warrants
- digitalAsset
maturityDate:
type: string
description: 'The stated maturity date of a bond or CD.
Applicable containers: investment
'
readOnly: true
price:
$ref: '#/components/schemas/Money'
term:
type: string
description: 'The fixed duration for which the bond or CD is issued.
Note: The term field is only applicable to CD.
Applicable containers: investment
'
readOnly: true
contractQuantity:
type: number
description: 'The quantity of tradeable units in a contract.
Note: The contract quantity field is only applicable to commodity and currency.
Applicable containers: investment
'
format: double
readOnly: true
id:
type: integer
description: 'Unique identifier for the security added in the system. This is the primary key of the holding resource.
Applicable containers: investment, insurance
'
format: int64
readOnly: true
isShort:
type: boolean
description: 'Indicates that the holding is a short trading.
Applicable containers: investment
'
readOnly: true
value:
$ref: '#/components/schemas/Money'
expirationDate:
type: string
description: 'The date on which an option, right or warrant expires.
Note: The expiration date field is only applicable to options and employee stock options.
Applicable containers: investment
'
readOnly: true
interestRate:
type: number
description: 'The interest rate on a CD.
Note: The interest rate field is only applicable to CD.
Applicable containers: investment
'
format: double
readOnly: true
quantity:
type: number
description: 'The quantity held for the holding.
Note: Only for bonds the quantity field indicates the normalized quantity and not the quantity aggregated from the site. The quantity field is only applicable to restricted stock units/awards, performance units, currency, and commodity.
For insurance container, the field is only applicable for insurance annuity and variable life insurance types.
Applicable containers: investment, insurance
'
format: double
readOnly: true
isManual:
type: boolean
description: Indicates if a holding is aggregated from a site or it is a manual holding i.e. holding information manually provided by the user.
readOnly: true
accruedInterest:
$ref: '#/components/schemas/Money'
grantDate:
type: string
description: 'The date on which equity awards like ESOP, RSU, etc., are issued or granted.
Note: The grant date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.
Applicable containers: investment
'
readOnly: true
sedol:
type: string
description: 'The SEDOL (Stock Exchange Daily Official List) is a set of security identifiers used in the United Kingdom and Ireland for clearing purposes.
Note: The SEDOL field is only applicable to the trade related transactions
Applicable containers: investment
'
readOnly: true
vestedSharesExercisable:
type: number
description: 'The number of vested shares that can be exercised by the employee. It is usually equal to the vested quantity.
Note: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.
Applicable containers: investment
'
format: double
readOnly: true
spread:
$ref: '#/components/schemas/Money'
accountId:
type: integer
description: 'Unique identifier of the account to which the security is linked.
Applicable containers: investment, insurance
'
format: int64
readOnly: true
enrichedDescription:
type: string
description: 'The enrichedDescription is the security description of the normalized holding
Applicable containers: investment, insurance
'
readOnly: true
couponRate:
type: number
description: 'The stated interest rate for a bond.
Applicable containers: investment
'
format: double
readOnly: true
createdDate:
type: string
description: 'The date on which the holding is created in the Yodlee system.
Applicable containers: investment, insurance
'
readOnly: true
accruedIncome:
$ref: '#/components/schemas/Money'
securityType:
type: string
description: 'Indicates the security type of holding identified through the security service.
Applicable containers: investment, insurance
'
readOnly: true
providerAccountId:
type: integer
description: 'Unique identifier for the user''s association with the provider.
Applicable containers: investment, insurance
'
format: int64
readOnly: true
unvestedQuantity:
type: number
description: 'Indicates the number of unvested quantity or units.
Note: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.
Applicable containers: investment
'
format: double
readOnly: true
costBasis:
$ref: '#/components/schemas/Money'
vestingDate:
type: string
description: 'The date on which a RSU, RSA, or an employee stock options become vested.
Note: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.
Applicable containers: investment
'
readOnly: true
isin:
type: string
description: 'The ISIN (International Securities Identification Number) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets.
Note: The ISIN field is only applicable to the trade related transactions
Applicable containers: investment
'
readOnly: true
strikePrice:
$ref: '#/components/schemas/Money'
CreditAcceleratorAccountVerification:
title: CreditAcceleratorAccountVerification
type: object
properties:
reason:
type: string
description: Additional status for account verification failure.
readOnly: true
fullAccountNumber:
type: string
description: 'Full account number of the account. For student loan account the account number that will be used for ACH or fund transfer.
Applicable containers: bank, investment, loan'
readOnly: true
balance:
$ref: '#/components/schemas/Money'
verificationStatus:
type: string
description: 'The status of the account verification.
Applicable Values:
* SUCCESS:
Description: The consumer''''s account verification is successful.
* FAILED:
Description: The consumer''''s account verification failed.'
readOnly: true
accountType:
type: string
description: 'The type of account that is aggregated, i.e., savings, checking, credit card, charge, HELOC, etc. The account type is derived based on the attributes of the account.
Valid Values:
Aggregated Account Type
bank- CHECKING
- SAVINGS
- CD
- PPF
- RECURRING_DEPOSIT
- FSA
- MONEY_MARKET
- IRA
- PREPAID
creditCard- OTHER
- CREDIT
- STORE
- CHARGE
- OTHER
investment (SN 1.0)- BROKERAGE_MARGIN
- HSA
- IRA
- BROKERAGE_CASH
- 401K
- 403B
- TRUST
- ANNUITY
- SIMPLE
- CUSTODIAL
- BROKERAGE_CASH_OPTION
- BROKERAGE_MARGIN_OPTION
- INDIVIDUAL
- CORPORATE
- JTTIC
- JTWROS
- COMMUNITY_PROPERTY
- JOINT_BY_ENTIRETY
- CONSERVATORSHIP
- ROTH
- ROTH_CONVERSION
- ROLLOVER
- EDUCATIONAL
- 529_PLAN
- 457_DEFERRED_COMPENSATION
- 401A
- PSP
- MPP
- STOCK_BASKET
- LIVING_TRUST
- REVOCABLE_TRUST
- IRREVOCABLE_TRUST
- CHARITABLE_REMAINDER
- CHARITABLE_LEAD
- CHARITABLE_GIFT_ACCOUNT
- SEP
- UTMA
- UGMA
- ESOPP
- ADMINISTRATOR
- EXECUTOR
- PARTNERSHIP
- SOLE_PROPRIETORSHIP
- CHURCH
- INVESTMENT_CLUB
- RESTRICTED_STOCK_AWARD
- CMA
- EMPLOYEE_STOCK_PURCHASE_PLAN
- PERFORMANCE_PLAN
- BROKERAGE_LINK_ACCOUNT
- MONEY_MARKET
- SUPER_ANNUATION
- REGISTERED_RETIREMENT_SAVINGS_PLAN
- SPOUSAL_RETIREMENT_SAVINGS_PLAN
- DEFERRED_PROFIT_SHARING_PLAN
- NON_REGISTERED_SAVINGS_PLAN
- REGISTERED_EDUCATION_SAVINGS_PLAN
- GROUP_RETIREMENT_SAVINGS_PLAN
- LOCKED_IN_RETIREMENT_SAVINGS_PLAN
- RESTRICTED_LOCKED_IN_SAVINGS_PLAN
- LOCKED_IN_RETIREMENT_ACCOUNT
- REGISTERED_PENSION_PLAN
- TAX_FREE_SAVINGS_ACCOUNT
- LIFE_INCOME_FUND
- REGISTERED_RETIREMENT_INCOME_FUND
- SPOUSAL_RETIREMENT_INCOME_FUND
- LOCKED_IN_REGISTERED_INVESTMENT_FUND
- PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND
- GUARANTEED_INVESTMENT_CERTIFICATES
- REGISTERED_DISABILITY_SAVINGS_PLAN
- DIGITAL_WALLET
- OTHER
investment (SN 2.0)- BROKERAGE_CASH
- BROKERAGE_MARGIN
- INDIVIDUAL_RETIREMENT_ACCOUNT_IRA
- EMPLOYEE_RETIREMENT_ACCOUNT_401K
- EMPLOYEE_RETIREMENT_SAVINGS_PLAN_403B
- TRUST
- ANNUITY
- SIMPLE_IRA
- CUSTODIAL_ACCOUNT
- BROKERAGE_CASH_OPTION
- BROKERAGE_MARGIN_OPTION
- INDIVIDUAL
- CORPORATE_INVESTMENT_ACCOUNT
- JOINT_TENANTS_TENANCY_IN_COMMON_JTIC
- JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP_JTWROS
- JOINT_TENANTS_COMMUNITY_PROPERTY
- JOINT_TENANTS_TENANTS_BY_ENTIRETY
- CONSERVATOR
- ROTH_IRA
- ROTH_CONVERSION
- ROLLOVER_IRA
- EDUCATIONAL
- EDUCATIONAL_SAVINGS_PLAN_529
- DEFERRED_COMPENSATION_PLAN_457
- MONEY_PURCHASE_RETIREMENT_PLAN_401A
- PROFIT_SHARING_PLAN
- MONEY_PURCHASE_PLAN
- STOCK_BASKET_ACCOUNT
- LIVING_TRUST
- REVOCABLE_TRUST
- IRREVOCABLE_TRUST
- CHARITABLE_REMAINDER_TRUST
- CHARITABLE_LEAD_TRUST
- CHARITABLE_GIFT_ACCOUNT
- SEP_IRA
- UNIFORM_TRANSFER_TO_MINORS_ACT_UTMA
- UNIFORM_GIFT_TO_MINORS_ACT_UGMA
- EMPLOYEE_STOCK_OWNERSHIP_PLAN_ESOP
- ADMINISTRATOR
- EXECUTOR
- PARTNERSHIP
- PROPRIETORSHIP
- CHURCH_ACCOUNT
- INVESTMENT_CLUB
- RESTRICTED_STOCK_AWARD
- CASH_MANAGEMENT_ACCOUNT
- EMPLOYEE_STOCK_PURCHASE_PLAN_ESPP
- PERFORMANCE_PLAN
- BROKERAGE_LINK_ACCOUNT
- MONEY_MARKET_ACCOUNT
- SUPERANNUATION
- REGISTERED_RETIREMENT_SAVINGS_PLAN_RRSP
- SPOUSAL_RETIREMENT_SAVINGS_PLAN_SRSP
- DEFERRED_PROFIT_SHARING_PLAN_DPSP
- NON_REGISTERED_SAVINGS_PLAN_NRSP
- REGISTERED_EDUCATION_SAVINGS_PLAN_RESP
- GROUP_RETIREMENT_SAVINGS_PLAN_GRSP
- LOCKED_IN_RETIREMENT_SAVINGS_PLAN_LRSP
- RESTRICTED_LOCKED_IN_SAVINGS_PLAN_RLSP
- LOCKED_IN_RETIREMENT_ACCOUNT_LIRA
- REGISTERED_PENSION_PLAN_RPP
- TAX_FREE_SAVINGS_ACCOUNT_TFSA
- LIFE_INCOME_FUND_LIF
- REGISTERED_RETIREMENT_INCOME_FUND_RIF
- SPOUSAL_RETIREMENT_INCOME_FUND_SRIF
- LOCKED_IN_REGISTERED_INVESTMENT_FUND_LRIF
- PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND_PRIF
- GUARANTEED_INVESTMENT_CERTIFICATES_GIC
- REGISTERED_DISABILITY_SAVINGS_PLAN_RDSP
- DEFINED_CONTRIBUTION_PLAN
- DEFINED_BENEFIT_PLAN
- EMPLOYEE_STOCK_OPTION_PLAN
- NONQUALIFIED_DEFERRED_COMPENSATION_PLAN_409A
- KEOGH_PLAN
- EMPLOYEE_RETIREMENT_ACCOUNT_ROTH_401K
- DEFERRED_CONTINGENT_CAPITAL_PLAN_DCCP
- EMPLOYEE_BENEFIT_PLAN
- EMPLOYEE_SAVINGS_PLAN
- HEALTH_SAVINGS_ACCOUNT_HSA
- COVERDELL_EDUCATION_SAVINGS_ACCOUNT_ESA
- TESTAMENTARY_TRUST
- ESTATE
- GRANTOR_RETAINED_ANNUITY_TRUST_GRAT
- ADVISORY_ACCOUNT
- NON_PROFIT_ORGANIZATION_501C
- HEALTH_REIMBURSEMENT_ARRANGEMENT_HRA
- INDIVIDUAL_SAVINGS_ACCOUNT_ISA
- CASH_ISA
- STOCKS_AND_SHARES_ISA
- INNOVATIVE_FINANCE_ISA
- JUNIOR_ISA
- EMPLOYEES_PROVIDENT_FUND_ORGANIZATION_EPFO
- PUBLIC_PROVIDENT_FUND_PPF
- EMPLOYEES_PENSION_SCHEME_EPS
- NATIONAL_PENSION_SYSTEM_NPS
- INDEXED_ANNUITY
- ANNUITIZED_ANNUITY
- VARIABLE_ANNUITY
- ROTH_403B
- SPOUSAL_IRA
- SPOUSAL_ROTH_IRA
- SARSEP_IRA
- SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP
- OFFSHORE_TRUST
- IRREVOCABLE_LIFE_INSURANCE_TRUST
- INTERNATIONAL_TRUST
- LIFE_INTEREST_TRUST
- EMPLOYEE_BENEFIT_TRUST
- PRECIOUS_METAL_ACCOUNT
- INVESTMENT_LOAN_ACCOUNT
- GRANTOR_RETAINED_INCOME_TRUST
- PENSION_PLAN
- DIGITAL_WALLET
- OTHER
loan- MORTGAGE
- INSTALLMENT_LOAN
- PERSONAL_LOAN
- HOME_EQUITY_LINE_OF_CREDIT
- LINE_OF_CREDIT
- AUTO_LOAN
- STUDENT_LOAN
- HOME_LOAN
insurance- AUTO_INSURANCE
- HEALTH_INSURANCE
- HOME_INSURANCE
- LIFE_INSURANCE
- ANNUITY
- TRAVEL_INSURANCE
- INSURANCE
realEstaterewardManual Account Type
bankcreditloaninsuranceinvestment
Applicable containers: bank
Associated Accounts
Endpoints:- GET Associated Accounts/{providerAccountId}
'
readOnly: true
holder:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorHolder'
verificationType:
type: string
description: The account verification type.
Applicable Values:
* MATCHING
readOnly: true
bankTransferCode:
type: array
description: 'Bank and branch identification information.
Applicable containers: bank, investment, loan'
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorBankTransferCode'
CreditAcceleratorBalanceOccurrence:
title: CreditAcceleratorBalanceOccurrence
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorOccurence'
currency:
type: string
CreditAcceleratorDailySummary:
title: CreditAcceleratorDailySummary
type: object
properties:
avg:
type: number
description: Average amount for the time period (sum divided by count).
format: double
readOnly: true
min:
$ref: '#/components/schemas/CreditAcceleratorBalance'
max:
$ref: '#/components/schemas/CreditAcceleratorBalance'
count:
type: number
description: Number of data points available in the time period.
format: double
readOnly: true
timePeriod:
type: string
description: Time intervals to consider up to the number of days the application was requested.
readOnly: true
sum:
type: number
description: Total amount for the time period.
format: double
readOnly: true
CreditAcceleratorOccurence:
title: CreditAcceleratorOccurence
type: object
properties:
count:
type: number
description: Number of times the event has occurred within the given time period.
format: double
readOnly: true
timePeriod:
type: string
description: Time intervals to consider up to the number of days the application was requested.
readOnly: true
RewardBalance:
title: RewardBalance
type: object
properties:
expiryDate:
type: string
description: 'The date on which the balance expires.
Account Type: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
balanceToReward:
type: string
description: 'The balance required to qualify for a reward such as retaining membership, business reward, etc.
Account Type: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
balanceType:
type: string
description: 'The type of reward balance.
Account Type: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
Applicable Values
'
readOnly: true
enum:
- EXPIRING_BALANCE
- BALANCE_TO_LEVEL
- BALANCE_TO_REWARD
- BALANCE
- TOTAL_BALANCE
balance:
type: number
description: 'The actual reward balance.
Account Type: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
format: double
readOnly: true
description:
type: string
description: 'The description for the reward balance as available at provider source.
Account Type: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
balanceToLevel:
type: string
description: 'The balance required to reach a reward level.
Account Type: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
units:
type: string
description: 'Unit of reward balance - miles, points, segments, dollars, credits.
Account Type: Aggregated
Applicable containers: reward
Endpoints:- GET accounts
- GET accounts/{accountId}
- GET dataExtracts/userData
'
readOnly: true
AutoRefresh:
title: AutoRefresh
type: object
properties:
additionalStatus:
type: string
description: Indicates the reason for the status.
Endpoints:- GET accounts
- GET accounts/{accountId}
Applicable Values
readOnly: true
enum:
- SCHEDULED
- TEMP_ERROR
- SITE_BLOCKING
- SITE_NOT_SUPPORTED
- REAL_TIME_MFA_REQUIRED
- USER_ACTION_REQUIRED
- UNSUBSCRIBED
- MANUAL_ACCOUNT
asOfDate:
type: string
description: Date on which the auto refresh status is determined.
Endpoints:- GET accounts
- GET accounts/{accountId}
readOnly: true
status:
type: string
description: Indicates whether auto refresh is enabled or disabled.
Endpoints:- GET accounts
- GET accounts/{accountId}
Applicable Values
readOnly: true
enum:
- ENABLED
- DISABLED
CreditAcceleratorStatusResponse:
title: CreditAcceleratorStatusResponse
type: object
properties:
configName:
type: string
description: The config name using which the credit accelerator file generation was requested
readOnly: true
reportId:
type: integer
description: Unique identifier for the credit accelerator file
format: int64
readOnly: true
selectedAccounts:
type: array
description: Accounts which were selected for credit accelerator file generation.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorSelectedAccount'
submissionDate:
type: string
description: Date on which the request to generate credit accelerator file was submitted
readOnly: true
originalReportId:
type: integer
description: Report id of original report on which refresh is performed. This is not available when report is generated for the first time.
format: int64
readOnly: true
status:
type: string
description: Generation status of the requested credit accelerator file requested
readOnly: true
enum:
- SUBMITTED
- IN_PROGRESS
- COMPLETED
- FAILED
CreditAcceleratorAllAccountExpense:
title: CreditAcceleratorAllAccountExpense
type: object
properties:
cashTxnSummary:
type: array
description: Sum, count and average of cash withdrawal transactions, grouped by currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
entertainmentTxnSummary:
type: array
description: Sum, count and average of restaurant/travel/entertainment transactions, grouped by currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
taxesTxnSummary:
type: array
description: Sum, count, average and list of taxes expense transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
telecomTxnSummary:
type: array
description: Sum, count, average and list of telecom expense transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
cashflow:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountCashFlow'
insuranceTxnSummary:
type: array
description: Sum, count, average and list of insurance expense transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
charityTxnSummary:
type: array
description: Sum, count and average of charitable giving transactions, grouped by currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
ccardTxnSummary:
type: array
description: Sum, count and average of credit card payment transactions, grouped by currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
rentTxnSummary:
type: array
description: Sum, count, average and list of rent expense transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
utilitiesTxnSummary:
type: array
description: Sum, count, average and list of utilities expense transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
educationTxnSummary:
type: array
description: Sum, count, average and list of education expense transactions.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
loanTxnSummary:
type: array
description: Sum, count and average of loan repayment transactions, grouped by currency.
readOnly: true
items:
$ref: '#/components/schemas/CreditAcceleratorAllAccountBalanceSummary'
CreditAcceleratorAllAccountAnalysis:
title: CreditAcceleratorAllAccountAnalysis
type: object
properties:
income:
$ref: '#/components/schemas/CreditAcceleratorAllAccountIncome'
asset:
$ref: '#/components/schemas/CreditAcceleratorAllAccountAsset'
expense:
$ref: '#/components/schemas/CreditAcceleratorAllAccountExpense'
Email:
title: Email
type: object
properties:
type:
type: string
readOnly: true
enum:
- PRIMARY
- SECONDARY
- PERSONAL
- WORK
- OTHERS
value:
type: string
readOnly: true
CoverageAmount:
title: CoverageAmount
type: object
properties:
cover:
$ref: '#/components/schemas/Money'
unitType:
type: string
description: 'The type of coverage unit indicates if the coverage is for an individual or a family.
Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoints:- GET accounts
- GET accounts/{accountId}
Applicable Values:
'
readOnly: true
enum:
- PER_FAMILY
- PER_MEMBER
type:
type: string
description: 'The type of coverage provided to an individual or an entity.
Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoints:- GET accounts
- GET accounts/{accountId}
Applicable Values:
'
readOnly: true
enum:
- DEDUCTIBLE
- OUT_OF_POCKET
- ANNUAL_BENEFIT
- MAX_BENEFIT
- COVERAGE_AMOUNT
- MONTHLY_BENEFIT
- OTHER
limitType:
type: string
description: 'The type of coverage limit indicates if the coverage is in-network or out-of-network.
Aggregated / Manual: Aggregated
Applicable containers: insurance,investment
Endpoints:- GET accounts
- GET accounts/{accountId}
Applicable Values:
'
readOnly: true
enum:
- IN_NETWORK
- OUT_NETWORK
met:
$ref: '#/components/schemas/Money'
CreditAcceleratorDailyBalance:
title: CreditAcceleratorDailyBalance
type: object
properties:
date:
type: string
description: Daily balance date
readOnly: true
amount:
type: number
description: Daily balance amount
format: double
readOnly: true
currency:
type: string
description: Currency which the amount is in.
readOnly: true
CreditAcceleratorAccountExpense:
title: CreditAcceleratorAccountExpense
type: object
properties:
cashTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
entertainmentTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
taxesTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
telecomTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
cashflow:
$ref: '#/components/schemas/CreditAcceleratorCashFlow'
insuranceTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
charityTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
ccardTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
rentTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
utilitiesTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
educationTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
loanTxnSummary:
$ref: '#/components/schemas/CreditAcceleratorBalanceSummary'
CreditAcceleratorSummary:
title: CreditAcceleratorSummary
type: object
properties:
avg:
type: number
description: Average amount for the time period (sum divided by count).
format: double
readOnly: true
count:
type: number
description: Number of data points available in the time period.
format: double
readOnly: true
timePeriod:
type: string
description: Time intervals to consider up to the number of days the application was requested.
readOnly: true
sum:
type: number
description: Total amount for the time period.
format: double
readOnly: true
CreditAcceleratorPaymentProfile:
title: CreditAcceleratorPaymentProfile
type: object
properties:
identifier:
$ref: '#/components/schemas/PaymentIdentifier'
address:
type: array
description: 'The address of the lender to which the monthly payments or the loan payoff amount should be paid.
Additional Details:The address field applies only to the student loan account type.
Account Type: Aggregated
Applicable containers: loan
Endpoints:
- GET accounts
- GET accounts/{accountId}
'
items:
$ref: '#/components/schemas/CreditAcceleratorAccountAddress'
paymentBankTransferCode:
type: array
description: 'The additional information for payment bank transfer code.
Applicable containers: loan
Endpoints:- GET accounts
- GET accounts/{accountId}
'
items:
$ref: '#/components/schemas/CreditAcceleratorPaymentBankTransferCode'
CreditAcceleratorDailyBalanceAnalysis:
title: CreditAcceleratorDailyBalanceAnalysis
type: object
properties:
values:
type: array
items:
$ref: '#/components/schemas/CreditAcceleratorBalanceAnalysis'
currency:
type: string
CreditAcceleratorHolder:
title: CreditAcceleratorHolder
type: object
properties:
ownership:
type: string
description: Indicates the ownership of the account.
readOnly: true
name:
$ref: '#/components/schemas/Name'