You can find information about a user's finances through their accounts. We currently support four account types:

  • TRANSACTION: A transaction account is a checking account or current account. It is an account commonly used for everyday transactions. Can earn little or no interest. Also, could be linked to a short term lending product (such as an overdraft).
  • SAVINGS: An account that accrues interest at an agreed rate and interval. Can have restrictions around withdrawal of funds.
  • BUSINESS_TRANSACTION: A transaction account for a business
  • BUSINESS_SAVINGS: A savings account for a business

Account model

All account types include the following properties:

AttributeTypeRequiredDescription
account_idstringUnique identifier of the account
account_typestringType of the account
account_number.ibanstringOPTIONAL (not returned by internal savings accounts on credential sharing)ISO 13616-1:2007 international bank number
account_number.numberstringOPTIONAL (only returned for UK accounts)Bank account number
account_number.sort_codestringOPTIONAL (only returned for UK accounts)United Kingdom SORT code
account_number.swift_bicstringISO 9362:2009 Business Identifier Codes
account_number.routing_numberstringOPTIONAL (only returned for US-based accounts)Routing transit number
currencystringISO 4217 alpha-3 currency code of the account
display_namestringHuman-readable name of the account
update_timestampdatetimeLast update time of the account information
provider.display_namestringDeprecatedDisplay name for the provider
provider.logo_uristringDeprecatedURI for the provider logo
provider.provider_idstringUnique identifier for the provider

Did this page help you?