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",
    "case_reference": "<string>",
    "status": "open",
    "collection_stage": "new",
    "subject_matter": "<string>",
    "main_claim_currency": "EUR",
    "total_claim_amount": 123,
    "total_claim_currency": "EUR",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Claims

Create claim

Requires API token authentication. Create a new claim. The organization is determined from your API token. Financial, workflow and collection stage fields are managed automatically by the system and cannot be set from this endpoint.

Partner tokens: customer_id is required to determine the organization. Client/org tokens: customer_id is optional.

Partner program (side effect): When the request is authenticated with a partner-owned API token and customer_id refers to a partner-created customer (partner_id set) with a valid email, the first successful claim creation for that customer triggers an automatic invitation email (admin portal accept-invitation flow). Subsequent claims for the same customer do not send again. This runs asynchronously and does not affect the HTTP response or latency.

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",
    "case_reference": "<string>",
    "status": "open",
    "collection_stage": "new",
    "subject_matter": "<string>",
    "main_claim_currency": "EUR",
    "total_claim_amount": 123,
    "total_claim_currency": "EUR",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

debtor_id

string<uuid>

UUID of the debtor (optional - can be linked later after OCR processing)

customer_id

string<uuid>

Required for partner tokens. Links the claim to a customer for organization resolution and revenue sharing. Optional for client/org tokens.

Response

Claim created successfully

success

boolean

data

object

Show child attributes

Getting Started

API Reference

Create claim

Authorizations

Body

Response