Getting Started
Everything you need to go from zero to a working integration.
What the Referral Partner API does
The Referral Partner API lets you onboard clients onto Debitura and track revenue share automatically. Typical uses:
- Create and manage client accounts on behalf of your customers
- Submit collection cases directly for linked clients
- Preview pricing before a client commits to onboarding
- Track your revenue share via the reporting endpoint
- Receive real-time events via webhooks
Building a platform? If you're a SaaS or marketplace embedding Debitura for your users, this is the right API. If you're collecting your own debt, use the Customer API instead.
Prerequisites
Before you start coding:
- Partnership agreement — signed with Debitura
- API credentials — test and production API keys, provided by your partnership contact or generated at app.debitura.com/ReferralPartnerApiKey
- Read How It Works — understand the two-API architecture before writing any code
What you'll build
A typical referral partner integration has four components:
| Component | What it does |
|---|---|
| Client onboarding | Create creditor accounts, redirect to SDCA signing |
| Case submission | Mint bearer tokens, submit cases via Customer API |
| Webhooks | Receive events for onboarding completion, case updates, payments |
| Revenue tracking | Most partners use the Partner Dashboard out of the box. Optionally, query the reporting endpoint to build custom earnings views. |
See it in action: Try the live demo to see the white-label onboarding experience, and log into the Partner Dashboard with demo to explore case tracking and revenue reporting.
In this section
- How It Works — Two-API architecture, the flow, and what goes where
- Authentication — API key + bearer token model with code examples
- Environments — Test and production URLs for all services
- Quickstart — End-to-end: create a client, submit a case
What's Next
After completing the quickstart, move to the Integration Guides to build out each component of your integration.