Quick start Implementation Guide


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.

To get started, read the Get started section, where you'll learn how to acquire your API keys for both your sandbox and production environments followed by key use cases for using 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 you need to request a FrankieOne v2 starter pack from your customer success manager. The following table lists the information you will receive:

1UAT PortalURL
2Production PortalURL
3Implementations Guide (Full)OneAPI KYC V2 – Implementation Guide
4API SpecificationsLink
5Postman CollectionLink
API Keys
6UAT CredentialsRequest from Customer Success manager
7UAT EndpointURL
8Production CredentialsRequest from Customer Success manager
9Production EndpointURL
Troubleshooting & Contacts
13Customer SuccessEmail


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)

What’s Next