Quickstart Implementation Guide

Overview

Welcome to the FrankieOne OneAPI Quick Start Implementation Guide. This document is designed to help you quickly and efficiently integrate our API into your application. Whether you’re a seasoned developer or new to APIs, this guide will provide you with the necessary tools and information to get started.

This quick start guide starts with a short introduction in acquiring your API keys for both your **sandbox **and **production **environments followed by key use-cases for OneAPI, to complete your customer onboarding needs.

Following these use-cases lets you complete an integration with OneAPI, allowing you to:

  1. Use-case #1: Verify an individual through safe harbour practices using a government ID.
  2. Use-case #2: Remediating an individual that has failed a verification and rerunning a workflow to pass.
  3. Use-case #3: Verifying an individual through manual KYC.

FrankieOne v2 Starter Pack

To integrate the FrankieOne v2 OneAPI, request a FrankieOne v2 starter pack from your customer success manager. The following table lists the information you receive:

No.ResourceDetails
Portal
1UAT Portalhttps://portal.kycaml.uat.frankiefinancial.io/login
2Production Portalhttps://portal.kycaml.frankiefinancial.io/login
Documentation
3Implementations Guide (Full)OneAPI KYC V2 - Implementation Guide
4API Specificationshttps://apidocs.frankiefinancial.com/v2.0.0/reference/authentication
5Postman CollectionComing soon
API Keys
7UAT Credentials

- CustomerId
- CustomerChildId (optional)
- API Key		Request from Customer Success manager
8UAT Base URLhttps://api.uat.frankie.one/v2
9Production Credentials

- CustomerId
- CustomerChildId (optional)
- API Key		Request from Customer Success manager
10Production Base URLhttps://api.frankie.one/v2

Pre-requisites

Before integrating our APIs, please complete the following setup tasks:

  1. Request API keys from a customer success manager.
  2. Get setup with FrankieOne v2 Portal access.
  3. Ensure that you have a default workflow configured (default: Safe Harbour Gov ID).
  4. Ensure that you have a default service profile configured (usually called: KYC)
Built with