This is a preview version of the API intended for early testing and integration. Preview versions are not stable and may include breaking changes before general availability.
UK General Savings Account
A general savings account with flexible terms in the UK market.
Bank Identifier Code
Indicates if the account accepts incoming deposits (true = deposits allowed, false = deposits not permitted)
Indicates if the account allows outgoing withdrawals (true = withdrawals allowed, false = withdrawals not permitted)
Company where the financial product has been collected from. Example: uk-natwest.
Display name of the company for user-friendly presentation.
Current value of the account.
Regular deposit information
Indicates whether the user has exclusive ownership of the account. False if PoA exists.
Information about the owner of the financial product.
International Bank Account Number
Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., productNumber, accountNumber, or loanId) for that.
Interest information for the account.
Name of the financial product.
The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.
Date when the account was opened.
Transaction history for the last 12 months.
Type of the financial product.
GIA, STOCKS_AND_SHARES_ISA, CASH_ISA, LIFETIME_ISA, SELF_INVESTED_PERSONAL_PENSION, UK_OCCUPATIONAL_PENSION, UK_GENERAL_SAVINGS_ACCOUNT or UK_GENERAL_SAVINGS_ACCOUNT_FIXED_PERIOD.Withdrawal conditions and restrictions.
{ "bic": "NWBKGB2L", "canDeposit": true, "canWithdraw": true, "company": "uk-natwest", "companyDisplayName": "NatWest", "currentValue": { "amount": 8500, "currency": "GBP" }, "deposit": { "amount": { "amount": 250, "currency": "GBP" }, "frequency": "MONTHLY" }, "hasExclusiveOwnership": true, "holder": { "name": "John Smith" }, "iban": "GB29NWBK60161331926819", "id": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "interest": { "accruedInterest": { "amount": 21.25, "currency": "GBP" }, "effectiveRate": 0.0325, "payoutFrequency": "MONTHLY", "rate": 0.032, "rateConditionRanges": [ { "maxAmount": { "amount": 24999.99, "currency": "GBP" }, "minAmount": { "amount": 0, "currency": "GBP" }, "rate": 0.032 }, { "maxAmount": { "amount": -0.01, "currency": "GBP" }, "minAmount": { "amount": 25000, "currency": "GBP" }, "rate": 0.035 } ] }, "productName": "Flexible Saver", "productNumber": "12345678", "startDate": "2019-04-06", "transactions": [ { "amount": { "amount": 250, "currency": "GBP" }, "description": "Standing order", "settlementDate": "2026-01-01", "type": "DEPOSIT" } ], "type": "UK_GENERAL_SAVINGS_ACCOUNT", "withdrawalConditions": { "allowedWithdrawals": 3, "allowedWithdrawalsPeriod": { "periodLength": 1, "periodUnit": "MONTH" }, "amountLimit": { "amount": 5000, "currency": "GBP" }, "fee": { "amount": 0, "currency": "GBP" }, "waitingPeriod": { "periodLength": 1, "periodUnit": "DAY" } }}