Authentication

The FrankieOne API uses API key-based authentication with required customer identifiers in the request headers.

When you register for the FrankieOne API, you’ll receive the following credentials:

CustomerID

Your primary account identifier. Required for all API calls.

ChildID

Optional identifier for organizational divisions or service agents. Only required if your account uses child entities.

API Key

Your secret authentication token. Keep this secure and never share it publicly.

Making Authenticated Requests

To authenticate your API requests, include the following headers with every call:

1X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012
2X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321 # Optional - only if using ChildID
3api_key: 245c765b124a098d09ef8765....

Never expose your API key in client-side code or public repositories. Always keep it secure on your server.

When to Use ChildID

The ChildID is required in two specific scenarios:

  1. Organizational Divisions: When your company operates across multiple regions or countries
  2. Service Agents: When you’re acting as an agent for another service that uses FrankieOne for KYC/AML

If you’re unsure whether you need a ChildID, contact your FrankieOne representative.

Built with