Quickstart Guide
Login

Quickstart Guide

This quickstart guide is here to help you integrate with and start benefiting from Credfin's system as quickly and easily as possible.

In this guide, we will be connecting a user with their nominated bank account, extracting and analysing all of the transactions from the last year in that account, finally viewing the result in a nicely formatted PDF or HTML document.

Access

To gain access, you must first create an account by using the demo (top right hand corner of this site). All the information you need will be sent to you in an email. Once that is done, you can use the iFrame and access the dashboard to view the analyses.

You will be provided with a vendor label; basically a small identifier that lets us know the application belongs to you. This label will be used in some API requests as a way of quickly and positively identifying your organisation.

Basic User Flow

There are few simple steps required to connect an end-user to the Credfin system and extract an analysis of their bank account information. For this example, we're going to perform the simplist application possible by using the iFrame and Dashboard. For more information on how to deeplink into the iFrame or how to integrate using the API, feel free to reach out.

  • Create a unique iFrame URL for the customer
  • Deliver the url to the customer; probably just pasting it into an Incognito Window for this example
  • Once the user has completed the application, log into the Dashboard and view the application

For testing, we have Bank of Credfin. You can use it to test as much as you like and it can even simulate all kinds of successes and errors.

Creating a unique URL

There are only two parameters required to create a unique iFrame URL. One is your vendor label, which was created when you used the demo just before and was emailed to you. And the other is a unique customer identifier that is only used for that one application. A good choice would be to use a UUID or some kind of convention that rotates and isn't easily duplicated. If you want to track the customer in your backend, then it's important to store the Vendor Specific Id somewhere stateful. In some use cases, however, you may not have that requirement; in which case using any random identifier that can't be duplicated will suffice.

There are plenty of options for the iFrame that allow you to control the behaviour and branding for an optimal customer experience. Capabilities include deep linking to specific steps, pre-filling information, as well as customizing the page font and colours to match your brand. You can find more information by reading the iFrame Guide.

Here's an example URL:

1https://credfin.io/i/{VENDOR_LABEL}/{VENDOR_SPECIFIC_ID}

Or in the form of an iframe HTML tag:

1<iframe src="https://credfin.io/i/{VENDOR_LABEL}/{VENDOR_SPECIFIC_ID}/" />

Again, this is the simplest possible example; there are plenty of arguments and parameters you can use to prefill or deep link into the iFrame.

If you plan to wrap the iFrame in your own parent window, there are a many events you can listen to and utilize to improve your customer's experience. These events are beyond the scope of this quickstart guide however, so head over to the Iframe Guide when you'd like to learn more.

And, that's it! Once your customer has completed the application, their data will appear in the dashboard.

Retrieving the data

Heading over to the dashboard you can view the application in the Application or Analysis list. Opening the look up will reveal all the artifacts generated by the analysis process. Up the top is the summary and further down where the accounts list is, are the analyses to the right.

In the real world you would have the Credfin webhook the results to your backend so you can react to the events by downloading the parts you're interested in programatically.

An easy way to test this is to create a url with webhook.site to test with. You can, however, change or remove these at any time and replace with your own webhooks, either through the API or in the dashboard.

These webhooks will notify you when each part of the data for the account has been analysed and ready for viewing. To make it faster and more responsive, analysis is done in such a way that we send the data in segments as it’s ready for you to view. However, for simplicity’s sake, we shall wait until all analysis is completed. When it’s done you will receive a webhook event called application.report_ready:

1{
2  "event": "application.report_ready",
3  "payload": {
4    "id": 100000,
5    "vendor_specific_id": "123456789",
6    "vendor_label": "test",
7    "timestamp": "2020-09-10T08:53:02.229592+10:00",
8    "crawler": [
9      {
10        "profile": 10000,
11        "uuid": "ba8f4a5e-be0b-4bcd-954a-483d86628e90",
12        "application": 100000,
13        "bank_id": 130,
14        "timestamp": "2020-09-10T08:53:04.039916+10:00",
15        "status": "COMPLETED"
16      }
17    ],
18    "full_name": "Donald Duck",
19    "email": "test@test.com",
20    "mobile": "04000000",
21    "finalised": true,
22    "analysed": true
23  }
24}

Using this information, we can view the fruits of our labour, in HTML:

1https://credfin.io/api/applications/{application_id}/summary/html

in JSON:

1https://credfin.io/api/applications/{application_id}/summary

or PDF:

1https://credfin.io/api/applications/{application_id}/summary/pdf

There are of course many more events that get fired all organised into groups that match the data. But this was just an example of the simplest possible end-to-end test run.

Subscribe to our newsletters

Subscribe to our newsletter and stay up to date with the latest news about Credfin.

FDATA