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:
- Use-case #1: Verify an individual through safe harbour practices using a government ID.
- Use-case #2: Remediating an individual that has failed a verification and rerunning a workflow to pass.
- Use-case #3: Verifying an individual through manual KYC.
FrankieOne v2 Starter Pack
To get integrate the FrankieOne v2 OneAPI you will need to request a FrankieOne v2 starter pack from your customer success manager. The following table lists the information you will receive:
| No. | Resource | Details |
|---|---|---|
| Portal | ||
| 1 | UAT Portal | https://portal.kycaml.uat.frankiefinancial.io/login |
| 2 | Production Portal | https://portal.kycaml.frankiefinancial.io/login |
| Documentation | ||
| 3 | Implementations Guide (Full) | OneAPI KYC V2 – Implementation Guide |
| 4 | API Specifications | <https://apidocs.frankiefinancial.com/v2.0.0/reference/authentication> |
| 5 | Postman Collection | Coming soon |
| API Keys | ||
| 7 | UAT Credentials - CustomerId - CustomerChildId (optional) - API Key | Request from Customer Success manager |
| 8 | UAT Base URL | https://api.uat.frankie.one/v2 |
| 9 | Production Credentials - CustomerId - CustomerChildId (optional) - API Key | Request from Customer Success manager |
| 10 | Production Base URL | https://api.frankie.one/v2 |
Pre-requisites
Before integrating our APIs, please complete the following setup tasks:
- Request API keys from a customer success manager.
- Get setup with FrankieOne v2 Portal access.
- Ensure that you have a default workflow configured (default: Safe Harbour Gov ID).
- Ensure that you have a default service profile configured (usually called: KYC)
Updated about 2 months ago