Referral Partner API Overview
The Referral Partner API enables platforms to embed Debitura services, onboard clients programmatically, and track revenue attribution. Use this API to offer debt collection capabilities to your users without building your own integration.
New to the Referral Partner API?
Start with the Referral Partners Integration Track for architecture overview and guides, or jump to the Quickstart to onboard your first client.
Base URLs
| Environment | URL |
|---|---|
| Production | https://referral-api.debitura.com |
| Test | https://testreferral-api.debitura.com |
Authentication
The Referral Partner API uses two-layer authentication:
- API Key (
XApiKeyheader) — for all Referral Partner API calls - JWT Bearer Token — for Customer API calls made on behalf of a linked client
# Layer 1: API key in XApiKey header
curl -H "XApiKey: your-api-key" \
https://referral-api.debitura.com/me
# Layer 2: Mint a JWT for a linked client
curl -X POST https://referral-api.debitura.com/oauth/token \
-H "XApiKey: your-api-key" \
-H "Content-Type: application/json" \
-d '{"externalTenantId": "your-client-id"}'
Learn more: Authentication Guide
API Reference
Browse all endpoints in the Referral Partner API Reference.
Key Endpoints
| Category | Description | Guide |
|---|---|---|
| OAuth | Obtain access tokens | Authentication |
| Clients | Create and manage linked clients | Client Onboarding |
| Webhooks | Subscribe to client and case events | Webhook Setup |
| Reporting | Access revenue attribution data | Attribution |
| Partner Profile | View authenticated partner details | — |
Integration Guides
| Guide | Description |
|---|---|
| Quickstart | Onboard your first client in 5 minutes |
| Client Onboarding | Full guide to linking and managing clients |
| Webhook Setup | Configure event notifications |
| Webhook Best Practices | Production patterns for reliability |
| Webhook Events | Event types and payload schemas |
Concepts
| Topic | Description |
|---|---|
| Claim Amount and Age | Choose how case principal and aging data are supplied |
| Client Lifecycle | How clients move through onboarding states |
| Attribution | Revenue tracking and commission model |
| Environments | Sandbox vs production differences |
| White-Label UI | Embedded UI options |
| Authentication | OAuth 2.0 and security |
| Webhooks | Event payload format and verification |
Need Help?
- Troubleshooting: Common Issues
- Technical questions: contact@debitura.com
- Support center: support.debitura.com