Integration Guides
Step-by-step guides for building your referral partner integration. Follow them in this order for the smoothest path.
Recommended implementation order
1. Client Onboarding (start here)
Client Onboarding — Create creditor accounts, handle 201/202 responses, and redirect users to the onboarding UI. This is the foundation everything else builds on.
Handling 409 Conflicts — What happens when the user already exists in Debitura. Covers the approval flow, choice page, multi-entity scenarios, and how to create cases after conflict resolution.
2. Webhooks
Webhooks — Subscribe to events for client onboarding completion, case updates, and payments. Set up your handler before submitting cases so you can track progress in real time.
- Webhook Best Practices — Production patterns for timeout handling, retry behavior, and idempotency
- Webhook Testing — Fire test events to verify your handler
- Webhook Security — HMAC-SHA256 signature verification
3. Case Pricing
Preview Case Pricing — Look up the success fee before your client commits. Use this in your sales or onboarding flow to show transparent pricing.
4. KYC Verification
KYC Verification — Some collection partners require director identity verification. Understand when it's needed and how allowPendingContracts works.
5. Revenue Tracking
Revenue Tracking — Build revenue dashboards. Covers the 6-stage fee pipeline, exchange rate handling, and reconciliation patterns.
Case Management (via Customer API)
After onboarding clients, submit and manage cases using the Customer API with bearer tokens. See How It Works for the two-API architecture.
- Claim Amount and Age — Choose how to send principal and aging data, and check which modes each endpoint accepts
- Create a Case — Submit cases for collection
- Track Case Status — Monitor case progress
- Upload Documents — Attach supporting documents
- Payments and Reconciliation — Track payments