Skip to main content

Collection Partners: Integration Guides

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

Available Guides​

Create a Managed Case​

Submit a case on behalf of your client and choose the right amount input for a single, multi-invoice, or part-paid claim.

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 cases you work or manage using the role-specific file endpoint.

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 for a chosen outcome

Use POST /cases/{id}/close to close a case with an explicit close code. A full-settlement POST /cases/{id}/payments request can also close the case as Paid when it includes closeCase: true; partial payments do not. See Close a Case for the dedicated endpoint reference.

Prerequisites​

Before following these guides: