Frankie Financial

The Frankie Financial Developer Hub

Welcome to the Frankie Financial developer hub. You'll find comprehensive guides and documentation to help you start working with Frankie Financial as quickly as possible, as well as support if you get stuck.

We recommend you start with our guide to the API Basics.

When you're ready, contact sales ([email protected]) and we can set you up with access to the sandbox.

API Reference    Usage Guides

Smart UI Overview

Our self-onboarding Smart UI allows you to connect your customers directly with Frankie Financial's identity verification and validation services.

They will provide their minimum basic information, we will run all the checks you choose and then signal back to you that the Applicant is ready to be onboarded, right there in the platform it's embedded.

  • The first step is to make sure you have credentials previously provided to your organisation by Frankie: the Customer ID and the api key. Some organisations will also have a Customer child ID.

  • With those in hand you will be able to authenticate to our backend service and generate a secure temporary token that will allow the Smart UI to connect to Frankie Services with limited permissions.

  • Now you only need to provide the Smart UI with that token and optional configuration to customise the behaviour to meet your own goals.

Simply put, the Smart UI is a reusable Web Component or "widget" that sits cleanly on your page or native app via Webview and does all the hard work for you.

We currently offer versions v2 and v3 and recommend the use of version v3 if you are starting fresh. In case you already use v2 and want to get the latest features, please visit the page Migrating v2 to v3 to be aware of the breaking changes from v2 to v3. The changes are simple to handle and not too many.

Please don't download these files. Simply create a script tag and link to either the minified or the non minified .js files below and update the version tag to the desired one. Besides the two major versions v2 and v3, we also provide semantic versioning to target specific points in time. Visit Version Log for details of the available versions.

Updated 3 months ago


Smart UI Overview


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.