Welcome to our API Key Generation Guide! This page will walk you through the process of obtaining an API key to interact with our on-ramp and off-ramp services. 🎉

​
📝 How to Obtain Your API Key

  1. Partner Onboarding:
    1. First, you’ll need to be onboarded as a partner through our team. A member of the will be your main point of contact in your onboarding process, ensuring all necessary information is collected to create your partner account. Please contact us via email
  2. API Key Issuance:
    1. Once your onboarding is complete, you will receive your unique API key. This key is your gateway to accessing our API endpoints and must be kept secure. 🔐
  3. Receiving Your API Key:
    1. The API key will be sent to you securely via email or your preferred communication method. Make sure to store it safely, as this key allows you to authenticate and perform transactions using our API. 📧

​
🔍 Using Your API Key

To authenticate your requests, you need to include your API key in the headers of every HTTP request you make to our API.

​
Example Request with API Key

Include your API key in the request header under the partner-api-key field.
bash
curl -X GET 'https://staging-api.capa.fi/api/partner/v1/wallets/partner' \
  -H 'partner-api-key: YOUR_API_KEY_HERE'

​
🔄 Header Format

http
partner-api-key: YOUR_API_KEY_HERE
Replace YOUR_API_KEY_HERE with the actual API key provided to you.

​
🚨 Important Security Notes

  • Keep Your API Key Secure: Treat your API key like a password. Do not share it publicly or expose it in client-side code (e.g., JavaScript, HTML). 🛡️
❗️If you suspect that your API key has been compromised, please contact us immediately. We will promptly issue a new key to ensure your account’s secured.