Partner & Revenue Share Workflow

incaseof.law supports a commission-based partner model where external partners (e.g. law firms, brokers, referral agencies) can refer customers. When payments are collected on claims linked to a partner’s customer, revenue shares are automatically calculated based on the partner’s commission rate.

How It Works

Partner: The referral entity (e.g. a law firm) with a configured commission rate
Customer: A client brought in by a partner - automatically linked via your API key
Debtor: The person or company that owes the debt to the customer
Claim: A debt collection case - linked to a debtor and a customer via customer_id
Revenue Share: Automatically created when incaseof.law earns fees on a claim linked to a customer

Step 1: Create a Partner

Partners are created by organization admins via the Admin Dashboard (Settings → Partners) or via the API. Partners are created internally by incaseof.law. If you are interested in becoming a partner, contact us at [email protected]. Once confirmed, you will receive an API key to start integrating.

Step 2: Create a Customer

Create a customer. The customer is automatically linked to your partner account via your API key. Send your own ID for the business as partner_client_reference and its VAT ID as uid on every case. If your partner account already has a customer with that reference or UID, the API returns it instead of creating a new one — see Reusing an existing customer.

cURL
JavaScript
Python

curl -X POST 'https://service.incaseof.law/openapi/customers' \
  -H 'Authorization: Bearer YOUR_API_TOKEN_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Acme Corporation",
    "email": "[email protected]",
    "partner_client_reference": "ACME-001",
    "uid": "ATU12345678",
    "phone": "+43 1 234 5678",
    "address": {
      "street": "Ringstrasse 10",
      "city": "Wien",
      "zip": "1010",
      "country": "AT"
    }
  }'

const response = await fetch('https://service.incaseof.law/openapi/customers', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN_HERE',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Acme Corporation',
    email: '[email protected]',
    partner_client_reference: 'ACME-001',
    uid: 'ATU12345678',
    phone: '+43 1 234 5678',
    address: {
      street: 'Ringstrasse 10',
      city: 'Wien',
      zip: '1010',
      country: 'AT'
    }
  })
})

const data = await response.json()
const customerId = data.data.id
console.log(data.reused ? 'Existing customer reused:' : 'Customer created:', customerId)

import requests

url = 'https://service.incaseof.law/openapi/customers'
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN_HERE',
    'Content-Type': 'application/json'
}

payload = {
    'name': 'Acme Corporation',
    'email': '[email protected]',
    'partner_client_reference': 'ACME-001',
    'uid': 'ATU12345678',
    'phone': '+43 1 234 5678',
    'address': {
        'street': 'Ringstrasse 10',
        'city': 'Wien',
        'zip': '1010',
        'country': 'AT'
    }
}

response = requests.post(url, json=payload, headers=headers)
customer = response.json()
customer_id = customer['data']['id']
print(f"{'Existing customer reused' if customer['reused'] else 'Customer created'}: {customer_id}")

Save the customer ID: You will need the id from the response to link claims to this customer.

Customer Fields

Field	Type	Required	Description
`name`	string	Yes	Customer name (1-255 chars)
`email`	string	Yes	Customer email
`phone`	string	No	Phone number (max 50 chars)
`address`	object	No	Address with `street`, `city`, `zip`, `country`
`metadata`	object	No	Arbitrary key-value data
`partner_client_reference`	string	No	Your own ID for this business (max 255 chars, trimmed, case-sensitive). Unique within your partner account
`uid`	string	No	EU VAT ID, e.g. `ATU12345678`. Spaces and the separators `-` `.` `/` are removed and letters uppercased; it must then be a 2-letter country code plus 2–12 characters, otherwise 400. Unique within your partner account

Reusing an existing customer

Each business you work for should be one customer. Before creating, the API looks for a customer of your partner account — first by partner_client_reference, then by uid:

Result	HTTP	`reused`	What happens
Match	`200`	`true`	The existing customer is returned (same `id` and `organization_id`). Name, email and address are not changed — use `PATCH /openapi/customers/{id}` for that. A key the customer does not have yet is added to it.
No match	`201`	`false`	A new customer is created.
Reference matches one customer, UID another	`409`	—	Nothing is created. Correct the reference or the UID.

null for either key is treated as not given. Without partner_client_reference and uid, every call creates a new customer — store the returned id yourself in that case.
Customers created before you sent these keys can be linked with PATCH /openapi/customers/{id} ({"partner_client_reference": "ACME-001", "uid": "ATU12345678"}); a key already used by another of your customers returns 409.
The keys are scoped to your partner account: another partner sending the same UID gets its own customer.
The customer’s onboarding invitation is sent once, with the first claim filed for that customer — reusing the customer does not send it again.

Step 3: Create a Debtor

Create the debtor (person or company) that owes the debt to your customer. You must include the customer_id so the system knows which organization this debtor belongs to.

cURL

curl -X POST 'https://service.incaseof.law/openapi/debtors' \
  -H 'Authorization: Bearer YOUR_API_TOKEN_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "customer_id": "CUSTOMER_ID",
    "acting_as": "person",
    "debtor_type": "privateperson",
    "person": {
      "salutation": "mr",
      "first_name": "Max",
      "last_name": "Mustermann"
    },
    "addresses": [{
      "street": "Hauptstrasse 1",
      "zip": "1010",
      "city": "Wien",
      "country": "AT",
      "is_primary": true
    }],
    "communication_channels": [{
      "type": "email",
      "value": "[email protected]",
      "is_primary": true
    }]
  }'

Save the debtor ID: You will need the id from the response when creating the claim.

Step 4: Create a Claim with Customer ID

When creating a claim, pass the customer_id to link it to a partner’s customer. This enables automatic revenue share tracking.

cURL
JavaScript
Python

curl -X POST 'https://service.incaseof.law/openapi/claims' \
  -H 'Authorization: Bearer YOUR_API_TOKEN_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "debtor_id": "DEBTOR_ID",
    "customer_id": "CUSTOMER_ID"
  }'

const response = await fetch('https://service.incaseof.law/openapi/claims', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN_HERE',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    debtor_id: 'DEBTOR_ID',
    customer_id: 'CUSTOMER_ID'
  })
})

const data = await response.json()
const claimId = data.data.id
console.log('Claim created with customer link:', claimId)

import requests

url = 'https://service.incaseof.law/openapi/claims'
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN_HERE',
    'Content-Type': 'application/json'
}

payload = {
    'debtor_id': 'DEBTOR_ID',
    'customer_id': 'CUSTOMER_ID'
}

response = requests.post(url, json=payload, headers=headers)
claim = response.json()
claim_id = claim['data']['id']
print(f'Claim created: {claim_id}')

The customer_id is required for partner API tokens. It tells the system which organization this claim belongs to. Without it, the request will fail. You can update the customer_id on an existing claim via the update endpoint.

Step 4b: Decide on the court step

When out-of-court collection is exhausted, the claim moves to dunning_action_recommended (you receive the webhook claim.collection_stage_changed). The creditor decides whether to take the claim to court — through your integration:

GET /openapi/claims/{claim_id}/lawsuit-decision/estimate — the court fee, and whether a lawyer is required (Austria) or not allowed (Germany). decision_open is true while a decision can still be sent; once one is recorded (by you or by the creditor in the portal) it turns false and decided turns true.
POST /openapi/claims/{claim_id}/lawsuit-decision with { "decision": "sue" } or { "decision": "decline" }.

The court fee is invoiced to the creditor, at the e-mail address and postal address of the customer you created in Step 2 — keep them current. It is never invoiced to you as the partner. When incaseof.law earns fees on a claim linked to a customer, the system automatically calculates the partner’s commission based on those fees - not the payment amount. No additional API calls are needed - revenue shares are created automatically.

Status	Description
`pending`	Commission calculated, awaiting payout
`paid`	Commission has been paid to the partner
`cancelled`	Commission was cancelled (e.g. payment reversed)

Complete Partner Workflow Example

JavaScript
Python

const API_BASE = 'https://service.incaseof.law/openapi'
const API_TOKEN = 'YOUR_API_TOKEN_HERE'

const headers = {
  'Authorization': `Bearer ${API_TOKEN}`,
  'Content-Type': 'application/json'
}

async function partnerWorkflow() {
  // Step 1: Create a customer (automatically linked to your partner via API key)
  const customerRes = await fetch(`${API_BASE}/customers`, {
    method: 'POST',
    headers,
    body: JSON.stringify({
      name: 'Acme Corporation',
      email: '[email protected]'
    })
  })
  const customer = await customerRes.json()
  const customerId = customer.data.id
  console.log('Customer created:', customerId)

  // Step 2: Create a debtor (customer_id required for partner tokens)
  const debtorRes = await fetch(`${API_BASE}/debtors`, {
    method: 'POST',
    headers,
    body: JSON.stringify({
      customer_id: customerId,
      acting_as: 'person',
      debtor_type: 'privateperson',
      person: {
        salutation: 'mr',
        first_name: 'Max',
        last_name: 'Mustermann'
      },
      addresses: [{
        street: 'Hauptstrasse 1',
        zip: '1010',
        city: 'Wien',
        country: 'AT',
        is_primary: true
      }],
      communication_channels: [{
        type: 'email',
        value: '[email protected]',
        is_primary: true
      }]
    })
  })
  const debtor = await debtorRes.json()
  const debtorId = debtor.data.id
  console.log('Debtor created:', debtorId)

  // Step 3: Create a claim linked to the customer and debtor
  const claimRes = await fetch(`${API_BASE}/claims`, {
    method: 'POST',
    headers,
    body: JSON.stringify({
      debtor_id: debtorId,
      customer_id: customerId
    })
  })
  const claim = await claimRes.json()
  console.log('Claim created:', claim.data.id)

  // Step 4: Upload invoice and record payments as usual
  // Revenue shares will be automatically created when payments are recorded

  return {
    customerId,
    debtorId,
    claimId: claim.data.id
  }
}

partnerWorkflow()

import requests

API_BASE = 'https://service.incaseof.law/openapi'
API_TOKEN = 'YOUR_API_TOKEN_HERE'

headers = {
    'Authorization': f'Bearer {API_TOKEN}',
    'Content-Type': 'application/json'
}

def partner_workflow():
    # Step 1: Create a customer (automatically linked to your partner via API key)
    customer_res = requests.post(f'{API_BASE}/customers', headers=headers, json={
        'name': 'Acme Corporation',
        'email': '[email protected]'
    })
    customer_id = customer_res.json()['data']['id']
    print(f'Customer created: {customer_id}')

    # Step 2: Create a debtor (customer_id required for partner tokens)
    debtor_res = requests.post(f'{API_BASE}/debtors', headers=headers, json={
        'customer_id': customer_id,
        'acting_as': 'person',
        'debtor_type': 'privateperson',
        'person': {
            'salutation': 'mr',
            'first_name': 'Max',
            'last_name': 'Mustermann'
        },
        'addresses': [{
            'street': 'Hauptstrasse 1',
            'zip': '1010',
            'city': 'Wien',
            'country': 'AT',
            'is_primary': True
        }],
        'communication_channels': [{
            'type': 'email',
            'value': '[email protected]',
            'is_primary': True
        }]
    })
    debtor_id = debtor_res.json()['data']['id']
    print(f'Debtor created: {debtor_id}')

    # Step 3: Create a claim linked to the customer and debtor
    claim_res = requests.post(f'{API_BASE}/claims', headers=headers, json={
        'debtor_id': debtor_id,
        'customer_id': customer_id
    })
    claim_id = claim_res.json()['data']['id']
    print(f'Claim created: {claim_id}')

    # Step 4: Upload invoices and record payments as usual
    # Revenue shares are automatically created when payments are recorded

    return {
        'customer_id': customer_id,
        'debtor_id': debtor_id,
        'claim_id': claim_id
    }

partner_workflow()

Managing Customers

List Customers

cURL

curl -X GET 'https://service.incaseof.law/openapi/customers' \
  -H 'Authorization: Bearer YOUR_API_TOKEN_HERE'

Update a Customer

cURL

curl -X PATCH 'https://service.incaseof.law/openapi/customers/CUSTOMER_ID' \
  -H 'Authorization: Bearer YOUR_API_TOKEN_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Name",
    "email": "[email protected]"
  }'

Delete a Customer

cURL

curl -X DELETE 'https://service.incaseof.law/openapi/customers/CUSTOMER_ID' \
  -H 'Authorization: Bearer YOUR_API_TOKEN_HERE'

Next Steps

Use the Customer API to create customers
Link claims to customers using customer_id when creating claims
Revenue shares are tracked automatically

Need help? Contact us at [email protected]

Getting Started

Webhooks

API Reference

How It Works

Step 1: Create a Partner

Step 2: Create a Customer

Customer Fields

Reusing an existing customer

Step 3: Create a Debtor

Step 4: Create a Claim with Customer ID

Step 4b: Decide on the court step

Complete Partner Workflow Example

Managing Customers

List Customers

Update a Customer

Delete a Customer

Next Steps

​How It Works

​Step 1: Create a Partner

​Step 2: Create a Customer

​Customer Fields

​Reusing an existing customer

​Step 3: Create a Debtor

​Step 4: Create a Claim with Customer ID

​Step 4b: Decide on the court step

​Step 5: Automatic Revenue Sharing

​Revenue Share Statuses

​Complete Partner Workflow Example

​Managing Customers

​List Customers

​Update a Customer

​Delete a Customer

​Next Steps

How It Works

Step 1: Create a Partner

Step 2: Create a Customer

Customer Fields

Reusing an existing customer

Step 3: Create a Debtor

Step 4: Create a Claim with Customer ID

Step 4b: Decide on the court step

Step 5: Automatic Revenue Sharing

Revenue Share Statuses

Complete Partner Workflow Example

Managing Customers

List Customers

Update a Customer

Delete a Customer

Next Steps