Skip to main content

Quickstart

Create your first case in 2 minutes.

Prefer video? This walkthrough covers the same steps below, from generating your API key to a successful case creation:

Prerequisites​

Get your API key from Creditor Portal → API Keys. See Authentication for details.

Create a Test Case​

curl -X POST https://customer-api.debitura.com/cases \
  -H "Content-Type: application/json" \
  -H "XApiKey: YOUR_API_KEY" \
  -d '{
    "isTest": true,
    "currencyCode": "EUR",
    "date": "2025-01-15",
    "amountToRecover": 1000.00,
    "debtor": {
      "type": "Company",
      "name": "Test Company",
      "address": "Test Street 1",
      "city": "Berlin",
      "countryAlpha2": "DE"
    }
  }'

Success Response​

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "Q8OAXF3W",
  "lifecycle": "Pending Verification Internal",
  "isTestCase": true
}

You've created a test case. Its initial pending lifecycle depends on your account's verification and contract configuration; newly created cases do not start directly as Active. It won't trigger real collection activity.

This quickstart uses one amount for one invoice. Before mapping production claims, choose the right claim amount and age mode.

See Create a Case for the full field reference, Track Case Status to monitor progress via polling or Webhooks, and Test Cases for testing your integration.