Dokumente & Unterschriften

Dokumente, Ablage und E-Signatur-Anfragen — Dateien hochladen, organisieren und unterschreiben.

Dokument

Endpoints

GET	/documents	Ruft die Sammlung der Document-Ressourcen ab.
POST	/documents	Erstellt eine Document-Ressource.
GET	/documents/{id}	Ruft eine Document-Ressource ab.
PATCH	/documents/{id}	Aktualisiert die Document-Ressource.
DELETE	/documents/{id}	Entfernt die Document-Ressource.
GET	/documents/action-needed	Ruft die Sammlung der Document-Ressourcen ab.

Schemafelder

Feld	Typ	Beschreibung
documentType*	string (iri-reference)
relationId*	integernull
relationUuid	stringnull
expiringAt	string,null (date-time)
storage*	string (iri-reference)
notes	stringnull

Speicherung

Endpoints

GET	/storage/{id}	Ruft eine Storage-Ressource ab.
DELETE	/storage/{id}	Entfernt die Storage-Ressource.
GET	/storage/{id}/preview	Preview file
GET	/storage/mt940	Ruft die Sammlung der Storage-Ressourcen ab.
POST	/storage/upload	Erstellt eine Storage-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
relationName*	string
relationId*	string
size	integer
mimeType	string

Dokumenttyp

Endpoints

GET	/document-types	Ruft die Sammlung der DocumentType-Ressourcen ab.
POST	/document-types	Erstellt eine DocumentType-Ressource.
GET	/document-types/{id}	Ruft eine DocumentType-Ressource ab.
PATCH	/document-types/{id}	Aktualisiert die DocumentType-Ressource.

Schemafelder

Feld	Typ	Beschreibung
name*	string
relationName*	string
required	boolean
expiring	boolean
description	stringnull

Unterschriftsanfrage

Endpoints

GET	/signature-requests	Ruft die Sammlung der SignatureRequest-Ressourcen ab.
POST	/signature-requests	Erstellt eine SignatureRequest-Ressource.
GET	/signature-requests/{id}	Ruft eine SignatureRequest-Ressource ab.
DELETE	/signature-requests/{id}	Entfernt die SignatureRequest-Ressource.
GET	/signature-requests/{id}/signature-status	Live per-signer signing status for a signature request.

Schemafelder

Feld	Typ	Beschreibung
id	string
documentTitle	string
status	stringnull
sentAt	string,null (date-time)
completedAt	string,null (date-time)
sourceFilename	stringnull
signersSummary	array
contract	string,null (iri-reference)
createdAt	string (date-time)