Account data reference
The four types of account we return, and all possible attributes of an account.
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
Account types can include the following properties:
| Attribute | Type | Always returned? | Description |
|---|---|---|---|
account_id | string | Yes | Unique identifier of the account |
account_type | string | Yes | Type of the account |
account_number.iban | string | Returned by internal savings accounts on credential sharing | ISO 13616-1:2007 international bank number |
account_number.number | string | Returned for UK accounts | Bank account number |
account_number.sort_code | string | Returned for UK accounts | United Kingdom SORT code |
account_number.swift_bic | string | Yes | ISO 9362:2009 Business Identifier Codes |
account_number.routing_number | string | Returned for US-based accounts | Routing transit number |
currency | string | Yes | ISO 4217 alpha-3 currency code of the account |
display_name | string | Yes | Human-readable name of the account |
update_timestamp | datetime | Yes | Last update time of the account information |
provider.display_name | string | Deprecated | Display name for the provider |
provider.logo_uri | string | Deprecated | URI for the provider logo |
provider.provider_id | string | Yes | Unique identifier for the provider |
Updated about 1 year ago