Getting Started

Obtain your API keys

To get started, you’ll need API keys that you can request from your customer success manager. API keys are issued for every unique account including optional sub-accounts if you wish to segregate data and/or access.

Each account has two different API keys, one for each FrankieOne environment.

Contact FrankieOne to obtain API keys to the Sandbox environment and access to the FrankieOne Portal. FrankieOne should have a default workflow and service profile setup as part of your account creation. Once you have obtained your API credentials, you can try authenticating.

Try Authenticating

To use the FrankieOne KYC v2 API, each request must be authenticated. You can perform authentication by using the following steps:

• Provide API key in the header: include the api_key parameter in the header of every API request.
• Provide CustomerID in the header: include the X-Frankie-CustomerID in the header of every API request
• Use HTTPS protocol. You need to use the HTTPS protocol to ensure secure communication with the API. The base URL is <https://api.frankie.one/v2>.

Navigate to <https://api.uat.frankie.one/ruok> and try running a sample CURL request using the provided API keys and CustomerIDs.

Quick Start Guide

Once you have successfully authenticated with FrankieOne, you can start making calls to the API. The contained quick start guide provides a few key common use-cases that you can trial to see if it meets your customer onboarding needs.

These sample requests will allow 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.
4. Use-case #4: Screen an individual to determine AML risk
5. Use-case #5: Classify a individual screening result as true positive / false positive

Starter Pack

The following table contains information you may find useful for integrating with the FrankieOne API. You must request your unique customer IDs and API keys from your Customer Success manager.