Skip to main content

Collection Partners: Integration Guides

Workflow guidance for Collection Partner integrations. For endpoint details, see the API Reference.

Available Guides​

Start a Case​

Move a case from PendingVerification to Active, providing a required welcome message and optionally attaching fees.

Update Case Progress​

Document collection activities and communicate with creditors.

Record Payments​

Report payments and handle allocation between creditor and commission.

Correct or Remove Payments​

Edit or reverse a recorded payment, with the consent-gated case reopen and the invoiced-frozen rule.

Update Claim Amount​

Adjust the principal (gross amount) and fees on a case to reflect the current state of the debt.

Upload Files​

Attach documents and evidence to a case using POST /cases/{id}/files.

Webhooks​

Receive real-time event notifications for case assignments, lifecycle changes, payments, and chat messages.

Ingestion Jobs​

Enqueue batches of case events (notes) asynchronously and poll for completion — an alternative to calling per-case note endpoints when processing CRM exports or scheduled reports.

Closing Cases​

To close a case, call the close endpoint with an appropriate close code. See Case Lifecycle for all close codes and their meanings, or the Close Case API reference for endpoint details.

Use the dedicated close endpoint

POST /cases/{id}/close is the only valid way to close a case via the API. See Close a Case for the full endpoint reference.

Prerequisites​

Before following these guides: