Goal
Generate a valid API key from your Debitura account and share it with your developer so they can begin building an integration.
Before you start
You need a Debitura client account. If you do not have one yet, see Getting started with Debitura.
To test your integration without triggering real collection activity, use the IsTest flag when creating cases via the API. There is no separate test environment for clients.
Steps
Open the API Keys page
Go to API Keys in your Debitura account.Generate a new API key
Click the button to generate a new key. Your API key will be displayed. Copy it immediately, as it may not be shown again in full.Share the API key securely with your developer
Use a secure method to share the key with your developer or IT team:
Use a password manager with secure sharing (such as 1Password, LastPass, or Bitwarden)
Use an encrypted messaging service
Avoid sending API keys via plain email or unencrypted chat
Your developer adds the key to their integration
The developer includes the API key in the header of every API request:
XApiKey: YOUR_API_KEY
Result
Your developer can now authenticate with the Debitura External API. They can verify the key works by calling the profile endpoint (GET /me), which returns your creditor profile information if the key is valid.
Regenerating or rotating a key
If your API key is compromised or you need to rotate it for security reasons, return to the API Keys page and generate a new key. Update your integration with the new key and retire the old one.
Security tips
Treat API keys like passwords. Do not commit them to version control or share them in public channels.
Use the IsTest flag when creating cases during development. This validates your requests without triggering real collection activity.
Rotate keys periodically and whenever team members with access leave your organization.
Developer Docs: Developers implementing the integration can find full technical details at Developer Docs: Clients.