Frollo APIs are grouped into various features supported by the SaaS platform. Each one contains the APIs needed for that feature to function but may rely on other APIs for full functionality.
The Frollo APIs are also split into two sets of APIs; the Management API and the Client API.
The Management API is designed to be used in a machine to machine (M2M) context to allow management of users, accounts and transactions on the Frollo platform.
The Client API comprises of the user facing features such as fetching transactions or managing bills and is designed for a client app or website to use. The Client API can also be used in an M2M context with an API Key.
- Authentication - Login of the user and refreshing of access tokens to use the APIs
- User - Manages the user profile and creating user accounts (if supported)
- Aggregation - Everything to do with accounts and transactions is managed here including categorisation, tagging, merchants and linking accounts. Accounts can be aggregated from direct integration or aggregation partners
- Bills - Tracking and detection of bills from the user’s aggregated accounts
- Budget and Pay Day - Tracking of budgets against merchants, categories and buckets against a user’s pay cycle
- Reports - Reporting of spend (against budget if available) broken down into merchants, categories and buckets in various periods
- Goals - Savings and debt repayment goals with automatic tracking of payments
- Events - Triggering of events and sequences from user actions
- Messages - Nudges and other customisable messaging to inform the user and keep them on track
- Surveys - Questions and feedback from the user
The Client API is accessed from a user context and supports OAuth 2.0 based authentication.
Tha Management API is accessed from an application context and supports API Key based authentication. The Client API also can be accessed using the API Key.
See Authentication for more details.
User APIs provides endpoints to manage the user and user’s profile. The user profile can contain personal information about the user used to personalise the Frollo experience, for example providing location relevant recommendations and comparisons on spending.
The following are taken care of here:
- Creation, updating and mangement of users
- Fetching and updating the user profile - e.g. name, postcode etc
- Deleting the user from Frollo
The following are available depending on how authentication and users are configured for your tenant:
- Registering a user by email
- Changing the user’s password
- Reset password
See Client API > User for more details on Client APIs.
See Management API > User for more details on Management APIs.
The Devices APIs provide endpoints for managing a device associated with a user. This allows for a more tailored experience for the client the user is logged in from, e.g. configuring a timezone suitable for that device’s location.
The following actions are supported
- Updating the device information - e.g. timezone, device info
- Managing the compliance status of a device - e.g. flagging it is jailbroken
- Updating the push notification token
Aggregation manages the user’s financial and other accounts data. This gives an aggregate view of a user’s bank accounts, loans, credit information, loyalty, insurance and other data. Linking and customisation of this data is also managed here.
Aggregation is core to Frollo functionality and powers all other features through the use of the user’s financial data.
Account data can come from many different sources including:
- Aggregation partners
- Open banking
- Direct integrations
An institution is referred to as a Provider and the customer login or connection to that provider as a ProviderAccount. The actual account data is referred to as an Account as each provider account may have multiple accounts linked to it. An example would be:
- Provider: ANZ
- Provider Account: email@example.com
- Account: Bank Account
- Account: Savings Account
- Account: Credit Card
- Provider Account: firstname.lastname@example.org
Supported account types include:
- Bank Accounts
- Credit Cards
- Rewards and Loyalty
- Credit / Financial Scores
Transactions can support tagging for personalisation at a granular level or allow for spending breakdown to be mesaured at higher level through automatic categorisation and allocation to “buckets”. Buckets include income, living, lifestyle and savings. Naming of these buckets can be changed at the UI level and allocation between them can be determined by configuration of the host tenant. These are referred to as a
budget_category in the API.
The following features are part of aggregation:
- Linking accounts
- Account information and enrichment
- Transaction information and enrichment
- Segregating spend into “buckets”
- Categorisation and tagging of transactions
- Merchant information
- Searching of transactions
Note: Aggregation refers the the aggregated view of accounts seen within Frollo, wether this includes accounts from external aggregation partners will depend on how your tenant is configured.
See Client API > Aggregation for more details on Client APIs.
See Management API > Accounts for more details on Management APIs.
Consents allow the management of consent given by the user to access certain information. Consents represent the scope and timeframe a user has given for Frollo to access their data. In an Open Banking context this is handled under the Consumer Data Right (CDR) rules.
The following features are part of consents:
- Giving consent to access data
- Listing and managing existing consents
- Withdrawing and extending the period of consent
See Consents for more details
Bills allows users to manage bills and track payments against them. Bill detection is automatic and users can then confirm they wish to track payments against these bills or a user can add manual bills if needed.
The following features are part of bills:
- Bill detection
- Bill payment tracking
- Payment due reminders
- Payments forecasting
- Manual bills
See Bills for more details.
Budget and Pay Day
Budgets allow the user to setup a budget based on their own pay cycle or preferred period. Budgets can be setup to track spending against merchants, categories and buckets. Setting up budgets at the bucket level allows users to group spending together and easily track against proven budgeting methods (e.g. envelope or buckets).
The following features are part of budgets:
- Set multiple budgets with custom periods
- Set budgets by category, merchant, bucket and tags
See Budgets for more details.
Frollo can detect and monitor a user’s pay cycle. This allows the user to take actions or base their budgeting around their own pay days.
The following features are part of pay day:
- Confirm and set pay day and pay period
See PayDays for more details.
Reports give a breakdown of a user’s spending or an account balance history. Reports can be used to show the user spending in various periods or allow the user to drill down and explore their spend in a variety of ways. Reports data is also suitable for driving graphs.
Reports can be generated across different time periods and broken down into several different ways including by category, by merchant, by tag and by bucket.
The following features are part of reports:
- Account balance history
- Historical spend - breakdown the spend of a user for them to explore and find where money is going
See Reports for more details.
Goals help the user set savings or debt repayment goals and meet them. Goals allow the user to set a target amount and/or date and/or how much they can afford each month and their target date/repayment/total is calculated from this. Savings towards this goal are automatically tracked from deposits to an associated bank or savings account.
The following features are part of goals and challenges:
- Track a goal against a savings, loan or debt repayment target
- Track credits, debits or credits and debits towards a goal’s progress automatically
- Project goal progress and track if on course
- Save towards a date, amount or open-ended target
- See a breakdown of each period’s progress towards a goal and calculate how to get back on track
See Goals for more details.
Events are what drive contextual information within Frollo. When an insight is found or an action is needed by the user an event is triggered. Events can also provide time based events such as user journey triggers and other time sensitive actions.
See Events for more details.
Messages allow insights and feedback to be provided to the user in the form of nudges and other content. Messages are a customisable content delivery system allowing the system to provide reminders back to the user to keep on track, drive offers or any manner of content the user may need.
The following features are supported as part of messages:
- Text, Video, Image and HTML content
- Tracking reading of and interaction with the message
- Driving the user to deep linked content in a consuming app
- Chaining and trumping of messages to ensure the user doesn’t get bombarded with duplicates and only has relevant content at the right time
See Messages for more details
Surveys allow you to collect feedback and conduct surveys from the user. This can be used to find how a user feels about their financial situation and drive events based on that or even just get feedback on the consuming application.
The following features are supported as part of surveys:
- Multiple questions
- Multiple choice answers
- Dynamic image based answers (choose an emoji that represents how you feel)
- Custom input (freeform) answers
- Triggering events based on answers
See Surveys for more details