Zum Hauptinhalt springen

Public API – Dokumente

Dokumente eines Trauerfalls auflisten, hochladen, herunterladen und löschen.

Verfasst von Support Team

Dokumente sind Dateien am Trauerfall, zum Beispiel die Sterbeurkunde, eine Vollmacht oder Fotos. Mit Dokument-Tags ordnest du sie ein. Angehörige sehen Dokumente nicht. Dokumente mit dem System-Tag Krematorium kann das Krematorium einsehen, das in der Bestattungsart des Falls als Ort hinterlegt ist.

Methode

Pfad

Zweck

GET

/cases/{uuid}/documents

Dokumente eines Trauerfalls auflisten

POST

/cases/{uuid}/documents

Dokument hochladen

GET

/documents/{uuid}/download

Datei herunterladen

DELETE

/documents/{uuid}

Dokument löschen

Umbenennen und Tags nachträglich ändern geht nur in Web und App.

Das Dokument-Objekt

Feld

Typ

Beschreibung

uuid

String

Eindeutige Kennung. Nutze sie für Download und Löschen.

id

Integer

Interne ID

original_filename

String

Dateiname, max. 200 Zeichen

mime_type

String

Dateityp, vom Server anhand des Inhalts erkannt

file_size

Integer

Größe in Byte

created_at

String

Hochgeladen am

uploader_first_name, uploader_last_name

String

Wer das Dokument hochgeladen hat

has_preview

Boolean

true, wenn es eine verkleinerte Vorschau gibt (bei JPEG, PNG und WebP)

tags

Array

Zugeordnete Tags, je Eintrag id und name

Dokumente auflisten

GET /cases/{uuid}/documents

Liefert alle Dokumente des Trauerfalls, die neuesten zuerst.

curl https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47/documents \
  -H "Authorization: Bearer $RIP_API_KEY"

Antwort 200 OK

{
  "success": true,
  "count": 2,
  "data": [
    {
      "id": 905,
      "uuid": "1e9b4c7a-2d5f-4a8b-9e3c-6f0a2d5b8e41",
      "original_filename": "Vollmacht_Neumann.jpg",
      "mime_type": "image/jpeg",
      "file_size": 1834512,
      "created_at": "2026-11-11 10:22:48",
      "uploader_first_name": "Murat",
      "uploader_last_name": "Yilmaz",
      "has_preview": true,
      "tags": [{ "id": 13, "name": "Vollmacht" }]
    },
    {
      "id": 902,
      "uuid": "d5f8a2c1-4b7e-4d9a-8c3f-6e1b0a9d2f47",
      "original_filename": "Sterbeurkunde_Neumann.pdf",
      "mime_type": "application/pdf",
      "file_size": 245760,
      "created_at": "2026-11-10 16:05:13",
      "uploader_first_name": "Jonas",
      "uploader_last_name": "Berger",
      "has_preview": false,
      "tags": [{ "id": 12, "name": "Sterbeurkunde" }]
    }
  ]
}

Code

error

Ursache

404

Sterbefall nicht gefunden

UUID des Falls unbekannt

Dokument hochladen

POST /cases/{uuid}/documents

Lädt eine Datei hoch. Der Request ist multipart/form-data, kein JSON.

Formularfelder

Feld

Typ

Pflicht

Beschreibung

file

Datei

ja

Die Datei, max. 25 MB

tag_ids

String oder Liste

nein

IDs aus GET /document-tags, kommagetrennt (12,13) oder als tag_ids[]

curl -X POST https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47/documents \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -F "file=@Sterbeurkunde_Neumann.pdf" \
  -F "tag_ids=12"
// Node.js 18+
import { readFile } from "node:fs/promises";

const form = new FormData();
const pdf = await readFile("Sterbeurkunde_Neumann.pdf");
form.append("file", new Blob([pdf], { type: "application/pdf" }), "Sterbeurkunde_Neumann.pdf");
form.append("tag_ids", "12");

const res = await fetch(
  "https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47/documents",
  {
    method: "POST",
    headers: { Authorization: `Bearer ${process.env.RIP_API_KEY}` },
    // Content-Type nicht selbst setzen – FormData setzt ihn samt Boundary
    body: form,
  }
);
console.log(res.status, await res.json());

Antwort 200 OK

{
  "success": true,
  "message": "Dokument hochgeladen",
  "data": {
    "id": 902,
    "uuid": "d5f8a2c1-4b7e-4d9a-8c3f-6e1b0a9d2f47",
    "original_filename": "Sterbeurkunde_Neumann.pdf",
    "mime_type": "application/pdf",
    "file_size": 245760,
    "created_at": "2026-11-10 16:05:13",
    "uploader_first_name": "Jonas",
    "uploader_last_name": "Berger",
    "has_preview": false,
    "tags": [{ "id": 12, "name": "Sterbeurkunde" }]
  }
}

Anders als beim Anlegen von Trauerfällen und Terminen antwortet der Upload mit 200, nicht mit 201.

Der Server erkennt den Dateityp am Inhalt, nicht an der Endung. Der Dateiname wird bereinigt: Pfadangaben und Steuerzeichen fallen weg, nach 200 Zeichen wird gekürzt. Jeder Upload legt ein neues Dokument an – auch bei gleichem Dateinamen.

Code

error

Ursache

400

Keine Datei hochgeladen

Feld file fehlt

400

Datei darf maximal 25 MB groß sein

Datei zu groß

400

Beim Hochladen ist etwas schiefgelaufen. Bitte versuche es erneut.

Upload abgebrochen oder unvollständig

400

Dieser Dateityp ist nicht erlaubt (image/svg+xml)

Dateityp nicht erlaubt (siehe unten)

400

Ein oder mehrere Tags sind ungueltig

Eine Tag-ID gehört nicht zu deinem Unternehmen. Die Datei wird dann nicht gespeichert.

404

Sterbefall nicht gefunden

UUID des Falls unbekannt

Dokument herunterladen

GET /documents/{uuid}/download

Liefert die Datei selbst, nicht JSON.

Query-Parameter

Parameter

Typ

Pflicht

Beschreibung

preview

1

nein

Liefert die verkleinerte Vorschau (max. 1600 Pixel Kantenlänge), falls has_preview true ist. Sonst kommt das Original.

curl -o Sterbeurkunde_Neumann.pdf \
  https://de.rip-app.business/api/public/v1/documents/d5f8a2c1-4b7e-4d9a-8c3f-6e1b0a9d2f47/download \
  -H "Authorization: Bearer $RIP_API_KEY"

Die Antwort hat diese Header:

Header

Inhalt

Content-Type

Dateityp, zum Beispiel application/pdf

Content-Disposition

inline bei PDF, Bildern und Text, sonst attachment – jeweils mit Dateiname

Content-Length

Größe in Byte

Cache-Control

private, no-cache, no-store, must-revalidate

Fehler kommen als Text, nicht als JSON

Code

Body (text/plain)

Ursache

404

Dokument nicht gefunden

UUID unbekannt

404

Datei nicht gefunden

Datensatz vorhanden, Datei fehlt auf dem Server

Prüfe deshalb zuerst den Statuscode, bevor du den Body speicherst. Eine falsch aufgebaute UUID beantwortet die API wie üblich mit 400 und JSON.

Dokument löschen

DELETE /documents/{uuid}

Löscht das Dokument samt Datei endgültig. Es gibt keinen Papierkorb.

curl -X DELETE https://de.rip-app.business/api/public/v1/documents/1e9b4c7a-2d5f-4a8b-9e3c-6f0a2d5b8e41 \
  -H "Authorization: Bearer $RIP_API_KEY"

Antwort 200 OK

{ "success": true, "message": "Dokument geloescht" }

Code

error

Ursache

404

Dokument nicht gefunden

UUID unbekannt oder schon gelöscht

Erlaubte Dateitypen

Art

Typen

PDF

application/pdf

Bilder

JPEG, PNG, GIF, WebP, HEIC, HEIF

Office

Word (.doc, .docx), Excel (.xls, .xlsx), PowerPoint (.ppt, .pptx)

Text

Text (.txt), CSV, RTF

Archive

ZIP, 7z, RAR

SVG und alle anderen Typen werden abgelehnt. Wandle SVG-Grafiken vorher in PNG oder PDF um.

Hat dies deine Frage beantwortet?