Case Lifecycle
Reference for case lifecycle states and close codes returned by the API.
Business context: See Cases in Debitura for what each status means operationally.
Lifecycle States
The lifecycle field indicates where a case is in the collection process.
| API Value | Description |
|---|---|
Pending contract signing | Awaiting creditor contract signature |
Pending Verification Internal | Internal review before partner assignment |
Pending Verification | Partner reviewing case details |
More Info Required | Additional information needed from creditor |
Pending quote by partner | Legal escalation requested, awaiting partner quote |
Quote given by partner | Partner has submitted a legal quote |
Active | Case is being actively collected |
Paused | Collection temporarily suspended |
Closed | Case resolved (check closeCode for outcome) |
Close Codes
The closeCode field indicates why a case was closed. Only present when lifecycle is Closed.
| API Value | Category |
|---|---|
Paid | Success |
Partially paid | Success |
Case never started | Rejected |
Invalid Case Data | Rejected |
Debtor Insolvent/Bankrupt | Uncollectable |
Debtor Untraceable | Uncollectable |
Disputed – Legal Action Declined by Client | Client decision |
Withdrawn by Client | Client decision |
Pre-Legal Exhausted – No Payment | Collection exhausted |
Statute of Limitations Expired | Collection exhausted |
Settlement Rejected by Client | Client decision |
Unresponsive Client | Client decision |
Other | Other |
Business context: See Case Close Codes for what each outcome means and when it applies.
API Response Fields
| Field | Type | Description |
|---|---|---|
lifecycle | string | Current lifecycle state |
closeCode | string | Outcome reason (only when lifecycle is Closed) |
closeComment | string | Optional closure explanation |
dateFinished | datetime | When case was closed |
dateCollectionStarted | datetime | When collection began |
Tracking Changes
Subscribe to webhook events to receive real-time lifecycle updates:
| Event | Trigger |
|---|---|
case.created | Case first created |
case.updated | Lifecycle state changed |
case.closed | Case reached Closed status |
See Client Webhooks or Referral Partner Webhooks for event payloads and setup.
Alternatively, poll the case endpoint:
GET /cases/{caseId}
XApiKey: YOUR_API_KEY
Integration Pattern
1. Receive case.updated or case.closed webhook
2. Validate signature (see webhook security)
3. Update status in your database
4. For closures, store closeCode for reporting
Use the event id field for idempotent processing.
When closeCode is Paid or Partially paid, cross-reference with payment.created events for reconciliation. See Payments and Reconciliation.