Documenten & handtekeningen

Documenten, opslag en e-handtekeningverzoeken — upload, organiseer en onderteken bestanden.

Document

Endpoints

GET	/documents	Haalt de verzameling Document-resources op.
POST	/documents	Maakt een Document-resource aan.
GET	/documents/{id}	Haalt een Document-resource op.
PATCH	/documents/{id}	Werkt de Document-resource bij.
DELETE	/documents/{id}	Verwijdert de Document-resource.
GET	/documents/action-needed	Haalt de verzameling Document-resources op.

Schema-velden

Veld	Type	Beschrijving
documentType*	string (iri-reference)
relationId*	integernull
relationUuid	stringnull
expiringAt	string,null (date-time)
storage*	string (iri-reference)
notes	stringnull

Opslag

Endpoints

GET	/storage/{id}	Haalt een Storage-resource op.
DELETE	/storage/{id}	Verwijdert de Storage-resource.
GET	/storage/{id}/preview	Preview file
GET	/storage/mt940	Haalt de verzameling Storage-resources op.
POST	/storage/upload	Maakt een Storage-resource aan.

Schema-velden

Veld	Type	Beschrijving
id	string
relationName*	string
relationId*	string
size	integer
mimeType	string

Documenttype

Endpoints

GET	/document-types	Haalt de verzameling DocumentType-resources op.
POST	/document-types	Maakt een DocumentType-resource aan.
GET	/document-types/{id}	Haalt een DocumentType-resource op.
PATCH	/document-types/{id}	Werkt de DocumentType-resource bij.

Schema-velden

Veld	Type	Beschrijving
name*	string
relationName*	string
required	boolean
expiring	boolean
description	stringnull

Ondertekeningsverzoek

Endpoints

GET	/signature-requests	Haalt de verzameling SignatureRequest-resources op.
POST	/signature-requests	Maakt een SignatureRequest-resource aan.
GET	/signature-requests/{id}	Haalt een SignatureRequest-resource op.
DELETE	/signature-requests/{id}	Verwijdert de SignatureRequest-resource.
GET	/signature-requests/{id}/signature-status	Live per-signer signing status for a signature request.

Schema-velden

Veld	Type	Beschrijving
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)