Frequently Asked Questions
Frequently Asked Questions
You can start using our APIs by signing up to our developer console and selecting one of our free testing plans. For easy testing and integration, we support both Swagger UI and Postman. For more information, please visit our Quickstart Guide.
FinchXP intelligence is underpinned by machine learning and artificial intelligence principles to ensure the accurate identification and classification of transaction data. In analysing over 4 billion transactions, our machine learning model provides 95% accuracy, 15-30% higher than alternatives on the market.
Yes, if you are a loyalty, reward or cash back program looking to reward customers faster, improve engagement, and increase revenue through customer insights. Our on-demand Loyalty API matches eligible transactions to eligible merchants in seconds.
Yes, if you are a lender managing an influx of COVID relief requests and need accurate expense categorisation for faster credit assessment. If you are looking to provide digital loans and need even faster approval, we offer real-time categorisation that can identify high risk activities that are commonly missed.
Yes, if you are a PFM provider that relies on highly accurate transaction data to deliver personalised insights to customers. PFMs currently using data aggregators can benefit from an immediate 25-40% lift in accuracy by using our PFM API as an overlay.
FinchXP offers 3 data intelligence products:
Our PFM API turns raw transaction data into clean UI and meaningful insights with 95% accuracy for merchant name, location and category.
Our Lending API features Australia’s most advanced categorisation to help you conduct accurate credit assessments, available in real-time for digital loans.
Our Loyalty API automates your rewards program by identifying eligible online and in-store transactions in real-time.
Creating a free account is fast and easy. Simply create a username and password, with your name and email address. Once you’ve verified your email you’ll be given an API Key to get started.
Your free testing plan gives you access to one of the following APIs:
- Lending API
- PFM API
Your testing limits are as follows:
- 100 unique end users
- 1,000 transactions
- 90 days
- Real-Time Service
Once your testing plan expires or exceeds the limit, you will need to upgrade to a paid account. You will be charged a flat fee per active user, based on your processing requirements.
Each API on our platform generates a different output.
Please see our documentation for the output fields when using PFM API, Lending API or Loyalty API.
FinchXP has two services:
Standard service is for customers in production requiring overnight data intelligence on up to 1 million end-users or 10 million transactions per job e.g. personal finance, retail analytics, and digital banking. These files will be processed between 1am – 5am AEST and made available at 9am AEST Monday – Friday. You will receive a notification when your files are ready.
Real-time service is for customers in production requiring advanced data intelligence in real-time e.g. on-demand lending, personal finance alerts/notifications, and more. Once in production, our real-time endpoint is capable of handling concurrent requests (up to 100 transactions per request) in milliseconds.
Yes, we support up to 50+ customer fields. Please contact our Sales team to discuss a custom solution to meet your needs.
FinchXP supports all Australian bank transaction data and Australian aggregate data.
There are no limits to the volume or frequency of data you wish to upload. You will simply be charged on a flat fee per active user, after you finish your 60 day free trial.
Please contacts our Sales team so that we can upgrade your account to a flat fee per active user.
You may also enquire about increased processing speed, or a custom solution for your account.
See our pricing options or contact our Sales team to discuss further.
Our pricing options are designed to scale as your business grows, with special minimum costs per month for startups.
For Standard service, we support multiple combinations for file format and compressions:
Formats: CSV, TSV (Tab-separated variant of CSV), JSON, PARQUET and ORC.
Compression: Zipped, GZipped, B2Zipped and Snappy.
For Real-time service, we only support JSON requests.
Please read our documentation for details on how to upload and access enriched files.
For enriched data, we support GZipped CSV.
Please review our documentation or contact our Support team for assistance.
The FinchXP Test data consists of 100 transactions from 4 fake users with accounts at 4 fake financial institutions/banks – the non-sensitive data is publicly available from our github repository.
You are welcome to test using your own real data although testing (both fake and real data) is limited to 1000 transactions, 100 users, or 90 days: whichever is first. For security and performance reasons, we have set limits of 100 transactions per request and 3 requests per user (per day).
If you would like to test with your own data, please contact us and we’ll provide you with a list of financial institutions/banks that we support for testing.
Please check that you have entered your email address correctly and that it hasn’t landed in your spam folder. If you are still having issues please feel free to our Support team for assistance.
Please ensure you’re entering the most recent code you received when resetting your password. If you are still having issues please feel free to contact us for assistance.
You will receive an invoice at the start of each month for your API usage for the month prior. Payment terms and details will be included in this invoice.
Please contact our Support team to change the user for your usage plan.
If you’d like to change your processing speed from standard service to real-time, please contact our Sales team.
If you’d like to change your existing plan to a new product type, please contact our Sales team.
FinchXP is committed to ensuring the safety and security of our customers. We regularly review our information security management system, including internal policies, audits, and documentation to keep your data safe at all times.
Our Developer portal is hosted on AWS S3 via Server-side rendering, so access to your API Key and Client credentials are secure. Your files are stored in this secure S3 bucket. Together with our endpoints supporting TLS with strong crypto-suite, your data is encrypted securely in transfer, in use and at rest.
When data is received on the platform, it is separated, anonymised and only made available to your API Users.
FinchXP respects your privacy and takes safeguarding personal data seriously. Data shared with FinchXP remains strictly confidential and will not be used for anything other than providing the service requested of us.
No. Finch does not require any PII Data to conduct transaction data enrichment. This includes any form of identifiable information such as email or phone number.
FinchXP’s machine learning model relies on new and existing data sources to continuously improve accuracy levels. We only store raw transactional descriptions and related metadata such as amount, currency, and known bank providers. We never handle nor store PII data.
Your Authentication and Client Secret is linked to your Developer Console account. You can retrieve them from the Developer Console at any time.
If your Client ID and/or Client Secret has been compromised or stolen, please login to the Developer Console, revoke the compromised credentials, and create a new pair of credentials for your application.
Alternatively, you can contact Finch Support for assistance.
If your API Key or Developer Console account has been compromised or stolen, please contact Finch Support immediately so that we can issue a new API Key and/or assist with account recovery.
There are 2 ways to keep your credentials secure:
- Keep credentials secured on your server-side. Your credentials should not be used directly in your front-end web applications or mobile web applications.
- Double check that you are making calls to our endpoint servers using `https://` protocol (i.e. https://api.finchxp.com) for both nonprod and production environments.
Anyone with access to your client details will be able to make API calls and use your plan. While we do not allow the retrieval of onboarded data, credentials will allow a user to access your enriched data, check usage reports and upload new jobs which will incur new charges.
If your organisation requires multiple teams / personnel to work with different datasets, microservices or applications; it is strongly recommended that each entity has their own pair of Client ID and Client Secret credentials. These can be easily created (and revoked) in the Developer Portal.
