curl --request POST \
  --url https://service.incaseof.law/openapi/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "debtor_id": "a1b2c3d4-0000-0000-0000-000000000000"
}
'

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "debtor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "case_reference": "<string>",
    "external_reference": "<string>",
    "partner_reference": "<string>",
    "collection_basis": "assignment",
    "creditor_confirmed_at": "2023-11-07T05:31:56Z",
    "status": "pending",
    "case_status": "open",
    "closure_reason": "paid",
    "closed_at": "2023-11-07T05:31:56Z",
    "collection_stage": "new",
    "claim_disputed": true,
    "obligation_fulfilled": true,
    "subject_matter": "<string>",
    "debtor_type": "privateperson",
    "jurisdiction": "AT",
    "total_claim_amount": 123,
    "total_claim_currency": "EUR",
    "due_date": "2023-12-25",
    "document_date": "2023-12-25",
    "installment_status": "<string>",
    "aktenzeichen": {
      "office": "123",
      "department": "012",
      "caseType": "CG",
      "caseNumber": 4567,
      "year": 2025,
      "checkCharacter": "x"
    },
    "first_notice_sent_date": "2023-12-25",
    "first_notice_total_amount": 123,
    "second_notice_sent_date": "2023-12-25",
    "second_notice_total_amount": 123,
    "third_notice_sent_date": "2023-11-07T05:31:56Z",
    "third_notice_total_amount": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "debtor": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "acting_as": "person",
      "debtor_type": "privateperson",
      "person": {
        "salutation": "mr",
        "first_name": "<string>",
        "last_name": "<string>",
        "birth_date": "<string>"
      },
      "company": {
        "company_name": "<string>",
        "firmenbuchnummer": "<string>",
        "not_protocolled": true
      },
      "addresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "street": "<string>",
          "zip": "<string>",
          "city": "<string>",
          "country": "AF",
          "is_primary": true
        }
      ],
      "communication_channels": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "email",
          "value": "<string>",
          "is_primary": true
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "invoices": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "claim_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoice_number": "INV-1001",
        "invoice_issuer": "<string>",
        "invoice_recipient": "<string>",
        "subject": "<string>",
        "invoice_amount_net": 123,
        "invoice_amount_gross": 123,
        "invoice_issue_date": "2023-12-25",
        "invoice_due_date": "2023-12-25",
        "creditor_reminder_fees_incurred": 123,
        "amount_paid": 123,
        "last_payment_date": "2023-12-25",
        "amount_open": 123,
        "default_date": "2023-12-25",
        "creditor_reminder_dates": [
          "2023-12-25"
        ],
        "default_basis": "reminder",
        "contract_date": "2023-12-25",
        "data_extraction_status": "pending",
        "data_extraction_confidence": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "claim_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "debtor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 500,
        "currency": "EUR",
        "payment_method": "bank_transfer",
        "payment_date": "2023-12-25",
        "invoice_number": "<string>",
        "status": "completed",
        "external_reference": "<string>",
        "notes": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Claims

Create claim

Create a new claim. The organisation is determined from your API key (partner keys: from customer_id). Financial, workflow and collection-stage fields are managed by incaseof.law and cannot be set here — upload the invoice to the claim afterwards (POST /openapi/claims/{claim_id}/invoices or /invoices/manual).

Partner keys: customer_id is required; a debtor_id must be a debtor of your own customers. Organisation keys: customer_id is optional; collection_basis cannot be set.

Partner program (side effect): the first claim created for a partner-created customer with a valid e-mail sends that customer an invitation to the incaseof.law portal. Later claims do not send again.

POST

openapi

claims

curl --request POST \
  --url https://service.incaseof.law/openapi/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "debtor_id": "a1b2c3d4-0000-0000-0000-000000000000"
}
'

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "debtor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "case_reference": "<string>",
    "external_reference": "<string>",
    "partner_reference": "<string>",
    "collection_basis": "assignment",
    "creditor_confirmed_at": "2023-11-07T05:31:56Z",
    "status": "pending",
    "case_status": "open",
    "closure_reason": "paid",
    "closed_at": "2023-11-07T05:31:56Z",
    "collection_stage": "new",
    "claim_disputed": true,
    "obligation_fulfilled": true,
    "subject_matter": "<string>",
    "debtor_type": "privateperson",
    "jurisdiction": "AT",
    "total_claim_amount": 123,
    "total_claim_currency": "EUR",
    "due_date": "2023-12-25",
    "document_date": "2023-12-25",
    "installment_status": "<string>",
    "aktenzeichen": {
      "office": "123",
      "department": "012",
      "caseType": "CG",
      "caseNumber": 4567,
      "year": 2025,
      "checkCharacter": "x"
    },
    "first_notice_sent_date": "2023-12-25",
    "first_notice_total_amount": 123,
    "second_notice_sent_date": "2023-12-25",
    "second_notice_total_amount": 123,
    "third_notice_sent_date": "2023-11-07T05:31:56Z",
    "third_notice_total_amount": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "debtor": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "acting_as": "person",
      "debtor_type": "privateperson",
      "person": {
        "salutation": "mr",
        "first_name": "<string>",
        "last_name": "<string>",
        "birth_date": "<string>"
      },
      "company": {
        "company_name": "<string>",
        "firmenbuchnummer": "<string>",
        "not_protocolled": true
      },
      "addresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "street": "<string>",
          "zip": "<string>",
          "city": "<string>",
          "country": "AF",
          "is_primary": true
        }
      ],
      "communication_channels": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "email",
          "value": "<string>",
          "is_primary": true
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "invoices": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "claim_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "invoice_number": "INV-1001",
        "invoice_issuer": "<string>",
        "invoice_recipient": "<string>",
        "subject": "<string>",
        "invoice_amount_net": 123,
        "invoice_amount_gross": 123,
        "invoice_issue_date": "2023-12-25",
        "invoice_due_date": "2023-12-25",
        "creditor_reminder_fees_incurred": 123,
        "amount_paid": 123,
        "last_payment_date": "2023-12-25",
        "amount_open": 123,
        "default_date": "2023-12-25",
        "creditor_reminder_dates": [
          "2023-12-25"
        ],
        "default_basis": "reminder",
        "contract_date": "2023-12-25",
        "data_extraction_status": "pending",
        "data_extraction_confidence": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "claim_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "debtor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 500,
        "currency": "EUR",
        "payment_method": "bank_transfer",
        "payment_date": "2023-12-25",
        "invoice_number": "<string>",
        "status": "completed",
        "external_reference": "<string>",
        "notes": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

An API key (ico_live_…), sent as Authorization: Bearer <key>. Not a JWT.

Body

application/json

debtor_id

string<uuid>

A debtor of your organisation (partner keys — of your own customers). Optional; can be linked later.

customer_id

string<uuid>

Partner keys — required; the customer the claim is for. Organisation keys — optional.

partner_reference

string

Your own reference for the claim (for example your case ID). Returned on the claim and as partner_reference in every webhook event. It is never printed on a letter to the debtor.

Required string length: 1 - 255

Example:

"DOC-2026-004711"

collection_basis

enum<string>

Partner keys only. mandate for claims collected in the client's name under a collection mandate (GTC I.2f, e.g. healthcare claims): the principal is not assigned to incaseof.law; collection costs and default interest are (GTC III). Set it when you create the claim — it cannot be changed through the API afterwards. When you leave it out, the claim takes the collection basis agreed for your partner account: assignment unless your agreement provides for collection mandates. A value you send always takes precedence.

Available options:

assignment,

mandate

creditor_confirmation

object

The creditor's confirmation for this claim (GTC I.2a): the warranties for the claim are given and the debtor's data may be passed on. Both statements must be true. Optional, unless your partner agreement requires it — then a claim without it answers 400 (creditor_confirmation required) and is not created.

Show child attributes

Response

Claim created

success

boolean

Example:

true

data

object

Show child attributes

Getting Started

Webhooks

API Reference

Create claim

Authorizations

Body

Response