DOCSEARCHbyAlgolia
Submit Docs

Debitura API Documentation

website·Indexed 33 days ago

https://docs.debitura.com

Developer documentation for Debitura's debt collection platform, featuring the Customer API and Referral Partner API (v1). Includes integration guides for client onboarding, case submission, and webhook management, as well as technical concepts regarding idempotency, offset-based pagination, and case identifiers.

Tokens
94.7K
Snippets
343
Records
640
Agent score
55%

What's inside Debitura

  1. Overview of Debitura Collection Partner API capabilities

    The Debitura Collection Partner API (v1) allows partners to automate debt collection workflows. Depending on the partnership agreement, users can:

    1. Manage Assigned Cases: Retrieve and manage cases assigned to their agency, track timelines/communications, and update payment information (available for exclusive partners with designated jurisdictions).
    2. Submit Cases to the Network: Submit new cases on behalf of clients to the global network, track status worldwide, and manage cross-border collections through a unified platform.

    All operations follow a no-cure-no-pay model and a standardized Debt Collection Agreement.

  3. Introduction to the Debitura Referral Partner API

    The Referral Partner API allows SaaS platforms to embed Debitura's debt collection services directly into their own platforms.

  4. Overview of Debitura Referral Partner Model

    The Debitura referral partner integration is built around several core technical concepts:

    • Attribution: Determines revenue sharing based on whether clients are attributed or non-attributed and utilizes fee snapshots.
    • White-Label UI: Manages the branded onboarding experience, including specific URL patterns, return URLs, and signing flows.
    • Partner Dashboard: A hosted interface used to track cases, earnings, and referred clients.

  5. Overview of the Debitura Collection Partner API

    The Collection Partner API allows licensed debt collection agencies and law firms to programmatically manage the full case lifecycle. Key capabilities include automating case intake, synchronizing collection progress, reporting payments and partial settlements in real-time, and managing portfolios through querying and filtering assigned cases.

  6. Overview of Debitura Webhooks

    Debitura webhooks allow you to receive real-time notifications when case events occur, eliminating the need to poll the API. Webhooks push event data to a configured HTTPS endpoint as cases progress through the collection lifecycle.

  7. Overview of the Debitura Referral Partner API

    The Referral Partner API is designed for SaaS platforms or marketplaces that embed Debitura for their users. It allows partners to automate client onboarding and track revenue share. Key capabilities include:

    • Creating and managing client accounts on behalf of customers.
    • Submitting collection cases for linked clients.
    • Previewing pricing prior to onboarding.
    • Tracking revenue share via reporting endpoints.
    • Receiving real-time updates via webhooks.

    Note: If you are collecting your own debt rather than embedding the service for others, use the Customer API instead.

  8. Overview of the Debitura Customer API

    The Customer API (also known as the Creditor API) allows users to submit debt collection cases to Debitura's network of pre-legal collection agencies and track their progress. Key capabilities include submitting collection cases, previewing eligibility and pricing, tracking case status/timelines, managing contracts and creditor divisions, and receiving real-time payment and status events via webhooks.

  9. Overview of Collection Partner API capabilities

    The Collection Partner API allows collection agencies and law firms to automate Debitura workflows. Capabilities vary by partnership type:

    • Exclusive partners (designated jurisdictions): Can retrieve assigned cases, manage case status, record payments, close cases, and communicate with creditors.
    • All partners (via managing partner model): Can submit cases on behalf of their own clients to Debitura's global network and track progress.

  10. Integrate debt collection into a SaaS platform using the Referral Partner API

    The Referral Partner API allows SaaS platforms (such as accounting software, invoicing tools, or ERPs) to offer debt collection as a native, white-labeled feature. Key capabilities include:

    • Programmatic Client Onboarding: Create Debitura accounts for users via API.
    • In-app Case Submission: Enable users to send invoices to collection directly from the platform.
    • White-labeling: Apply custom branding to all user-facing flows.
    • Revenue Tracking: Monitor earnings and attribution through reporting endpoints.
    • Real-time Notifications: Use webhooks for onboarding completion, case updates, and payments.

  11. Understand the Debitura Task Model

    A task in Debitura is a prompt indicating that a specific action (e.g., replying to a chat, signing a contract, or assigning a bank account) must be completed before a case can proceed. Tasks are created automatically as a case progresses through its lifecycle and auto-resolve once the underlying condition is cleared; there is no explicit 'mark as done' API call. Because they are live work queues, a task present in one API call may be gone by the next if the condition was met.

  12. Understand client attribution and its impact on revenue

    Attribution determines which cases generate revenue for a referral partner based on whether the client was introduced to Debitura by the partner's platform.

    Attributed Clients (isAttributedClient: true) A client is attributed if they did not exist in Debitura before the integration introduced them. This occurs when POST /clients returns 201 Created or 202 Accepted. Partners earn revenue on all cases from these clients, regardless of the creation channel (API, portal, CSV, etc.).

    Non-Attributed Clients (isAttributedClient: false) A client is non-attributed if they already existed in Debitura before being linked. This occurs when POST /clients returns 409 with ClientExistsNeedsLinking or when a client approves a link to an existing account. Partners earn revenue only on cases where the creation source is ReferralPartnerBearerToken (e.g., Customer API submissions using a bearer token).