KYCImplementation Guide

Getting Started

Overview

The FrankieOne KYC v2 API enables seamless integration for identity verification and compliance workflows. This guide will help you get started with authentication and API setup.

Steps to Follow

1

Obtain Your API Keys

To begin, contact FrankieOne to request your API keys for the Sandbox environment. In your request, specify that you need access to the FrankieOne v2 API and Portal.

API keys are issued for each unique account, including optional sub-accounts if you wish to segregate data or access. Each account has two API keys:

EnvironmentDescription
UATTest your credentials and build your app with realistic test data.
ProductionLaunch your application with real data.

Sub-accounts, identified by the X-Frankie-CustomerChildID header, are planned for future updates and are currently on the roadmap.

2

Authenticate API Requests

To use the FrankieOne KYC v2 API, all requests must be authenticated. Follow these steps to authenticate:

  1. Include API Key in the Header
    Add the api_key parameter to the header of every API request.

  2. Include Customer ID in the Header
    Add the X-Frankie-CustomerID parameter to the header of every API request.

  3. Use HTTPS Protocol
    Ensure secure communication by using the HTTPS protocol. The base URL for the API is:

    https://api.frankie.one/v2
3

Test Your Authentication

To verify your credentials, navigate to the following endpoint:

https://api.uat.frankie.one/ruok

Run a sample curl request using your API keys and Customer ID. For example:

$curl -X GET "https://api.uat.frankie.one/ruok" \
>-H "api_key: YOUR_API_KEY" \
>-H "X-Frankie-CustomerID: YOUR_CUSTOMER_ID"

API Credentials & Security

To ensure secure access to the FrankieOne KYC v2 API, you will need to include specific headers in your API requests. These headers are essential for authentication and identifying your account.

Here’s a quick reference for the required headers:

HeaderDescription
X-Frankie-CustomerIDUnique identifier for your account.
X-Frankie-CustomerChildIDUnique identifier for your sub-account (on the roadmap).
api_keyPrivate key for authentication.

Once you have obtained your API credentials, you are ready to start integrating with the FrankieOne KYC v2 API.

Keep your API Key Secure

Your API key is sensitive information. Treat it like a password and do not expose it in public repositories or client-side code. If you suspect your API key has been compromised, contact FrankieOne support immediately to revoke the key and issue a new one.