KYCImplementation Guide

Getting Started: Your First API Call

This guide will walk you through setting up your environment, authenticating, and making your first successful API call to the FrankieOne platform.

Welcome to the FrankieOne API! This guide provides the essential information to get you up and running. Our goal is to help you make your first successful API call in minutes.

FrankieOne v2 Starter Pack

When you partner with FrankieOne, your Customer Success Manager will provide you with a starter pack containing everything you need for each environment. You should have the following:

ResourceUAT / SandboxProduction
Portal URLhttps://portal.kycaml.uat.frankieone.comhttps://portal.frankieone.com
API Base URLhttps://api.uat.frankieone.com/v2https://api.frankieone.com/v2
Customer IDYour unique UAT Customer IDYour unique Production Customer ID
API KeyYour secret UAT API KeyYour secret Production API Key

Quickstart in 3 Steps

Follow these steps to ensure your credentials are correct and your environment is ready for integration.

1

1. Understand Your Credentials

All API requests to FrankieOne must be authenticated. You’ll use the credentials from your starter pack in the request headers.

HeaderDescription
api_keyYour secret API key for the specific environment (UAT or Production).
X-Frankie-CustomerIDThe unique identifier for your account.
Keep Your API Key Secure

Your api_key is a secret and should be treated like a password. Store it securely on your backend and never expose it in client-side code or public repositories. If you suspect a key has been compromised, contact support immediately.

2

2. Test Your Connection

The easiest way to verify that your credentials and connection are working is to call our simple health check endpoint: /ruok.

This endpoint doesn’t require a request body and is used to confirm successful authentication. Let’s test your UAT credentials.

cURL
$curl --location '[https://api.uat.frankieone.com/v2/ruok](https://api.uat.frankieone.com/v2/ruok)' \
>--header 'api_key: {{your_uat_api_key}}' \
>--header 'X-Frankie-CustomerID: {{your_uat_customer_id}}'

A successful request will return a 200 OK status and the following JSON response, confirming your keys are valid.

Response
1{
2  "status": "OK"
3}

If you receive an error, double-check that your API key and Customer ID are correct and that you are using the correct base URL for the environment.

3

3. Confirm Your Workflow Setup

Before you can start verifying customers, your account needs to be configured with at least one workflow and one service profile.

Prerequisites for Verification:

  • A Default Workflow: A sequence of checks to run (e.g., a “Standard KYC” workflow).
  • A Default Service Profile: A profile to link workflows to (e.g., a “KYC” profile).

Your Customer Success Manager typically sets these up for you. If you plan to build your own workflows in the Portal, ensure you have at least one published before proceeding.

Next Steps

Now that you’ve successfully authenticated, you’re ready to start building. Follow our implementation guide for common use cases.

Electronic KYC with Government ID

Learn how to perform a standard electronic KYC check by verifying a customer’s personal information and a government-issued ID.

Manual KYC Verification

Follow the process for recording the outcome of an in-person or offline identity verification.

API Reference

Dive deep into every endpoint, parameter, and response object in our comprehensive API Reference.