Skip to main content

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 ValueDescription
Pending contract signingAwaiting creditor contract signature
Pending Verification InternalInternal review before partner assignment
Pending VerificationPartner reviewing case details
More Info RequiredAdditional information needed from creditor
Pending quote by partnerLegal escalation requested, awaiting partner quote
Quote given by partnerPartner has submitted a legal quote
ActiveCase is being actively collected
PausedCollection temporarily suspended
ClosedCase resolved (check closeCode for outcome)

Close Codes

The closeCode field indicates why a case was closed. Only present when lifecycle is Closed.

API ValueCategory
PaidSuccess
Partially paidSuccess
Case never startedRejected
Invalid Case DataRejected
Debtor Insolvent/BankruptUncollectable
Debtor UntraceableUncollectable
Disputed – Legal Action Declined by ClientClient decision
Withdrawn by ClientClient decision
Pre-Legal Exhausted – No PaymentCollection exhausted
Statute of Limitations ExpiredCollection exhausted
Settlement Rejected by ClientClient decision
Unresponsive ClientClient decision
OtherOther

Business context: See Case Close Codes for what each outcome means and when it applies.

API Response Fields

FieldTypeDescription
lifecyclestringCurrent lifecycle state
closeCodestringOutcome reason (only when lifecycle is Closed)
closeCommentstringOptional closure explanation
dateFinisheddatetimeWhen case was closed
dateCollectionStarteddatetimeWhen collection began

Tracking Changes

Subscribe to webhook events to receive real-time lifecycle updates:

EventTrigger
case.createdCase first created
case.updatedLifecycle state changed
case.closedCase 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.