logo

Data Dictionary

Data Dictionary

Account Types

Account types describe various attributes related to an account’s holdings, transactions, and tax eligibility. These types are a subset of account categories and have a one to many relationship with a category. In cases where a given account does not have a strong type match, it will have a type of “Unknown”.
TypeCategoryTaxable
401aInvestmentfalse
401kInvestmentfalse
403bInvestmentfalse
457bInvestmentfalse
529Investmentfalse
AlternativeOthertrue
AnnuityInsurancefalse
Auto LoanLoanfalse
Brokerage AccountInvestmenttrue
Certificate of DepositBankingtrue
CheckingBankingtrue
Credit CardBankingtrue
Education Savings AccountInvestmentfalse
Fixed AnnuityInsurancefalse
Health Reimbursement ArrangementInvestmentfalse
Health Savings AccountInvestmentfalse
HELOCLoanfalse
InsuranceInsurancefalse
IRAInvestmentfalse
Limited PartnershipOthertrue
LoanLoanfalse
MiscOthertrue
Misc BankingBankingfalse
MortgageLoanfalse
Non-Taxable Brokerage AccountInvestmentfalse
PensionInvestmenttrue
Profit Sharing PlanInvestmentfalse
Real EstateOthertrue
Roth 401kInvestmentfalse
Roth IRAInvestmentfalse
SavingsBankingtrue
SEP IRAInvestmentfalse
Simple IRAInvestmentfalse
Stock PlanInvestmentfalse
Student LoanLoanfalse
Term Life InsuranceInsurancefalse
Thrift Savings PlanInvestmentfalse
UGMAInvestmentfalse
Universal Life InsuranceInsurancefalse
UnknownUnknownfalse
UTMAInvestmentfalse
Variable AnnuityInvestmenttrue
Variable Life InsuranceInsurancefalse
Whole Life InsuranceInsurancefalse

International Account Types

There are additional account types that only apply to accounts outside of the US (denoted by the   country_code   field in the /institutions endpoint). Accounts on international institutions may have any of the following account types (in addition to the types listed above):
TypeDescriptionCategoryTaxableCountry
LIFLife Income FundInvestmentfalseCAN
LIRALocked-In Retirement AccountInvestmentfalseCAN
LRIFLocked-In Retirement Income FundInvestmentfalseCAN
LRSPLocked-In Retirement Savings AccountInvestmentfalseCAN
PRIFPrescribed Registered Retirement Income FundInvestmentfalseCAN
RDSPRegistered Disability Savings PlanInvestmentfalseCAN
RESPRegistered Education Savings PlanInvestmentfalseCAN
RLIFRestricted Life Income FundInvestmentfalseCAN
RRIFRegistered Retirement Income FundInvestmentfalseCAN
RRSPRegistered Retirement Savings PlanInvestmentfalseCAN
TFSATax Free Savings AccountInvestmentfalseCAN
ISAIndividual Savings AccountInvestmentfalseGBR
Cash ISACash Individual Savings AccountInvestmentfalseGBR
SIPPSelf-Invested Personal PensionInvestmenttrueGBR

Holding Types

Holding Types define the nature of a holding within an account. This information is sometimes identical to the holding’s asset class, but not necessarily (e.g., for pooled vehicles such as ETFs and Mutual Funds).
  • Alternative
  • Annuity
  • Bond
  • Cash
  • Certificate of Deposit
  • Closed-End Fund
  • Currency
  • Derivative
  • ETF
  • ETN
  • Equity
  • Foreign Equity
  • Hedge Fund
  • Index
  • Insurance Policy
  • Loan
  • Loan Receivable
  • Money Market
  • Mutual Fund
  • Option
  • Other
  • Other Equity
  • Preferred Stock
  • Private Security
  • Right
  • Unit Trust
  • Unknown
  • Warrant

Basic Asset Classes

  • Equity
  • Fixed Income
  • Multi-Asset
  • Insurance
  • Derivative
  • Cash & Cash Equivalent
  • Currency
  • Commodities
  • Alternative
  • Other

Transaction Types

Within Quovo, transactions are categorized at a broad level into five different high level types. Quovo defines its transaction types by the algorithmic impact that the transaction has within calculations such as account performance or value over time.
CodeName
BBuy
CCash
IDividends/Interest/Fees
PPending
SSell
TTransfer
XCancel

Transaction Subtypes

Below is a list of all transaction subtypes: their code, full name, and the broader transaction type under which they fall.
SubtypeNameType
ACFEAccount FeeC, I
ADFEAdministrative FeeC, I, S
ADJUAdjustmentI
ALFEActuarial FeeC, I
APFEAppraisal FeeC, I
ASSNAssignmentB, T
BTCBuy to CloseB
BTCCBuy to Close CallB
BTCPBuy to Close PutB
BTOBuy to OpenB
BTOCBuy to Open CallB
BTOPBuy to Open PutB
BUYLBuy LongB
BUYSBuy ShortB
BUYXBuy ExchangeB
CTFEContract FeeC, I
CTRBContributionB, C, I
DEPODepositC
DPFCDividend Paid From CashI
DTRBDistributionS
DV2CDividendI
FNFEFund FeeS
FTAXForeign TaxC, I
FTXWForeign Tax WithheldC, I
IP2CInterestI
IPFCInterest Paid From CashI
IRECInterest ReceivableI
ISRVInterest ReinvestmentB
LG2CLong-term Capital Gain to CashI
LGFELegal FeeC, I
LGRVLong-term Capital Gain ReinvestmentB
LPMTLoan PaymentB, S
MCFEMiscellaneous FeeC, I, S
MERGMergeT
MEXPMargin ExpenseC, I
MGFEManagement FeeC, I
NQDVNon-qualified DividendI
NTAXNon-resident TaxC, I
PENCPending CreditP
PENDPending DebitP
QPCQuovo Phantom CancelX
QUDVQualified DividendI
REINDividend ReinvestmentB
RTOPReturn of PrincipalI
SASSSell AssignedS
SDTBStock DistributionI
SELLSellS
SELXSell ExchangeS
SG2CShort-term Capital Gain to CashI
SGRVShort-term Capital Gain ReinvestmentB
SPINSpin OffT
SPLTSplitT
STCSell to CloseS
STCCSell to Close CallS
STCPSell to Close PutS
STOSell to OpenS
STOCSell to Open CallS
STOPSell to Open PutS
STXWState Tax WithheldC, I
TAXWTax WithheldC, I
TDFETrading FeeC, I
TRFETransfer FeeC, I
TUFETrust FeeC, I
UG2CUnqualified Gain to CashI
WITHWithdrawalC
XFERTransferT
XPRDExpiredT
XRCSExercise (Option)S, T
 

Cashflow Categories and Subcategories

Cashflow categories are categorizations of cash transactions, generally occurring in bank and credit card accounts. Cashflow subcategories provide more granular detail on a specific transaction. Cashflow categories and subcategories can be useful for budgeting or expense tracking purposes.
Cashflow CategoryCashflow subcategory
Account FeesATM Fee
Commissions
Finance Charge
Late Fee
Overdraft Fee
Service Fee
Other Account Fee
Account TransferCredit Card
Emergency Savings
Investments
Retirement Contributions
Other Account Transfer
ATM/CashATM
Checks
Other ATM/Cash
AutomotiveAuto Payment
Auto Services
Gas
Parking
Tolls
Other Automotive
Bills/UtilitiesCable
Cell Phone
Electric Bill
Gas Bill
Internet
Landline
Water Bill
Other Bills/Utilities
Business Misc.Advertising
Office Supplies
Printing
Shipping
Other Business
Child/DependentsAllowance
Baby Supplies
Babysitter/Daycare
Child Support
Toys
Other Child/Dependents
EducationBooks/Supplies
Education Savings
Student Loan Payments
Tuition
Other Education
EntertainmentArts
Hobbies
Sports
Movies
Music
Subscriptions
Other Entertainment
Food and BeverageBars
Coffee Shops
Fast Food
Groceries
Restaurants
Other Food and Beverages
FashionClothing
Shoes
Other Fashion
General MerchandiseBooks
Drugstores
Electronics
Other General Merchandise
Gifts/DonationsCharitable Donations
Gifts
Other Gifts/Donations
Healthcare/MedicalDentist
Doctor
Eye Care
Healthcare Supplies
Other Healthcare/Medical
Home ImprovementHOA Fees
House Cleaning
House Furnishings
Landscape Services
Repairs/Maintenance
Other Home Improvement
InsuranceAuto Insurance
Health Insurance
Homeowners Insurance
Life Insurance
Other Insurance
LoansLoans
Miscellaneous ServicesAccounting/Legal Services
Other Services
MortgageMortgage
Other IncomeAlimony
Combat Pay
Court Awards/Damages
Disability Benefits
Dividend
Property
Retirement Income
Social Security Benefits
Unemployment Benefits
Other Income
Tax Return
Personal CareGym Membership
Hair/Beauty
Laundry/Drycleaning
Spa/Massage
Other Personal Care
Pets/Pet CarePet Goods
Pet Services
Other Pets/Pet Care
RentRent
Paychecks/SalaryBonus
Paycheck
TaxesFederal Tax
Local Tax
Payroll Tax
Property Tax
Sales Tax
State Tax
Other Taxes
TravelAir Travel
Hotel
Public Transportation
Rental Car/Taxi
Vacation
Other Travel
UncategorizedUncategorized
 

Connection Statuses

Connection syncs can end with a wide variety of final statuses. Below are the various status codes, their descriptions, and whether the status requires any action by the end user. Note: A connection’s current status is always the last updated status from a sync; it is only updated at the end of a sync attempt.
StatusDescriptionRequires User Action
goodThe connection was properly synced.false
incorrect_credentialsThe login credentials for the connection are incorrect.true
challengesThere are additional MFA challenges that need to be answered.true
user_configThe institution requires the end user to log into the connection and resolve an issue. These instructions are institution-specific, and can be found in config_instructions on a connection object.true
resyncThe connection needs to be resynced to complete the sync process, usually because a time-sensitive challenge has expired.true
postponedThe institution is inaccessible at the moment. Quovo will attempt another sync at the end of the day.false
maintenanceThere were Quovo-side issues while syncing the connection.false
no_accountsThere were no accounts found within the connection.false
institution_unavailableQuovo is temporarily unable to sync any connections at this institution.false
oauthThe first of two syncs required by the OAuth workflow has been completed, and the sync is awaiting user redirection to your URL in order to resync and resolve in an end status.true
(null value)The connection was created, but no sync attempt has been completed.false
 

Auth Deposit Statuses

NameDescription
deposit_failedThe microdeposits could not be sent properly. The error field in the Auth Deposit will contain an error code, better detailing why the transaction failed.
requestedThe microdeposits have not yet been sent through the ACH network.
submittedQuovo has sent the microdeposits through the ACH network. This does not necessarily mean the microdeposits have been successfully made. The attempted microdeposits may still encounter an error due to issues like incorrect routing or account numbers.
transferredQuovo believes the microdeposits have been successfully transferred to the target account, i.e. we have not received notice of any ACH-related errors.
verification_failedThe end user failed to manually verify the Auth Deposit amounts too many times or Quovo was unable to verify the deposits within a reasonable time frame.
verifiedThe Auth Deposits have been confirmed by either Quovo or the end user.
 

Auth Deposit Error Codes

IDDescription
invalid_account_numberThe account number is not recognized by the end institution. The Auth Deposit process should be reinitiated with a corrected bank account number.
invalid_bank_accountThe targeted bank account cannot complete ACH transfers at this time. This usually indicates the bank account is unsuitable for any incoming ACH transfers and cannot be used for Auth Deposit verification.
invalid_routing_numberThe routing number does not belong to a valid ACH-enabled institution. The Auth Deposit process should be reinitiated with a corrected routing number.
process_errorQuovo encountered an error attempting the ACH transfer. We will attempt to resolve the issue and automatically resend the microdeposits.

API Error Codes

Status CodeError Message
400'duplicate_request'
'duplicate_connection'
'duplicate_credentials'
'invalid_credentials'
'taken_email'
'taken_token_name'
'malformed_token'
'invalid_new_password'
'malformed_json'
'bad_request'
'invalid_parameter'
401'bad_credentials'
'unauthorized'
403'missing_credentials'
'forbidden'
'user_blocked'
'connection_limit_exceeded'
'user_limit_exceeded'
'invalid_request'
404'not_found'
'no_available_transactions'
405method_not_allowed
409'conflicting_sync'
'conflicting_auth'
429'sync_rate_limit_exceeded'
'resource_rate_limit_exceeded'
'rate_limit_exceeded'
500internal_error
503'service_unavailable'

Sync States

Sync states are the different steps that may happen during a sync, located in the   progress.state   field.
  • queued
  • authenticating
  • fetching_accounts
  • fetching_holdings
  • fetching_transactions
  • fetching_securities
  • loading_holdings
  • loading_transactions
  • loading_securities
  • analyzing

Test Institutions

There are several test institutions that can help you test your syncing workflows and treatment of account data. None of them require actual account credentials, so you can ensure your syncing process works correctly without using any personal information. Use the GET /v3/institutions/{institution_id} call to see a more in-depth description and instructions for each test institution. For example, Test Workflow (Challenges) can either sync successfully or create an additional MFA question depending on the answer to the first MFA question.
InstitutionNameDescription
19815Test Workflow (Good)Successfully syncs a connection with limited account, holdings, and transaction data. If you want the connection to return a status of incorrect_credentials on a subsequent sync, change the passcode to “gobad”.
19816Test Workflow (Incorrect Credentials)Returns a status of incorrect_credentials (i.e., the connection was given incorrect credentials). Use the passcode “qwerty” to successfully login on a subsequent sync.
19817Test Workflow (Challenges)Returns a status of challenges (i.e., the connection has additional MFA questions to answer). Use the answer “great” to the first MFA question to successfully login. Use the answer “bad” to receive another MFA question. For subsequent MFA questions, use the answer “cause” to successfully login.
19818Test Workflow (User Config)Returns a status of user_config (e.g., the connection requires the user to change a setting on the institution website). Any additional sync will login successfully.
19819Test Workflow (Postponed)Returns a status of postponed (e.g., the institution is down for maintenance). Any additional sync will login successfully.
19820Test Workflow (No accounts)Successfully syncs a connection with no accounts.
19822Test Workflow (Maintenance)Returns a status of maintenance (i.e., there were Quovo-side issues syncing the connection). Any additional sync will login successfully.
19875Test Workflow (Challenges - Real-time)Returns a connection that requires completing real-time MFA to successfully sync. It does not matter which option you choose for the “where should we send the pin” question. Use “1234” for the pin number during the real-time portion.
21030Test Workflow (Challenges - Multiple Choice)MFA Challenges on this institution have multiple-choice options, instead of a free-form input. Select the “42” option to successfully sync a connection.
21031Test Workflow (Challenges - HTML)MFA Challenges on this institution require displaying an element. Enter “red” to successfully sync.
21534Test Data - InvestmentSuccessfully syncs a connection with a randomly generated investment account containing around 7 holdings and 6 months of history. The data will be randomly generated with every subsequent sync.
21700Test Data - BankSuccessfully syncs a connection with a randomly generated bank account containing a cash balance and 2 months of history, with expense categories. The data will be randomly generated with every subsequent sync.
21711Test Workflow (Challenges - Captcha)This institution requires completing a CAPTCHA to successfully sync, which involves both displaying an and completing real-time MFA. The answer to the CAPTCHA question is “3U3NTSB5”.
21902Test Data - Credit CardSuccessfully syncs a connection with a randomly generated “Credit Card” account and associated /extras.
21989Test Workflow (Challenges - Multiple Challenges)Similar to “Test Workflow (Challenges)”, except this institution yields multiple MFA questions on the initial sync. Answer “great” to the “How are you?” question and “sunny” to the “How is the weather?” question to successfully login.
22167Test Data - Multiple AccountsSimilar to both “Test Data - Investment” and “Test Data - Bank”, except this institution returns a connection with multiple accounts of various account types. Possible account types include “401k”, “IRA”, “Brokerage Account”, “Checking”, “Savings”, “Mortgage”, and “Credit Card”. The number of accounts is randomly generated during the initial sync, and the transactions within each account are randomly generated on every subsequent sync.
22476Test Data - InsuranceSuccessfully syncs a connection with a randomly generated “Insurance” account and associated /extras.
22662Test Data - Student LoanSuccessfully syncs a connection with a randomly generated “Student Loan” account and associated /extras.
22420Test Workflow - (Auth Deposits)This institution takes you through the Auth Deposits workflow. The routing number for this institution is “306061549”.
23070Test Workflow - (OAuth)Mimics the syncing workflow for OAuth connections using Quovo mock URLs. This institution is hidden by default.