The Footprint API uses API keys to authenticate requests. You can view and manage your API keys in the developer dashboard. Go to the Footprint developer dashboard and generate a new Secret API Key.

sk_testPrefix for Test mode API secret keys. No costs are incurred using these keys!
sk_livePrefix for Live mode API secret keys

Basic Authentication

Authentication to the API is performed via HTTP Basic Authentication. Provide your API key as the basic auth username value with no password. In curl syntax this would be written as -u <api_key>:. For example:


curl ... -u sk_test_CXUsbCR8j2kH6e5GeEl8eSBnQTIPCUaKpv:

Header Authentication

Alternatively, Footprint supports header-based auth via the X-Footprint-Secret-Key header. For example, to authenticate with header auth using cURL use the following instead of -u <api_key>:


curl ... -H "X-Footprint-Secret-Key: sk_test_CXUsbCR8j2kH6e5GeEl8eSBnQTIPCUaKpv"

Check that your key works

You can check that your API key is working as expected:


curl -u sk_test_CXUsbCR8j2kH6e5GeEl8eSBnQTIPCUaKpv: