API-Dokumentation

Übersicht

Die API nutzt HTTPS-Methoden und RESTful Endpoints, um Ressourcen im System zu erstellen, zu bearbeiten und zu verwalten. Als Austauschformat dient JSON.

Erste Schritte

Diese API bietet umfassenden Zugriff auf zentrale Funktionen. Ob Integrationen, Automatisierung oder eigene Anwendungen – die API liefert Flexibilität für die Anbindung von Claimity an Ihre Systeme.

Erweiterung der Schnittstellen

•Prüfen Sie regelmässig das Änderungsprotokoll um auf dem Laufenden zu bleiben.
•Inkompatible Änderungen werden vorab angekündigt.
•Über wesentliche Änderungen werden Sie rechtzeitig informiert.

Erste Schritte

So starten Sie mit der API:

1

Schlüsselpaar erstellen

Als Organisationsadmin können Sie in den Organisationseinstellungen Ihres Claimity Kontos ein Schlüsselpaar erstellen. Laden Sie darauffolgend den Private Key herunter und bewahren Sie diesen sicher auf.

2

Authentifizieren

Mit Hilfe des erstellten Schlüsselpaars und Ihrer Client‑ID können Sie sich gegenüber der Claimity API authentifizieren und so einen Access Token für Ihre Requests erhalten.

3

DPoP-Header vorbereiten

Zum Senden einer Anfrage an die API ist es notwendig, einen DPoP-Header zu erstellen. Dieser Header wird mit dem Private Key signiert und sichert die Anfrage gegen potenzielle Sicherheitsrisiken.

4

Erste Anfrage

Senden Sie mit Ihrem Access Token und dem DPoP-Header eine authentifizierte Anfrage an einen Endpoint.

Beispiel‑Request

curl -X GET \
  https://app.claimity.ch/v1/experts/cases \
  -H 'Accept: application/json' \
  -H 'Authorization: DPoP {access-token}' \
  -H 'DPoP: {dpop-header}'

Python Notebooks

Für den schnellen Einstieg stellen wir Ihnen Python‑Notebooks zur Verfügung, mit denen Sie API‑Abfragen ausführen und die Responses direkt einsehen können.

Notebooks auf GitHub ansehen

Problem melden

Wenn Sie auf einen Fehler gestossen sind, helfen wir weiter. Stellen Sie vorab sicher, dass das Problem reproduzierbar ist.

Vor dem Melden

✓Reproduzierbarkeit prüfen
✓API‑Tests mit Postman/Insomnia durchführen
✓Details zu Request und Response sammeln
✗Keine Zugangsdaten im Report mitschicken

Report einreichen

Bitte beschreiben Sie Schritte zur Reproduktion. Unser Support prüft den Fall zeitnah und meldet sich schnellstmöglich bei Ihnen.

Problem melden

Hinweis: Die API wird auf Basis dieser Dokumentation bereitgestellt. Es gibt keine geführte Implementierung oder Code‑Support.

Änderungsprotokoll

Alle Änderungen und Updates der aktuellen API‑Version im Überblick.

2026-10-07

Neu: Beträge am Fall. Claims (Versicherer) und Fälle (Experten) liefern in Liste und Details CostEstimateAmount (Kostenvoranschlag), ApprovedAmount (durch das Gutachten freigegebener Betrag) und SavingsAmount (Einsparung = Kostenvoranschlag − freigegebener Betrag, nur wenn positiv) – alle in CHF, null = nicht erfasst. Experten setzen die Beträge über PUT /v1/experts/cases/{caseId}/amounts (204). Eine Änderung der Beträge verschiebt LastChangedAt. Die Erweiterung ist rückwärtskompatibel.

2026-08-02

Sync-Filter überarbeitet: updatedSince heisst neu lastChangedSince (beide Endpunkte /v1/insurers/claims und /v1/experts/cases) — der Filter trägt damit den Namen des Feldes, das er filtert (LastChangedAt). Neu: lastReportApprovedSince auf /v1/insurers/claims liefert nur Claims, deren letzte Report-Genehmigung am/nach dem angegebenen Zeitpunkt liegt (Claims ohne genehmigten Report matchen nie). completedFrom/completedTo bleiben unverändert und filtern den Zeitpunkt des jüngsten Fallabschlusses.

2026-07-15

Experten-API: neuer Endpunkt zum Wiedereröffnen eines abgeschlossenen Falls (POST /v1/experts/cases/{caseId}:reopen, liefert 204). List-Endpoints um Filter (Freitextsuche q, Datumsbereiche für Erstellung/Abschluss) und einen updatedSince-Cursor für inkrementelle Synchronisierung erweitert. Fälle liefern nun LastChangedAt; Claims zusätzlich LastReportApprovedAt. Create- und Upload-Endpoints liefern nun 201 Created. Jede Antwort liefert nun einen X-Correlation-Id-Header (ein gültiger eingehender Wert wird zurückgegeben) für Ende-zu-Ende-Tracing; bei Fehlern ist er zugleich die ProblemDetails-instance.

2026-06-09

Neue Kategorie „Spezialexpertisen“ inklusive Schema und Payload-Struktur ergänzt.

2025-12-30

Ergänzung eines neuen Endpunkts zur Versicherer-API zum Validieren der Fallstruktur.

2025-12-28

Erste API‑Version veröffentlicht.

Authentifizierung

Die Claimity Partner API nutzt OAuth 2.0 Client Credentials mit JWT Client Assertion (RS256) und sichert jede Anfrage zusätzlich mit DPoP Proof-of-Possession (ES256). Der Access Token ist an Ihren DPoP-Schlüssel gebunden (cnf.jkt): Verwenden Sie einen Schlüsselfür die gesamte Session — den Token-Request und jeden API-Aufruf — und signieren Sie bereits den Token-Request mit einem DPoP-Proof.

Authentication Flow

So funktioniert der OAuth2 Client-Credentials Flow.

Ablauf

Key Pair: Organisation erstellt RSA Key Pair in Claimity (Private Key wird sicher gespeichert).
JWT Client Assertion: Client erzeugt ein kurzlebiges JWT (RS256).
Token Request: Client sendet POST /v1/oauth/token (Client-Credentials + Assertion) mit einem DPoP-Proof, der den ausgestellten Token an den DPoP-Schlüssel bindet.
Validierung: Auth-Server prüft Signatur der Assertion und die Berechtigungen und liefert Token-Response.
Abfrage-URL: Der Client erstellt die Abfrage-URL (inkl. Query-Parameter).
DPoP Proof: Client erstellt pro Request ein DPoP-JWT (ES256) gebunden an Methode + URL, signiert mit demselben Schlüssel wie beim Token-Request.
API Call: Client ruft Endpunkt auf mit Authorization: DPoP access_token und DPoP: ….
Response: API prüft Token/DPoP und verarbeitet die Anfrage / liefert die Response.

Access Token auslesen

Für Partner-Integrationen authentifiziert sich Ihre Organisation über eine signierte JWT Client Assertion.

Voraussetzungen

•Client ID (z. B. org-expo-00001) auslesbar aus den Claimity Organisationseinstellungen
•Private RSA Key aus den Claimity Organisationseinstellungen (sicher aufbewahren und niemals teilen)

Token Endpoint

URL	POST https://app.claimity.ch/v1/oauth/token
Content-Type	application/x-www-form-urlencoded
Form Fields	grant_type = client_credentials client_id = <Ihre client id> client_assertion_type = urn:ietf:params:oauth:client-assertion-type:jwt-bearer client_assertion = <JWT (RS256)> scope (optional)

URL

POST https://app.claimity.ch/v1/oauth/token

Content-Type

application/x-www-form-urlencoded

Form Fields

grant_type = client_credentials

client_id = <Ihre client id>

client_assertion_type = urn:ietf:params:oauth:client-assertion-type:jwt-bearer

client_assertion = <JWT (RS256)>

scope (optional)

JWT Client Assertion (RS256)

Die Assertion ist ein kurzlebiges JWT (10 Minuten) und wird mit Ihrem RSA Private Key signiert.

•iss/sub = client_id
•aud = https://app.claimity.ch/realms/claimity/protocol/openid-connect/token
•jti = UUID (einzigartig)
•iat/exp = “now” / “now+600s” (10 min)
•kid (optional)

Beispiel: Token Request (cURL, Platzhalter)

curl -X POST \
  'https://app.claimity.ch/v1/oauth/token' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'grant_type=client_credentials' \
  -d 'client_id=org-expo-00001' \
  -d 'client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer' \
  -d 'client_assertion=<RS256-JWT-CLIENT-ASSERTION>' \
  -d 'scope=roles'

Token Response

Die Response enthält ein access_token. Wichtig: Für API-Aufrufe wird dieser Token als DPoP Token verwendet.

API Requests senden

Jede Anfrage benötigt zusätzlich einen DPoP Proof JWT. Pro Request wird ein neuer Proof erzeugt und signiert (ES256), um die Anfrage an Methode + URL zu binden — jedoch stets mit demselben Schlüssel, an den der Access Token gebunden ist (cnf.jkt). Ein mit einem anderen Schlüssel signierter Proof wird mit 401 "Access token is not bound to the DPoP proof key" abgelehnt.

Erforderliche Headers

Authorization	DPoP {access_token}
DPoP	{dpop_proof_jwt}
Accept	application/json
Content-Type	application/json

Authorization

DPoP {access_token}

DPoP

{dpop_proof_jwt}

Accept

application/json

Content-Type

application/json

DPoP Proof Inhalt

•htu muss die exakte URL inkl. Query-String sein
•htm muss exakt der HTTP-Methode entsprechen (GET/POST/PUT/DELETE)
•jti muss pro Request neu sein (keine Replays)
•iat muss innerhalb des erlaubten Zeitfensters liegen (Clock-Skew vermeiden)
•ath = base64url(SHA-256(access_token))

Beispiel: Authentifizierter API Call (cURL)

curl -X GET \
  'https://app.claimity.ch/v1/experts/cases?page=1&size=50' \
  -H 'Accept: application/json' \
  -H 'Authorization: DPoP {access_token}' \
  -H 'DPoP: {dpop_proof_jwt}'

Troubleshooting: 401 invalid_dpop

Häufige Ursachen:

•not bound: Request mit einem anderen Schlüssel als der Token signiert — denselben Session-Schlüssel wiederverwenden und den Token-Request mit einem DPoP-Proof versehen
•htu mismatch: URL muss exakt inkl. Query sein
•htm mismatch: Methode muss passen
•iat ausserhalb des Fensters: Systemzeit korrigieren
•replay: jti muss pro Request neu sein
•ath mismatch: SHA-256(access_token) base64url

Correlation-ID

Jede Antwort liefert einen X-Correlation-Id-Header zurück. Claimity verwendet dieselbe ID in seinen Server-Logs und bei Fehlern als instance-Feld des application/problem+json-Bodys — protokollieren Sie sie und geben Sie sie bei Support-Anfragen an.

Sie können auch eine eigene ID mitgeben, um eine Anfrage Ende-zu-Ende zu verfolgen: Senden Sie einen X-Correlation-Id-Request-Header mit einem kurzen, druckbaren Token (≤ 80 Zeichen). Ein gültiger Wert wird unverändert zurückgegeben; ein ungültiger oder zu langer wird ignoriert und Claimity erzeugt eine eigene ID. Die Correlation-ID ist unabhängig von DPoP (der Proof bindet nur Methode + URL), das Hinzufügen dieses Headers beeinflusst die Signatur also nicht.

API‑Grundlagen

Zentrale Konzepte und Konventionen, die in der gesamten API genutzt werden.

Request‑Format

Jeder Request besteht aus Methode, URL, optionalen Query‑Parametern, Headers und (bei POST/PUT) einem JSON‑Body.

URL‑Aufbau

Base URL: https://app.claimity.ch

Path: /v1/<resource>

Query: z. B. ?page=1&size=50

Beispiel‑URL

https://app.claimity.ch/v1/…?page=1&size=50

HTTP‑Methoden

GETRessourcen abrufen

POSTRessourcen erstellen

PUTRessourcen ersetzen/aktualisieren

DELETERessourcen löschen

Typische Headers

•Accept: application/json
•Content-Type: application/json (bei JSON‑Body)
•Authorization: DPoP <access_token>
•DPoP: <dpop_proof_jwt>

Response‑Format

Responses sind grundsätzlich JSON (Content-Type: application/json) und verwenden HTTP‑Statuscodes, um Erfolg/Fehler zu signalisieren.

Erfolgs‑Responses

•2xx (z. B. 200, 201, 204)
•Body enthält in der Regel ein Objekt oder eine Liste

Beispiel (Objekt)

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "…",
  "…": "…"
}

Fehler‑Responses (ProblemDetails)

•4xx/5xx (z. B. 400, 401, 403, 404, 429, 500)
•Body folgt einer ProblemDetails‑ähnlichen Struktur

Beispiel (Problem‑JSON)

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "…"
}

Rate Limiting

Die Partner-API ist durch Rate Limiting geschützt, um faire Nutzung und Stabilität sicherzustellen. Limits werden pro Client-Partition angewendet.

Anonyme Validierung

POST /v1/insurers/claims:validate ist ohne Token nutzbar und daher strenger limitiert.

•FixedWindow: 10 Requests/Minute pro Client/IP

Standard für die Partner-API

Für Standard-Endpunkte wird die Anzahl an Abfragen leicht limitiert.

•TokenBucket: ca. 60 Requests/Minute, Burst bis 20, Queue 0

Dokument-Routen

Für Endpunkte mit .../documents... gelten strengere Limits (z. B. für Upload/Download).

•TokenBucket: ca. 20 Requests/Minute, Burst bis 10, Queue 0

Token-Endpunkt

Der Token-Endpunkt ist streng limitiert um mögliche Attacken zu verhindern.

•Fixed Window: 10 Requests/Minute je Client

Wenn ein Limit erreicht wird (HTTP 429)

•Response: 429 Too Many Requests (Rejection Code 429)
•Optionaler Header: Retry-After
•Diagnose/Policy-Hinweis: X-RateLimit-Policy
•Body: Problem-JSON

Empfehlungen für Clients

•Bei 429 Requests mit Backoff wiederholen und Retry-After beachten.
•Dokument-Uploads/Downloads throttlen.
•Bursts sind begrenzt (kein Queueing) – bei hoher Parallelität kommt es schneller zu 429.

Idempotenz (Idempotency-Key)

POST-Requests können den Header Idempotency-Key tragen (frei gewählter, eindeutiger Wert, z. B. eine UUID). Wird derselbe Request wiederholt — etwa nach einem Timeout — liefert die API die gespeicherte Antwort erneut, ohne den Vorgang ein zweites Mal auszuführen.

•Der Schlüssel ist an Methode, Pfad, Client und Payload-Hash gebunden — derselbe Key mit anderem Payload zählt als neuer Request.
•Gespeicherte Antworten werden 24 Stunden für Replay vorgehalten.
•Request-Bodies über 16 MB umgehen die Idempotenz; Antworten über 16 MB werden nicht für Replay gespeichert (ein Retry führt den Vorgang erneut aus).
•Empfehlung: bei POST /v1/insurers/claims immer setzen — so ist ein Retry nach Netzwerkfehlern garantiert frei von Doppelanlagen.

Fehlerkatalog

Fehler folgen der ProblemDetails-Struktur (title, status, detail). Payload-Validierungsfehler kommen als ValidationProblemDetails mit einer errors-Map; jede Meldung nennt den Feldpfad und die konkrete Erwartung.

title	Bedeutung
invalid_org_context	Das Token ist keiner (eindeutigen) Organisation des erwarteten Typs zugeordnet.
forbidden	Zugriff auf die Ressource ist mit diesem Token nicht erlaubt.
org_without_members	Die Organisation hat keine Mitglieder — Anlage/Abruf nicht möglich.
invalid_category	Unbekannte Fallkategorie (erlaubt: vehicle, appraiser, fraud, special).
invalid_payload	PayloadJson fehlt oder ist kein gültiges JSON.
invalid_state	Die Aktion ist im aktuellen Fallstatus nicht erlaubt (z. B. Reopen eines nicht abgeschlossenen Falls).
invalid_document / missing_documents	Dokument ungültig bzw. erforderliche Dokumente fehlen.
unsupported_content_type / size_limit_exceeded	Dateityp nicht erlaubt bzw. Upload-Limit überschritten.
upstream_timeout / upstream_error	Ein nachgelagerter Dienst hat nicht (rechtzeitig) geantwortet — Retry mit Backoff.

Beispiel: 400 bei der Payload-Validierung (POST /v1/insurers/claims:validate)

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json

{
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "PayloadJson": [
      "PayloadJson does not match the required schema for the selected category.",
      "counterparty.email: is required.",
      "workshop.country: must be one of: CH, DE, AT, FR, IT, LI.",
      "incidentDate: the incident date cannot be in the future — got 2099-01-15, today is 2026-08-02 (Europe/Zurich)."
    ]
  }
}

Experten

Endpoints für Experten zum Arbeiten mit Fällen, Dokumenten und Gutachten-/Report-Submissions.

Zeitstempel & inkrementelle Synchronisierung

Zeitstempel und Sync-Filter (inklusiv >=), benannt nach dem Feld, das sie filtern:

CreatedAt — Erstellzeitpunkt des Claims. Filter: createdFrom / createdTo.
completedFrom / completedTo filtern auf den Zeitpunkt des jüngsten Fallabschlusses (Finalized-Ereignis; bei wiedereröffneten Fällen zählt der neueste Abschluss). Gedacht für Auswertungszeiträume («alle im Q2 abgeschlossenen Fälle») — nicht für Synchronisierung.
LastChangedAt — Letzte partnerrelevante Änderung (Status, Dokumente, Reports, Kommentare, Beträge). Filter: lastChangedSince.

Fälle

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Query-Parameter

Name	Typ	Default
status	string
category	string
page	integer (int32)	1
size	integer (int32)	50
inspectionType	string
q	string
createdFrom	string (date-time)
createdTo	string (date-time)
completedFrom	string (date-time)
completedTo	string (date-time)
lastChangedSince	string (date-time)

Response Schema

Typ: object

Feld	Typ	Nullable
Total	integer(int32)
Page	integer(int32)
Size	integer(int32)
Items	array<M2MCaseListItemDto>	✓

Beispiel-Response

{
  "Total": 0,
  "Page": 0,
  "Size": 0,
  "Items": [
    {
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ExternalKey": "string",
      "Category": "vehicle",
      "Status": "Created",
      "CreatedAt": "2025-12-31T12:00:00Z",
      "UpdatedAt": "2025-12-31T12:00:00Z",
      "ExpertComment": "string",
      "PayloadJson": "string",
      "ArchiveState": false,
      "Insurer": {
        "Name": "string",
        "Responsible": {
          "Name": "string",
          "Email": "string",
          "Phone": "string"
        }
      },
      "HailDriveInAccepted": false,
      "LastChangedAt": "2025-12-31T12:00:00Z",
      "CostEstimateAmount": 0,
      "ApprovedAmount": 0,
      "SavingsAmount": 0
    }
  ]
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
caseId	string (uuid)	✓

Response Schema

Typ: object

Feld	Typ	Nullable	Enum
Id	string(uuid)
ExternalKey	string	✓
Category	string	✓	vehiclefraudappraiserspecial
Status	string	✓	CreatedAssignedRejectedAcceptedInProgressExpertCompletedAdminApprovedAdminReturnedAdminCancelledFinal
CreatedAt	string(date-time)
UpdatedAt	string(date-time)
ExpertComment	string	✓
PayloadJson	string	✓
ArchiveState	boolean
Insurer	M2MInsurerDto
HailDriveInAccepted	boolean	✓
LastChangedAt Partner-sync cursor. Advances on every partner-visible change to the case (report approval, document upload, expert comment, status change). On the next poll, pass the highest value you have seen as the `lastChangedSince` query parameter to fetch only what changed since.	string(date-time)
CostEstimateAmount Workshop cost estimate in CHF (null = not entered yet). Set by the expert via PUT /v1/experts/cases/{caseId}/amounts.	number(double)	✓
ApprovedAmount Amount approved by the expert report in CHF (null = not entered yet).	number(double)	✓
SavingsAmount Savings in CHF = CostEstimateAmount - ApprovedAmount; only when both are set and the estimate is higher, otherwise null.	number(double)	✓

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ExternalKey": "string",
  "Category": "vehicle",
  "Status": "Created",
  "CreatedAt": "2025-12-31T12:00:00Z",
  "UpdatedAt": "2025-12-31T12:00:00Z",
  "ExpertComment": "string",
  "PayloadJson": "string",
  "ArchiveState": false,
  "Insurer": {
    "Name": "string",
    "Responsible": {
      "Name": "string",
      "Email": "string",
      "Phone": "string"
    }
  },
  "HailDriveInAccepted": false,
  "LastChangedAt": "2025-12-31T12:00:00Z",
  "CostEstimateAmount": 0,
  "ApprovedAmount": 0,
  "SavingsAmount": 0
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Content-Typeapplication/json

Path-Parameter

Name	Typ	Required	Default
caseId	string (uuid)	✓

Request Body

Request Schema

Typ: object

Feld	Typ	Required	Nullable	Enum
Text	string		✓

Beispiel-Body

{
  "Text": "string"
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Content-Typeapplication/json

Path-Parameter

Name	Typ	Required	Default
caseId	string (uuid)	✓

Request Body

Request Schema

Typ: object

Feld	Typ	Required	Nullable	Enum
CostEstimateAmount Workshop cost estimate in CHF (>= 0, max. 2 decimals); null clears it.	number(double)		✓
ApprovedAmount Amount approved by the expert report in CHF (>= 0, max. 2 decimals); null clears it.	number(double)		✓

Beispiel-Body

{
  "CostEstimateAmount": 0,
  "ApprovedAmount": 0
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Content-Typeapplication/json

Path-Parameter

Name	Typ	Required	Default
caseId	string (uuid)	✓

Request Body

Request Schema

Typ: object

Feld	Typ	Required	Nullable	Enum
Reason Required reason for reopening the finalized case; recorded on the audited reopened_by_expert event.	string		✓

Beispiel-Body

{
  "Reason": "string"
}

Falldokumente

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
caseId	string (uuid)	✓

Query-Parameter

Name	Typ	Required	Default
page	integer (int32)		1
size	integer (int32)		50

Response Schema

Typ: object

Feld	Typ	Nullable
Total	integer(int32)
Page	integer(int32)
Size	integer(int32)
Items	array<M2MExpertDocumentDto>	✓

Beispiel-Response

{
  "Total": 0,
  "Page": 0,
  "Size": 0,
  "Items": [
    {
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "FileName": "string",
      "ContentType": "string",
      "SizeBytes": 0,
      "CreatedAt": "2025-12-31T12:00:00Z"
    }
  ]
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
caseId	string (uuid)	✓
documentId	string (uuid)	✓

Response Schema

Typ: object

Feld	Typ	Nullable
Id	string(uuid)
FileName	string	✓
ContentType	string	✓
SizeBytes	integer(int64)
CreatedAt	string(date-time)
ContentBase64	string	✓

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "FileName": "string",
  "ContentType": "string",
  "SizeBytes": 0,
  "CreatedAt": "2025-12-31T12:00:00Z",
  "ContentBase64": "string"
}

Reports & Submissions

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Content-Typeapplication/json

Path-Parameter

Name	Typ	Required	Default
caseId	string (uuid)	✓

Request Body

Request Schema

Typ: object

Feld	Typ	Required	Nullable	Enum
Comment	string		✓

Beispiel-Body

{
  "Comment": "string"
}

Response Schema

Typ: object

Feld	Typ	Nullable	Enum
Id	string(uuid)
ClaimId	string(uuid)
SequenceNo	integer(int32)
Status	string	✓	DraftSubmittedApprovedReturnedCancelled
Comment	string	✓
SubmittedAt	string(date-time)	✓
CreatedAt	string(date-time)
UpdatedAt	string(date-time)

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ClaimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "SequenceNo": 0,
  "Status": "Draft",
  "Comment": "string",
  "SubmittedAt": "2025-12-31T12:00:00Z",
  "CreatedAt": "2025-12-31T12:00:00Z",
  "UpdatedAt": "2025-12-31T12:00:00Z"
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Content-Typeapplication/json

Path-Parameter

Name	Typ	Required	Default
caseId	string (uuid)	✓

Request Body

Request Schema

Typ: object

Feld	Typ	Required	Nullable	Enum
Comment	string		✓

Beispiel-Body

{
  "Comment": "string"
}

Response Schema

Typ: object

Feld	Typ	Nullable	Enum
Id	string(uuid)
ClaimId	string(uuid)
SequenceNo	integer(int32)
Status	string	✓	DraftSubmittedApprovedReturnedCancelled
Comment	string	✓
SubmittedAt	string(date-time)	✓
CreatedAt	string(date-time)
UpdatedAt	string(date-time)

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ClaimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "SequenceNo": 0,
  "Status": "Draft",
  "Comment": "string",
  "SubmittedAt": "2025-12-31T12:00:00Z",
  "CreatedAt": "2025-12-31T12:00:00Z",
  "UpdatedAt": "2025-12-31T12:00:00Z"
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
caseId	string (uuid)	✓

Query-Parameter

Name	Typ	Required	Default
page	integer (int32)		1
size	integer (int32)		50

Response Schema

Typ: object

Feld	Typ	Nullable
Total	integer(int32)
Page	integer(int32)
Size	integer(int32)
Items	array<M2MReportListItemDto>	✓

Beispiel-Response

{
  "Total": 0,
  "Page": 0,
  "Size": 0,
  "Items": [
    {
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ClaimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "SequenceNo": 0,
      "RevisionNo": 0,
      "Status": "Draft",
      "Comment": "string",
      "SubmittedAt": "2025-12-31T12:00:00Z",
      "CreatedAt": "2025-12-31T12:00:00Z",
      "UpdatedAt": "2025-12-31T12:00:00Z"
    }
  ]
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
caseId	string (uuid)	✓
submissionId	string (uuid)	✓

Response Schema

Typ: object

Feld	Typ	Nullable	Enum
Id	string(uuid)
ClaimId	string(uuid)
SequenceNo	integer(int32)
Status	string	✓	DraftSubmittedApprovedReturnedCancelled
Comment	string	✓
SubmittedAt	string(date-time)	✓
CreatedAt	string(date-time)
UpdatedAt	string(date-time)

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ClaimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "SequenceNo": 0,
  "Status": "Draft",
  "Comment": "string",
  "SubmittedAt": "2025-12-31T12:00:00Z",
  "CreatedAt": "2025-12-31T12:00:00Z",
  "UpdatedAt": "2025-12-31T12:00:00Z"
}

Submission-Dokumente

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
submissionId	string (uuid)	✓

Query-Parameter

Name	Typ	Required	Default
page	integer (int32)		1
size	integer (int32)		50

Response Schema

Typ: object

Feld	Typ	Nullable
Total	integer(int32)
Page	integer(int32)
Size	integer(int32)
Items	array<M2MExpertReportSubmissionDocumentDto>	✓

Beispiel-Response

{
  "Total": 0,
  "Page": 0,
  "Size": 0,
  "Items": [
    {
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "SubmissionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ClaimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "FileName": "string",
      "ContentType": "string",
      "SizeBytes": 0,
      "Kind": "string",
      "IsSalvageSale": false,
      "CreatedAt": "2025-12-31T12:00:00Z",
      "ContentBase64": "string"
    }
  ]
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Content-Typeapplication/json

Path-Parameter

Name	Typ	Required	Default
submissionId	string (uuid)	✓

Request Body

Request Schema

Typ: object

Feld	Typ	Nullable
FileName	string	✓
ContentType	string	✓
ContentBase64	string	✓
IsSalvageSale	boolean	✓

Beispiel-Body

{
  "FileName": "string",
  "ContentType": "string",
  "ContentBase64": "string",
  "IsSalvageSale": false
}

Response Schema

Typ: object

Feld	Typ	Nullable
Id	string(uuid)
SubmissionId	string(uuid)
ClaimId	string(uuid)
FileName	string	✓
ContentType	string	✓
SizeBytes	integer(int64)
Kind	string	✓
IsSalvageSale	boolean
CreatedAt	string(date-time)

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "SubmissionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ClaimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "FileName": "string",
  "ContentType": "string",
  "SizeBytes": 0,
  "Kind": "string",
  "IsSalvageSale": false,
  "CreatedAt": "2025-12-31T12:00:00Z"
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
submissionId	string (uuid)	✓
docId	string (uuid)	✓

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
submissionId	string (uuid)	✓

Response Schema

Typ: object

Feld	Typ	Nullable	Enum
Id	string(uuid)
ClaimId	string(uuid)
SequenceNo	integer(int32)
Status	string	✓	DraftSubmittedApprovedReturnedCancelled
Comment	string	✓
SubmittedAt	string(date-time)	✓
CreatedAt	string(date-time)
UpdatedAt	string(date-time)

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ClaimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "SequenceNo": 0,
  "Status": "Draft",
  "Comment": "string",
  "SubmittedAt": "2025-12-31T12:00:00Z",
  "CreatedAt": "2025-12-31T12:00:00Z",
  "UpdatedAt": "2025-12-31T12:00:00Z"
}

Versicherer

Endpoints für Versicherer zum Erstellen/Validieren/Abrufen von Schäden, Dokumenten und Report-Übersichten.

Zeitstempel & inkrementelle Synchronisierung

Vier Zeitstempel steuern Listen-Filter und Synchronisierung. Die Sync-Filter sind nach dem Feld benannt, das sie filtern, und vergleichen inklusiv (>=).

CreatedAt — Erstellzeitpunkt des Claims. Filter: createdFrom / createdTo.
completedFrom / completedTo filtern auf den Zeitpunkt des jüngsten Fallabschlusses (Finalized-Ereignis; bei wiedereröffneten Fällen zählt der neueste Abschluss). Gedacht für Auswertungszeiträume («alle im Q2 abgeschlossenen Fälle») — nicht für Synchronisierung.
LastChangedAt — Letzte partnerrelevante Änderung (Status, Dokumente, Reports, Kommentare, Beträge). Filter: lastChangedSince.
LastReportApprovedAt — Zeitpunkt der letzten Report-Genehmigung (null, falls noch keine). Filter: lastReportApprovedSince — Claims ohne genehmigten Report matchen nie.

Sync-Rezept (täglicher Poller)

Mit lastChangedSince=<gespeicherter Cursor> abfragen (erster Lauf: ohne Filter).
Ergebnisse idempotent verarbeiten — der Vergleich ist inklusiv, der Grenzwert kann erneut erscheinen.
Als neuen Cursor das Maximum der gesehenen LastChangedAt speichern.
Nur an neuen genehmigten Reports interessiert? Gleicher Ablauf mit lastReportApprovedSince und LastReportApprovedAt.

Schäden

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Query-Parameter

Name	Typ	Default
category	string
status	string
page	integer (int32)	1
size	integer (int32)	50
q	string
createdFrom	string (date-time)
createdTo	string (date-time)
completedFrom	string (date-time)
completedTo	string (date-time)
lastChangedSince	string (date-time)
lastReportApprovedSince	string (date-time)

Response Schema

Typ: object

Feld	Typ	Nullable
Total	integer(int32)
Page	integer(int32)
Size	integer(int32)
Items	array<M2MInsurerClaimListItemDto>	✓

Beispiel-Response

{
  "Total": 0,
  "Page": 0,
  "Size": 0,
  "Items": [
    {
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ExternalKey": "string",
      "Category": "vehicle",
      "Status": "Created",
      "CreatedAt": "2025-12-31T12:00:00Z",
      "UpdatedAt": "2025-12-31T12:00:00Z",
      "ExpertComment": "string",
      "PayloadJson": "string",
      "ArchiveState": false,
      "Expert": {
        "Name": "string",
        "Responsible": {
          "Name": "string",
          "Email": "string",
          "Phone": "string"
        }
      },
      "HailDriveInAccepted": false,
      "LastReportApprovedAt": "2025-12-31T12:00:00Z",
      "LastChangedAt": "2025-12-31T12:00:00Z",
      "CostEstimateAmount": 0,
      "ApprovedAmount": 0,
      "SavingsAmount": 0
    }
  ]
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Content-Typeapplication/json

Request Body

Request Schema

Typ: object

Feld	Typ	Required	Nullable	Enum
Category	string		✓	vehiclefraudappraiserspecial
PayloadJson	string		✓

Beispiel-Body

{
  "Category": "vehicle",
  "PayloadJson": "string"
}

Response Schema

Typ: object

Feld	Typ	Nullable	Enum
Id	string(uuid)
ExternalKey	string	✓
Category	string	✓	vehiclefraudappraiserspecial
Status	string	✓	CreatedAssignedRejectedAcceptedInProgressExpertCompletedAdminApprovedAdminReturnedAdminCancelledFinal
PayloadJson	string	✓

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ExternalKey": "string",
  "Category": "vehicle",
  "Status": "Created",
  "PayloadJson": "string"
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Content-Typeapplication/json

Request Body

Request Schema

Typ: object

Feld	Typ	Required	Nullable	Enum
Category	string		✓	vehiclefraudappraiserspecial
PayloadJson	string		✓

Beispiel-Body

{
  "Category": "vehicle",
  "PayloadJson": "string"
}

Feld	Typ	Required	Nullable	Enum
Valid	boolean
Errors	object		✓

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
claimId	string (uuid)	✓

Response Schema

Typ: object

Feld	Typ	Nullable	Enum
Id	string(uuid)
ExternalKey	string	✓
Category	string	✓	vehiclefraudappraiserspecial
Status	string	✓	CreatedAssignedRejectedAcceptedInProgressExpertCompletedAdminApprovedAdminReturnedAdminCancelledFinal
CreatedAt	string(date-time)
UpdatedAt	string(date-time)
ExpertComment	string	✓
PayloadJson	string	✓
ArchiveState	boolean
Expert	M2MExpertDto
HailDriveInAccepted	boolean	✓
LastReportApprovedAt When the most recently APPROVED report for this claim was approved (null if no report has been approved yet). Poll this to detect that a new report is available without fetching each claim's reports individually. Filterable via the `lastReportApprovedSince` query parameter on the claims list.	string(date-time)	✓
LastChangedAt Partner-sync cursor. Advances on every partner-visible change to the claim (report approval, document upload, expert comment, status change). On the next poll, pass the highest value you have seen as the `lastChangedSince` query parameter to fetch only what changed since.	string(date-time)
CostEstimateAmount Workshop cost estimate in CHF (null = not entered yet). Set by the expert via PUT /v1/experts/cases/{caseId}/amounts.	number(double)	✓
ApprovedAmount Amount approved by the expert report in CHF (null = not entered yet).	number(double)	✓
SavingsAmount Savings in CHF = CostEstimateAmount - ApprovedAmount; only when both are set and the estimate is higher, otherwise null.	number(double)	✓

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ExternalKey": "string",
  "Category": "vehicle",
  "Status": "Created",
  "CreatedAt": "2025-12-31T12:00:00Z",
  "UpdatedAt": "2025-12-31T12:00:00Z",
  "ExpertComment": "string",
  "PayloadJson": "string",
  "ArchiveState": false,
  "Expert": {
    "Name": "string",
    "Responsible": {
      "Name": "string",
      "Email": "string",
      "Phone": "string"
    }
  },
  "HailDriveInAccepted": false,
  "LastReportApprovedAt": "2025-12-31T12:00:00Z",
  "LastChangedAt": "2025-12-31T12:00:00Z",
  "CostEstimateAmount": 0,
  "ApprovedAmount": 0,
  "SavingsAmount": 0
}

Schadendokumente

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
claimId	string (uuid)	✓

Query-Parameter

Name	Typ	Required	Default
page	integer (int32)		1
size	integer (int32)		50

Response Schema

Typ: object

Feld	Typ	Nullable
Total	integer(int32)
Page	integer(int32)
Size	integer(int32)
Items	array<M2MInsurerDocumentDto>	✓

Beispiel-Response

{
  "Total": 0,
  "Page": 0,
  "Size": 0,
  "Items": [
    {
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "FileName": "string",
      "ContentType": "string",
      "SizeBytes": 0,
      "CreatedAt": "2025-12-31T12:00:00Z"
    }
  ]
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Content-Typeapplication/json

Path-Parameter

Name	Typ	Required	Default
claimId	string (uuid)	✓

Request Body

Request Schema

Typ: object

Feld	Typ	Nullable
FileName	string	✓
ContentType	string	✓
ContentBase64	string	✓

Beispiel-Body

{
  "FileName": "string",
  "ContentType": "string",
  "ContentBase64": "string"
}

Response Schema

Typ: object

Feld	Typ	Nullable
Id	string(uuid)
FileName	string	✓
ContentType	string	✓
SizeBytes	integer(int64)
CreatedAt	string(date-time)

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "FileName": "string",
  "ContentType": "string",
  "SizeBytes": 0,
  "CreatedAt": "2025-12-31T12:00:00Z"
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
claimId	string (uuid)	✓
documentId	string (uuid)	✓

Response Schema

Typ: object

Feld	Typ	Nullable
Id	string(uuid)
FileName	string	✓
ContentType	string	✓
SizeBytes	integer(int64)
CreatedAt	string(date-time)
ContentBase64	string	✓

Beispiel-Response

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "FileName": "string",
  "ContentType": "string",
  "SizeBytes": 0,
  "CreatedAt": "2025-12-31T12:00:00Z",
  "ContentBase64": "string"
}

Reports zu Claims

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
claimId	string (uuid)	✓

Query-Parameter

Name	Typ	Required	Default
page	integer (int32)		1
size	integer (int32)		50

Response Schema

Typ: object

Feld	Typ	Nullable
Total	integer(int32)
Page	integer(int32)
Size	integer(int32)
Items	array<M2MReportListItemDto>	✓

Beispiel-Response

{
  "Total": 0,
  "Page": 0,
  "Size": 0,
  "Items": [
    {
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ClaimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "SequenceNo": 0,
      "RevisionNo": 0,
      "Status": "Draft",
      "Comment": "string",
      "SubmittedAt": "2025-12-31T12:00:00Z",
      "CreatedAt": "2025-12-31T12:00:00Z",
      "UpdatedAt": "2025-12-31T12:00:00Z"
    }
  ]
}

Headers

Acceptapplication/json

AuthorizationDPoP {access_token}

DPoP{dpop_proof_jwt}

Path-Parameter

Name	Typ	Required	Default
claimId	string (uuid)	✓
submissionId	string (uuid)	✓

Query-Parameter

Name	Typ	Default
page	integer (int32)	1
size	integer (int32)	50
lang	string	de

Response Schema

Typ: object

Feld	Typ	Nullable
Total	integer(int32)
Page	integer(int32)
Size	integer(int32)
Items	array<M2MReportSubmissionDocumentContentDto>	✓

Beispiel-Response

{
  "Total": 0,
  "Page": 0,
  "Size": 0,
  "Items": [
    {
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "SubmissionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ClaimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "FileName": "string",
      "ContentType": "string",
      "SizeBytes": 0,
      "Kind": "string",
      "IsSalvageSale": false,
      "CreatedAt": "2025-12-31T12:00:00Z",
      "ContentBase64": "string"
    }
  ]
}

Fall-Struktur & Validierung

Jede Kategorie beschreibt präzise, welche Felder das payloadJson enthalten darf.

Kategorie

Fahrzeuggutachter

Diese Struktur richtet sich an Payloads für die Kategorie Fahrzeuggutachter.

Kontext & Hinweise

Die Payload-Kategorie Fahrzeuggutachter umfasst 96 dokumentierte Felder sowie 50 Pflichtfelder.

Formatvorgaben

5 Besonderheiten

Regeln & Abhängigkeiten

7 definierte Regeln

Aktionen & Links

Schema herunterladen

Alle Schemas liegen als JSON-Dateien vor und können direkt in Validierungswerkzeuge importiert werden.

Zum Kopieren klicken

payloadJson.insured.firstRegistration

Datum im ISO-Format YYYY-MM-DD, leer ("") oder null

payloadJson.counterparty.firstRegistration

Datum im ISO-Format YYYY-MM-DD, leer ("") oder null

payloadJson.incidentDate

Datum im ISO-Format YYYY-MM-DD

payloadJson.estimatedAmount

Numerischer String ohne Vorzeichen (optional Nachkommastellen, Punkt als Trenner)

payloadJson.inspectionDate

Datum im ISO-Format YYYY-MM-DD

Zeitliche Plausibilität (alle Kategorien)

•incidentDate darf nicht in der Zukunft liegen.
•inspectionDate darf nicht in der Vergangenheit liegen.
•firstRegistration und birthDate dürfen nicht in der Zukunft liegen – auch in insuredPersons[] und counterpartyPersons[].
•Stichtag ist der aktuelle Tag in Europe/Zurich, mit einem Tag Toleranz in beide Richtungen (Zeitzonen-Ausgleich).

Diese Regeln lassen sich in JSON Schema nicht ausdrücken – dort gibt es keinen Begriff von „heute“. Sie erscheinen daher nicht im Schema-Download, werden aber serverseitig geprüft.

Abhängig vom Feld claimInsurance

Wenn claimInsurance den Wert liability hat, dann:

•Pflichtfelder: counterparty
•counterparty benötigt name, phone, licensePlate, city, carMake

Wenn claimInsurance einen der Werte partial, comprehensive hat, dann:

•Pflichtfelder: insured
•insured benötigt name, phone, licensePlate, address, postalCode, city, carMake

Wenn claimInsurance den Wert partial hat, dann:

•claimType muss einer der Werte fire, natural_hazard, hail_damage, snow_slide, theft, animal_collision, marten_damage, glass_breakage, vandalism, assistance, falling_objects, parking_damage sein

Abhängig vom Feld inspectionType

Wenn inspectionType den Wert workshop hat, dann:

•Pflichtfelder: inspectionDate, workshop
•workshop benötigt name, phone, city, postalCode, country
•workshop.country muss einer der Werte CH, DE, AT, FR, IT, LI sein

Wenn inspectionType einen der Werte estimate_review, invoice_review hat, dann:

•Pflichtfelder: workshop
•workshop benötigt name, phone

Wenn inspectionType einen der Werte private, live_expertise hat, dann:

•Pflichtfelder: inspectionDate, inspectionContact

Abhängig vom Feld inspectionContact

Wenn das Feld inspectionContact vorhanden ist, dann:

•inspectionContact benötigt name, address, postalCode, city, phone, country
•inspectionContact.country muss einer der Werte CH, DE, AT, FR, IT, LI sein

Payload Schema

Typ: object

Feld	Typ	Required	Enum
policyNumber	string	✓
claimInsurance	string	✓	liabilitypartialcomprehensive
claimType	string	✓
insured	object	✓
counterparty	object
location	object	✓
incidentDate	string	✓
damageDescription	string	✓
estimatedAmount	oneOf	✓
estimatedCurrency	string	✓	CHFEURUSD
inspectionType	string	✓	workshopprivatelive_expertiseestimate_reviewinvoice_review
workshop	object
inspectionContact	object
inspectionDate	string,null
remarks	string,null

Kategorie

Sachverständiger

Diese Struktur richtet sich an Payloads für die Kategorie Sachverständiger.

Kontext & Hinweise

Die Payload-Kategorie Sachverständiger umfasst 64 dokumentierte Felder sowie 35 Pflichtfelder.

Formatvorgaben

3 Besonderheiten

Regeln & Abhängigkeiten

4 definierte Regeln

Aktionen & Links

Schema herunterladen

Alle Schemas liegen als JSON-Dateien vor und können direkt in Validierungswerkzeuge importiert werden.

Zum Kopieren klicken

payloadJson.incidentDate

Datum im ISO-Format YYYY-MM-DD

payloadJson.estimatedAmount

Numerischer String ohne Vorzeichen (optional Nachkommastellen, Punkt als Trenner)

payloadJson.inspectionDate

Datum im ISO-Format YYYY-MM-DD

Zeitliche Plausibilität (alle Kategorien)

•incidentDate darf nicht in der Zukunft liegen.
•inspectionDate darf nicht in der Vergangenheit liegen.
•firstRegistration und birthDate dürfen nicht in der Zukunft liegen – auch in insuredPersons[] und counterpartyPersons[].
•Stichtag ist der aktuelle Tag in Europe/Zurich, mit einem Tag Toleranz in beide Richtungen (Zeitzonen-Ausgleich).

Diese Regeln lassen sich in JSON Schema nicht ausdrücken – dort gibt es keinen Begriff von „heute“. Sie erscheinen daher nicht im Schema-Download, werden aber serverseitig geprüft.

Abhängig vom Feld claimInsurance

Wenn claimInsurance den Wert liability hat, dann:

•Pflichtfelder: counterparty
•insured benötigt name
•counterparty benötigt name, phone, city

Wenn claimInsurance den Wert own hat, dann:

•insured benötigt name, phone, city

Abhängig vom Feld inspectionType

Wenn inspectionType den Wert onsite hat, dann:

•Pflichtfelder: inspectionDate, inspectionContact
•inspectionContact benötigt name, postalCode, city, phone, country
•inspectionContact.country muss einer der Werte CH, DE, AT, FR, IT, LI sein

Abhängig vom Feld inspectionContact

Wenn das Feld inspectionContact vorhanden ist, dann:

•inspectionContact benötigt name, postalCode, city, phone, country
•inspectionContact.country muss einer der Werte CH, DE, AT, FR, IT, LI sein

Payload Schema

Typ: object

Feld	Typ	Required	Enum
policyNumber	string	✓
claimInsurance	string	✓	liabilityown
claimType	string	✓	buildinginfrastructurehousehold
insured	object	✓
counterparty	object
location	object	✓
incidentDate	string	✓
damageDescription	string	✓
estimatedAmount	oneOf	✓
estimatedCurrency	string	✓	CHFEURUSD
inspectionType	string	✓	onsiteestimate_reviewinvoice_review
inspectionDate	string,null
inspectionContact	object
remarks	string,null

Kategorie

Bekämpfung Versicherungsmissbrauch

Diese Struktur richtet sich an Payloads für die Kategorie Versicherungsmissbrauch.

Kontext & Hinweise

Die Payload-Kategorie Bekämpfung Versicherungsmissbrauch umfasst 76 dokumentierte Felder sowie 25 Pflichtfelder.

Formatvorgaben

7 Besonderheiten

Regeln & Abhängigkeiten

2 definierte Regeln

Aktionen & Links

Schema herunterladen

Alle Schemas liegen als JSON-Dateien vor und können direkt in Validierungswerkzeuge importiert werden.

Zum Kopieren klicken

payloadJson.insured.birthDate

Datum im ISO-Format YYYY-MM-DD, leer ("") oder null

payloadJson.counterparty.birthDate

Datum im ISO-Format YYYY-MM-DD, leer ("") oder null

payloadJson.insuredPersons[].birthDate

Datum im ISO-Format YYYY-MM-DD, leer ("") oder null

payloadJson.counterpartyPersons[].birthDate

Datum im ISO-Format YYYY-MM-DD, leer ("") oder null

payloadJson.incidentDate

Datum im ISO-Format YYYY-MM-DD

payloadJson.incidentTime

Zeitfeld HH:MM (24h)

payloadJson.estimatedAmount

Numerischer String ohne Vorzeichen (optional Nachkommastellen, Punkt als Trenner)

Zeitliche Plausibilität (alle Kategorien)

•incidentDate darf nicht in der Zukunft liegen.
•inspectionDate darf nicht in der Vergangenheit liegen.
•firstRegistration und birthDate dürfen nicht in der Zukunft liegen – auch in insuredPersons[] und counterpartyPersons[].
•Stichtag ist der aktuelle Tag in Europe/Zurich, mit einem Tag Toleranz in beide Richtungen (Zeitzonen-Ausgleich).

Diese Regeln lassen sich in JSON Schema nicht ausdrücken – dort gibt es keinen Begriff von „heute“. Sie erscheinen daher nicht im Schema-Download, werden aber serverseitig geprüft.

Abhängig vom Feld driverAtIncident

Wenn driverAtIncident gesetzt wird, dann:

•Versicherte: In insured und insuredPersons[] darf höchstens eine Person driverAtIncident = "yes" sein (auch keine).
•Gegenpartei: In counterparty und counterpartyPersons[] darf höchstens eine Person driverAtIncident = "yes" sein (auch keine).

Abhängig vom Feld claimInsurance

Wenn claimInsurance den Wert liability hat, dann:

•Pflichtfelder: counterparty
•counterparty benötigt name, address, postalCode, city, phone, email

Payload Schema

Typ: object

Feld	Typ	Required	Enum
policyNumber	string	✓
claimInsurance	string	✓	liabilitypartialcomprehensive
claimType	string	✓
insured	object	✓
counterparty	object
insuredPersons	array<object>
counterpartyPersons	array<object>
location	object	✓
incidentDate	string	✓
incidentTime	string,null
damageDescription	string	✓
estimatedAmount	oneOf	✓
estimatedCurrency	string	✓	CHFEURUSD
supportRequest	string	✓
remarks	string,null

Kategorie

Spezialexpertisen

Diese Struktur richtet sich an Payloads für die Kategorie Spezialexpertisen.

Kontext & Hinweise

Die Payload-Kategorie Spezialexpertisen umfasst 97 dokumentierte Felder sowie 59 Pflichtfelder.

Formatvorgaben

5 Besonderheiten

Regeln & Abhängigkeiten

14 definierte Regeln

Aktionen & Links

Schema herunterladen

Alle Schemas liegen als JSON-Dateien vor und können direkt in Validierungswerkzeuge importiert werden.

Zum Kopieren klicken

payloadJson.insured.firstRegistration

Datum im ISO-Format YYYY-MM-DD, leer ("") oder null

payloadJson.counterparty.firstRegistration

Datum im ISO-Format YYYY-MM-DD, leer ("") oder null

payloadJson.incidentDate

Datum im ISO-Format YYYY-MM-DD

payloadJson.estimatedAmount

Numerischer String ohne Vorzeichen (optional Nachkommastellen, Punkt als Trenner)

payloadJson.inspectionDate

Datum im ISO-Format YYYY-MM-DD

Zeitliche Plausibilität (alle Kategorien)

•incidentDate darf nicht in der Zukunft liegen.
•inspectionDate darf nicht in der Vergangenheit liegen.
•firstRegistration und birthDate dürfen nicht in der Zukunft liegen – auch in insuredPersons[] und counterpartyPersons[].
•Stichtag ist der aktuelle Tag in Europe/Zurich, mit einem Tag Toleranz in beide Richtungen (Zeitzonen-Ausgleich).

Diese Regeln lassen sich in JSON Schema nicht ausdrücken – dort gibt es keinen Begriff von „heute“. Sie erscheinen daher nicht im Schema-Download, werden aber serverseitig geprüft.

Abhängig vom Feld machineCategory

Wenn machineCategory einen der Werte rail_vehicle, aircraft hat, dann:

•claimInsurance muss liability sein

Wenn machineCategory den Wert rail_vehicle hat, dann:

•machineType muss einer der Werte gondola, train, tram, rack_railway sein

Wenn machineCategory den Wert aircraft hat, dann:

•machineType muss einer der Werte glider, powered_aircraft, drone sein

Wenn machineCategory den Wert land_machine hat, dann:

•machineType muss einer der Werte tractor, trailer, harvester, stationary_machine sein

Wenn machineCategory den Wert land_machine hat, dann:

•inspectionType muss einer der Werte workshop, private, estimate_review, invoice_review sein

Wenn machineCategory einen der Werte rail_vehicle, aircraft hat, dann:

•inspectionType muss einer der Werte onsite, estimate_review, invoice_review sein

Wenn machineCategory einen der Werte aircraft, land_machine hat und claimInsurance den Wert liability hat, dann:

•Pflichtfelder: counterparty
•counterparty benötigt make

Wenn machineCategory den Wert land_machine hat und claimInsurance einen der Werte partial, comprehensive hat, dann:

•Pflichtfelder: insured
•insured benötigt carMake

Abhängig vom Feld claimInsurance

Wenn claimInsurance den Wert liability hat, dann:

•Pflichtfelder: counterparty
•counterparty benötigt name, phone, city

Wenn claimInsurance einen der Werte partial, comprehensive hat, dann:

•Pflichtfelder: insured
•insured benötigt name, phone, address, postalCode, city

Abhängig vom Feld inspectionType

Wenn inspectionType den Wert workshop hat, dann:

•Pflichtfelder: inspectionDate, workshop
•workshop benötigt name, phone, city, postalCode

Wenn inspectionType einen der Werte estimate_review, invoice_review hat, dann:

•Pflichtfelder: workshop
•workshop benötigt name, phone

Wenn inspectionType einen der Werte private, onsite hat, dann:

•Pflichtfelder: inspectionDate, inspectionContact

Abhängig vom Feld inspectionContact

Wenn das Feld inspectionContact vorhanden ist, dann:

•inspectionContact benötigt name, address, postalCode, city, phone

Payload Schema

Typ: object

Feld	Typ	Required	Enum
policyNumber	string	✓
claimInsurance	string	✓	liabilitypartialcomprehensive
claimType	string	✓
machineCategory	string	✓	rail_vehicleaircraftland_machine
machineType	string	✓	gondolatraintramrack_railwaygliderpowered_aircraftdronetractortrailerharvesterstationary_machine
insured	object	✓
counterparty	object
location	object	✓
incidentDate	string	✓
damageDescription	string	✓
estimatedAmount	oneOf	✓
estimatedCurrency	string	✓	CHFEURUSD
inspectionType	string	✓	workshopprivateonsiteestimate_reviewinvoice_review
workshop	object
inspectionContact	object
inspectionDate	string,null
remarks	string,null

PayloadJson direkt testen

Senden Sie eine Anfrage an die Claimity Validierungs-API und erhalten Sie sofortiges Feedback zu Ihrem Payload.

POST/v1/insurers/claims:validate

Kategorie

Payload JSONapplication/json

Erwartet eine gültige JSON-Struktur.

Antwort

Bereit

Die Antwort der Validierungs-API erscheint hier.

Kategorie wählen
Payload JSON einfügen oder Beispiel übernehmen
Payload validieren

API Dokumentation

Übersicht

Erste Schritte

Erweiterung der Schnittstellen

Erste Schritte

Schlüsselpaar erstellen

Authentifizieren

DPoP-Header vorbereiten

Erste Anfrage

Python Notebooks

Problem melden

Vor dem Melden

Report einreichen

Änderungsprotokoll

Authentifizierung

Authentication Flow

Ablauf

Access Token auslesen

Voraussetzungen

Token Endpoint

Token Response

API Requests senden

Erforderliche Headers

Correlation-ID

API‑Grundlagen

Request‑Format

URL‑Aufbau

HTTP‑Methoden

Typische Headers

Response‑Format

Erfolgs‑Responses

Fehler‑Responses (ProblemDetails)

Rate Limiting

Anonyme Validierung

Standard für die Partner-API

Dokument-Routen

Token-Endpunkt

Empfehlungen für Clients

Idempotenz (Idempotency-Key)

Fehlerkatalog

Experten

Zeitstempel & inkrementelle Synchronisierung

Fälle

Falldokumente

Reports & Submissions

Submission-Dokumente

Versicherer

Zeitstempel & inkrementelle Synchronisierung

Sync-Rezept (täglicher Poller)

Schäden

Schadendokumente

Reports zu Claims

Fall-Struktur & Validierung

Fahrzeuggutachter

Beispiel-JSON

Formatvorgaben

Regeln & Abhängigkeiten

Schema Explorer

Sachverständiger

Beispiel-JSON

Formatvorgaben

Regeln & Abhängigkeiten

Schema Explorer

Bekämpfung Versicherungsmissbrauch

Beispiel-JSON

Formatvorgaben

Regeln & Abhängigkeiten

Schema Explorer

Spezialexpertisen

Beispiel-JSON

Formatvorgaben

Regeln & Abhängigkeiten

Schema Explorer

PayloadJson direkt testen