Skip to content

Quickstart

To get started, please email hello@herondata.io for API credentials.

Postman Collection

The fastest way to start is to use our Postman Collection with your credentials. You can find the Postman collection here. Simply open the collection in Postman, click the three ellipses on the right hand side of the collection in the pane on the left, select "edit", then "Authorization" and pick "Basic Auth" in the drop-down and enter your credentials. Post transactions to /transactions, and see results!

Pro Tip: By clicking the three ellipses in the middle pane and selecting "code", you can see code snippets for the request you're currently making.


Category Labels

If you require categorisation, we will provision a taxonomy for you during onboarding. We work with customers across SME and consumer data, including use cases like lending, tax optimisation, budgeting, etc. Our customers derive most value from us when tailoring their categories to their specific use case, and all of our customers have different category labels. Possible examples include:

  • Consumer Lending: Pick out gyms and charities as positive predictors of repayment rates. Differentiate between different loan categories for existing loans (Mortgage vs. Car loan vs. Near-prime unsecured personal loan vs. Payday loan).
  • Carbon Budgeting: Differentiate vegan restaurants from normal restaurants. Split up travel into airlines, trains, car travel.
  • SME Lender: Differentiate between recurring and non-recurring revenue. Split out personal expenses.

Note: These examples are fictitious. Your category labels will not be disclosed to any third-party.