Authentication

The FrankieOne API provides a simple, but secure mechanism to authenticate all of your calls.

As a user of the API, you will be allocated a CustomerID and potentially a ChildID.

The CustomerID is your primary identifier.

The ChildID will be issued if you’re accessing the service either as part of an organizational division (e.g. a regional/country division), or as the agent of a service that uses FrankieOne for their KYC/AML needs.

You will also be issued an API key that is tied to both the CustomerID and ChildID.

To authenticate each call, you must supply the CustomerID, the ChildID (if used) and API key as headers in every call to the service. The headers to use are:

X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012
X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321
api_key: 245c765b124a098d09ef8765....

Did this page help you?