Getting started

Obtain your API keys

Contact FrankieOne to obtain your API keys to the Sandbox environment. Please request access to the FrankieOne v2 API and Portal in the message field.

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.