Documentation
Documentation
https://developer.yodlee.com/resources/yodlee/yodlee-api-overview/docs/overview
GettingStarted
https://developer.yodlee.com/docs/getting-started
OpenAPI Specification
swagger: '2.0'
info:
license:
name: Yodlee Developer License
url: https://developer.yodlee.com/terms/condition#_Services_1
contact:
email: developer@yodlee.com
description: 'This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform APIs for many different programming languages. Yodlee API v1.1 - Overview</a>.<br><br>You will have to set the header before making the API call. The following headers apply to all the APIs:<ul><li>Authorization: This header holds the access token</li> <li> Api-Version: 1.1</li></ul><b>Note</b>: If there are any API-specific headers, they are mentioned explicitly in the respective API''s description.'
termsOfService: https://developer.yodlee.com/terms/condition
title: Yodlee Core APIs Account Token Verify Account API
version: 1.1.0
basePath: /
tags:
- name: Verify Account
description: Verify Account API
paths:
/verifyAccount/{providerAccountId}:
post:
summary: Verify Accounts Using Transactions
deprecated: false
produces:
- application/json;charset=UTF-8
description: The verify account service is used to verify the account's ownership by matching the transaction details with the accounts aggregated for the user.<br><ul><li>If a match is identified, the service returns details of all the accounts along with the matched transaction's details.<li>If no transaction match is found, an empty response will be returned.<li>A maximum of 5 transactionCriteria can be passed in a request.<li>The baseType, date, and amount parameters should mandatorily be passed.<li>The optional dateVariance parameter cannot be more than 7 days. For example, +7, -4, or +/-2.<li>Pass the container or accountId parameters for better performance.<li>This service supports the localization feature and accepts locale as a header parameter.</li></ul>
operationId: initiateAccountVerification
responses:
200:
schema:
$ref: '#/definitions/VerifyAccountResponse'
description: OK
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for container<br>Y800 : Invalid value for accountId<br>Y800 : Invalid value for amount<br>Y800 : Invalid value for dateVariance<br>Y801 : Invalid length for keyword<br>Y804 : Permitted values of dateVariance between 1 - 7<br>Y806 : Invalid input<br>Y807 : Resource not found<br>Y809 : Invalid date range<br>Y812 : Required field/value - transactionCriteria missing in the input<br>Y812 : Required field/value - amount missing in the transactionCriteria<br>Y812 : Required field/value - amount date in the transactionCriteria<br>Y812 : Required field/value - baseType missing in the transactionCriteria<br>Y823 : Transaction not applicable for container <br>Y824 : The maximum number of transactionCriteria permitted is 5<br>Y857 : Transactions are not refreshed in the past 24 hours<br>Y858 : Only active accounts can be verified<br>Y901 : Service not supported<br>'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: path
name: providerAccountId
description: providerAccountId
type: string
required: true
- schema:
$ref: '#/definitions/VerifyAccountRequest'
in: body
name: verificationParam
description: verificationParam
required: true
tags:
- Verify Account
consumes:
- application/json
definitions:
BusinessCategory:
type: object
title: BusinessCategory
properties:
categoryName:
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.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
categoryId:
format: int64
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.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
VerifyAccount:
type: object
title: VerifyAccount
properties:
transactionCriteria:
type: array
items:
$ref: '#/definitions/VerifyTransactionCriteria'
account:
type: array
items:
$ref: '#/definitions/VerifiedAccount'
VerifyAccountResponse:
type: object
title: VerifyAccountResponse
properties:
verifyAccount:
$ref: '#/definitions/VerifyAccount'
LogoURLs:
type: object
title: LogoURLs
properties:
type:
description: 'The merchant type of the logo url (SVG/PNG)<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: string
url:
description: 'The logo url of the merchant<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: string
Merchant:
type: object
title: Merchant
properties:
website:
description: 'The website of the merchant.<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: string
address:
description: 'The address of the merchant associated with the transaction is populated in the merchant address field.<br><b>Note</b>: The merchant address field is not available by default and customers will have to specifically request the merchant''s address (that includes city, state, and ZIP of the merchant). The merchant address field is available only for merchants in the United States.<br><br><b>Applicable containers</b>: bank,creditCard<br>'
readOnly: true
$ref: '#/definitions/AccountAddress'
logoURLs:
description: 'The logoURL of the merchant.<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: array
items:
$ref: '#/definitions/LogoURLs'
contact:
description: 'The merchant contact information like phone and email.<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
$ref: '#/definitions/Contact'
categoryLabel:
description: 'The business categories of the merchant.<br><br><b>Applicable containers</b>: bank,creditCard<br><b>Applicable Values</b><br>'
readOnly: true
type: array
items:
type: string
coordinates:
description: 'The merchant geolocation coordinates like latitude and longitude.<br><br><b>Applicable containers</b>: bank,creditCard,loan<br>'
$ref: '#/definitions/Coordinates'
name:
description: 'The name of the merchant.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
id:
description: 'Identifier of the merchant.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
source:
description: 'The source through which merchant information is retrieved.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- YODLEE
- FACTUAL
- FOURSQUARE
logoURL:
description: 'The logoURL of the merchant.<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: string
AccountAddress:
type: object
title: AccountAddress
properties:
zip:
description: Zip.
type: string
country:
description: Country.
type: string
address3:
description: Address Line 3.
type: string
address2:
description: Address Line 2.
type: string
city:
description: City.
type: string
sourceType:
type: string
address1:
description: Address Line 1.
type: string
street:
type: string
state:
description: State.
type: string
type:
type: string
enum:
- HOME
- BUSINESS
- POBOX
- RETAIL
- OFFICE
- SMALL_BUSINESS
- COMMUNICATION
- PERMANENT
- STATEMENT_ADDRESS
- PAYMENT
- PAYOFF
- UNKNOWN
Name:
type: object
title: Name
properties:
middle:
description: Middle name.
type: string
last:
description: Last name.
type: string
fullName:
description: Full name.
type: string
first:
description: First name.
type: string
Contact:
type: object
title: Contact
properties:
phone:
description: 'Phone number of the merchant<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
type: string
email:
description: 'Email Id of the merchant<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
type: string
Description:
type: object
title: Description
properties:
security:
description: 'The description will provide the actual name of the security.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
original:
description: 'Original transaction description as it appears at the FI site.<br><br><b>Applicable containers</b>: creditCard, insurance, loan<br>'
readOnly: true
type: string
simple:
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.<br><br><b>Applicable containers</b>: creditCard, insurance, loan<br>'
readOnly: true
type: string
consumer:
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.<br><br>
type: string
Coordinates:
type: object
title: Coordinates
properties:
latitude:
format: double
description: 'Latitude of the merchant<br><br><b>Applicable containers</b>: bank,creditCard,loan<br>'
type: number
longitude:
format: double
description: 'Longitude of the merchant<br><br><b>Applicable containers</b>: bank,creditCard,loan<br>'
type: number
Transaction:
type: object
title: Transaction
properties:
date:
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.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
sourceId:
description: A unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts.<br>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
type: string
symbol:
description: 'The symbol of the security being traded.<br><b>Note</b>: The settle date field applies only to trade-related transactions. <br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
cusipNumber:
description: 'The CUSIP (Committee on Uniform Securities Identification Procedures) identifies the financial instruments in the United States and Canada.<br><b><br><b>Note</b></b>: The CUSIP number field applies only to trade related transactions.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
sourceApcaNumber:
description: '6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable. This field will be primarily be available for AU Open Banking sites, and for other regions/providers, the population will depend on the availability of data.<br><br><b>Applicable containers</b>: Bank,Card container<br>'
readOnly: true
type: string
highLevelCategoryId:
format: int64
description: 'The high level category assigned to the transaction. The supported values are provided by the GET transactions/categories. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
memo:
description: 'Additional notes provided by the user for a particular transaction through application or API services. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
type:
description: 'The nature of the transaction, i.e., deposit, refund, payment, etc.<br><b>Note</b>: The transaction type field is available only for the United States, Canada, United Kingdom, New Zealand and India based provider sites. <br><br><b>Applicable containers</b>: bank,creditCard,investment<br>'
readOnly: true
type: string
intermediary:
description: 'The intermediary of the transaction.<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: array
items:
type: string
frequency:
description: 'Frequency is set to MONTHLY if the Merchant type is BILLERS or SUBSCRIPTION.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
lastUpdated:
readOnly: true
type: string
price:
description: 'The price of the security for the transaction.<br><b>Note</b>: The price field applies only to the trade related transactions. <br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
$ref: '#/definitions/Money'
sourceMerchantCategoryCode:
description: 'The merchant category code for an outgoing payment to a merchant. This field will be primarily be available for AU Open Banking sites, and for other regions/providers, the population will depend on the availability of data.<br><br><b>Applicable containers</b>: Bank,Card,Loan container<br>'
readOnly: true
type: string
id:
format: int64
description: 'An unique identifier for the transaction. The combination of the id and account container are unique in the system. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
checkNumber:
description: 'The checkNumber of the transaction.<br><br><b>Applicable containers</b>: bank<br>'
readOnly: true
type: string
typeAtSource:
description: 'The type of transaction. This field will be primarily be available for AU Open Banking sites, and for other regions/providers, the population will depend on the availability of data.<br><br><b>Applicable containers</b>: Bank,Card,Loan container<br>'
readOnly: true
type: string
valoren:
description: 'It is an identification number that is assigned to financial instruments such as stocks and bonds trading in Switzerland.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
isManual:
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. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: boolean
sourceBillerName:
description: 'Name of the BPAY biller for the transaction (if available). This field will be primarily be available for AU Open Banking sites, and for other regions/providers, the population will depend on the availability of data.<br><br><b>Applicable containers</b>: Bank,Card container<br>'
readOnly: true
type: string
merchant:
description: 'The name of the merchant associated with the transaction.<br><b>Note</b>: The merchant name field is available only in the United States, Canada, United Kingdom, and India.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
$ref: '#/definitions/Merchant'
sedol:
description: 'SEDOL stands for Stock Exchange Daily Official List, a list of security identifiers used in the United Kingdom and Ireland for clearing purposes.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
categoryType:
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.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
enum:
- TRANSFER
- DEFERRED_COMPENSATION
- UNCATEGORIZE
- INCOME
- EXPENSE
- LOAN
accountId:
format: int64
description: 'The account from which the transaction was made. This is basically the primary key of the account resource. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
sourceType:
description: 'The source through which the transaction is added to the Yodlee system.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loann<br><b>Applicable Values:</b><br>'
readOnly: true
type: string
enum:
- AGGREGATED
- MANUAL
subType:
description: 'The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.<br><b>Note</b>: The transaction subtype field is available only in the United States, Canada, United Kingdom, New Zealand and India.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
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
holdingDescription:
description: 'For transactions involving securities, this captures the securities description.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
status:
description: 'The status of the transaction: pending or posted.<br><b>Note</b>: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- POSTED
- PENDING
- SCHEDULED
- FAILED
- CLEARED
detailCategoryId:
format: int64
description: 'The id of the detail category that is assigned to the transaction. This is a premium attribute which will be returned in the response only if the Detail Category feature is enabled. The supported values are provided by GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard<br>'
readOnly: true
type: integer
description:
description: 'Description details<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
$ref: '#/definitions/Description'
settleDate:
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.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
baseType:
description: 'Indicates if the transaction appears as a debit or a credit transaction in the account. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- CREDIT
- DEBIT
categorySource:
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.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- SYSTEM
- USER
principal:
description: 'The portion of the principal in the transaction amount. The transaction amount can be the amount due, payment amount, minimum amount, repayment, etc.<br><br><b>Applicable containers</b>: loan<br>'
readOnly: true
$ref: '#/definitions/Money'
sourceBillerCode:
description: 'BPAY Biller Code for the transaction (if available). This field will be primarily be available for AU Open Banking sites, and for other regions/providers, the population will depend on the availability of data.<br><br><b>Applicable containers</b>: Bank,Card container<br>'
readOnly: true
type: string
interest:
description: 'The portion of interest in the transaction amount. The transaction amount can be the amount due, payment amount, minimum amount, repayment, etc.<br><br><b>Applicable containers</b>: loan<br>'
readOnly: true
$ref: '#/definitions/Money'
commission:
description: 'A commission or brokerage associated with a transaction.<br><br><br><b>Additional Details</b>:The commission only applies to trade-related transactions.<b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
$ref: '#/definitions/Money'
merchantType:
description: 'Indicates the merchantType of the transaction.e.g:-BILLERS,SUBSCRIPTION,BNPL,OTHERS <br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: string
amount:
description: 'The amount of the transaction as it appears at the FI site. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
$ref: '#/definitions/Money'
isPhysical:
description: 'Indicates if the transaction is happened online or in-store. <br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: boolean
quantity:
format: double
description: 'The quantity associated with the transaction.<br><b>Note</b>: The quantity field applies only to trade-related transactions.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: number
isRecurring:
description: 'If the transaction is done on a merchant with merchant type as BILLERS/SUBSCRIPTION, then such transactions are marked isRecurring to True or else it is marked as False.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
transactionDate:
description: 'The date the transaction happens in the account. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
createdDate:
readOnly: true
type: string
CONTAINER:
description: 'The account''s container.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- bank
- creditCard
- investment
- insurance
- loan
- reward
- bill
- realEstate
- otherAssets
- otherLiabilities
businessCategory:
description: 'business category details for the SMB customers.<br><br><b>Applicable containers</b>: Bank container<br>'
readOnly: true
$ref: '#/definitions/BusinessCategory'
postDate:
description: 'The date on which the transaction is posted to the account.<br><br><b>Applicable containers</b>: bank,creditCard,insurance,loan<br>'
readOnly: true
type: string
parentCategoryId:
format: int64
description: 'The parentCategoryId of the category assigned to the transaction.<br><b>Note</b>: This field will be provided in the response if the transaction is assigned to a user-created category. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
category:
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.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
runningBalance:
description: 'The running balance in an account indicates the balance of the account after every transaction.<br><br><b>Applicable containers</b>: bank,creditCard,investment<br>'
readOnly: true
$ref: '#/definitions/Money'
categoryId:
format: int64
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.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
isin:
description: 'International Securities Identification Number (ISIN) standard is used worldwide to identify specific securities.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
AccountHolder:
type: object
title: AccountHolder
properties:
identifier:
description: 'Identifiers of the account holder.<br><br><b>Aggregated / Manual</b>: Aggregated <br><b>Applicable containers</b>: bank<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>'
readOnly: true
type: array
items:
$ref: '#/definitions/Identifier'
gender:
description: 'Identifiers of the account holder.<br><br><b>Aggregated / Manual</b>: Aggregated <br><b>Applicable containers</b>: bank<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>'
readOnly: true
type: string
ownership:
description: 'Indicates the ownership of the account.<br><br><b>Aggregated / Manual</b>: Aggregated <br><b>Applicable containers</b>: bank<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- PRIMARY
- SECONDARY
- CUSTODIAN
- OTHERS
- POWER_OF_ATTORNEY
- TRUSTEE
- JOINT_OWNER
- BENEFICIARY
- AAS
- BUSINESS
- DBA
- TRUST
name:
description: 'Name of the account holder.<br><br><b>Aggregated / Manual</b>: Aggregated <br><b>Applicable containers</b>: bank<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>'
readOnly: true
$ref: '#/definitions/Name'
YodleeError:
type: object
title: YodleeError
properties:
errorMessage:
description: The descriptive message that explains the error scenario.
readOnly: true
type: string
errorCode:
description: The error code follows the format YNNN. The error codes do not change. New error codes may be added as we introduce new features and enhance functionalities.
readOnly: true
type: string
referenceCode:
description: Unique Yodlee identifier used to troubleshoot issues at Yodlee's end.
readOnly: true
type: string
VerifyAccountRequest:
type: object
title: VerifyAccountRequest
required:
- transactionCriteria
properties:
container:
type: string
enum:
- bank
- creditCard
- investment
- insurance
- loan
- reward
- bill
- realEstate
- otherAssets
- otherLiabilities
accountId:
format: int64
type: integer
transactionCriteria:
type: array
items:
$ref: '#/definitions/VerifyTransactionCriteria'
VerifiedAccount:
type: object
title: VerifiedAccount
properties:
fullAccountNumber:
type: string
accountType:
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. <br><b>Valid Values:</b><br><b>Aggregated Account Type</b><br><b>bank</b><ul><li>CHECKING</li><li>SAVINGS</li><li>CD</li><li>PPF</li><li>RECURRING_DEPOSIT</li><li>FSA</li><li>MONEY_MARKET</li><li>IRA</li><li>PREPAID</li></ul><b>creditCard</b><ul><li>OTHER</li><li>CREDIT</li><li>STORE</li><li>CHARGE</li><li>OTHER</li></ul><b>investment (SN 1.0)</b><ul><li>BROKERAGE_MARGIN</li><li>HSA</li><li>IRA</li><li>BROKERAGE_CASH</li><li>401K</li><li>403B</li><li>TRUST</li><li>ANNUITY</li><li>SIMPLE</li><li>CUSTODIAL</li><li>BROKERAGE_CASH_OPTION</li><li>BROKERAGE_MARGIN_OPTION</li><li>INDIVIDUAL</li><li>CORPORATE</li><li>JTTIC</li><li>JTWROS</li><li>COMMUNITY_PROPERTY</li><li>JOINT_BY_ENTIRETY</li><li>CONSERVATORSHIP</li><li>ROTH</li><li>ROTH_CONVERSION</li><li>ROLLOVER</li><li>EDUCATIONAL</li><li>529_PLAN</li><li>457_DEFERRED_COMPENSATION</li><li>401A</li><li>PSP</li><li>MPP</li><li>STOCK_BASKET</li><li>LIVING_TRUST</li><li>REVOCABLE_TRUST</li><li>IRREVOCABLE_TRUST</li><li>CHARITABLE_REMAINDER</li><li>CHARITABLE_LEAD</li><li>CHARITABLE_GIFT_ACCOUNT</li><li>SEP</li><li>UTMA</li><li>UGMA</li><li>ESOPP</li><li>ADMINISTRATOR</li><li>EXECUTOR</li><li>PARTNERSHIP</li><li>SOLE_PROPRIETORSHIP</li><li>CHURCH</li><li>INVESTMENT_CLUB</li><li>RESTRICTED_STOCK_AWARD</li><li>CMA</li><li>EMPLOYEE_STOCK_PURCHASE_PLAN</li><li>PERFORMANCE_PLAN</li><li>BROKERAGE_LINK_ACCOUNT</li><li>MONEY_MARKET</li><li>SUPER_ANNUATION</li><li>REGISTERED_RETIREMENT_SAVINGS_PLAN</li><li>SPOUSAL_RETIREMENT_SAVINGS_PLAN</li><li>DEFERRED_PROFIT_SHARING_PLAN</li><li>NON_REGISTERED_SAVINGS_PLAN</li><li>REGISTERED_EDUCATION_SAVIN
# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yodlee/refs/heads/main/openapi/yodlee-verify-account-api-openapi.yml