Documents & signatures

Documents, storage and e-signature requests — upload, organize and sign files.

Document

Endpoints

GET	/documents	Retrieves the collection of Document resources.
POST	/documents	Creates a Document resource.
GET	/documents/{id}	Retrieves a Document resource.
PATCH	/documents/{id}	Updates the Document resource.
DELETE	/documents/{id}	Removes the Document resource.
GET	/documents/action-needed	Retrieves the collection of Document resources.

Schema fields

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

Storage

Endpoints

GET	/storage/{id}	Retrieves a Storage resource.
DELETE	/storage/{id}	Removes the Storage resource.
GET	/storage/{id}/preview	Preview file
GET	/storage/mt940	Retrieves the collection of Storage resources.
POST	/storage/upload	Creates a Storage resource.

Schema fields

Field	Type	Description
id	string
relationName*	string
relationId*	string
size	integer
mimeType	string

Document Type

Endpoints

GET	/document-types	Retrieves the collection of DocumentType resources.
POST	/document-types	Creates a DocumentType resource.
GET	/document-types/{id}	Retrieves a DocumentType resource.
PATCH	/document-types/{id}	Updates the DocumentType resource.

Schema fields

Field	Type	Description
name*	string
relationName*	string
required	boolean
expiring	boolean
description	stringnull

Signature Request

Endpoints

GET	/signature-requests	Retrieves the collection of SignatureRequest resources.
POST	/signature-requests	Creates a SignatureRequest resource.
GET	/signature-requests/{id}	Retrieves a SignatureRequest resource.
DELETE	/signature-requests/{id}	Removes the SignatureRequest resource.
GET	/signature-requests/{id}/signature-status	Live per-signer signing status for a signature request.

Schema fields

Field	Type	Description
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)