Get started

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.

Identifier/API key	Description
X-Frankie-CustomerID	Unique identifier for your account
X-Frankie-CustomerChildID	Unique identifier for your sub account
api_key	Private key for authentication

There are two different API keys for each account, one for each FrankieOne environment.

Environment	Description
UAT	Test your credentials and build out your app with realistic test data
Production	Launch your application with real data

Once you have obtained your API credentials, you can proceed with the following use cases:

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.