Документи та підписи

Документи, сховище та запити на електронний підпис — завантажуйте, впорядковуйте та підписуйте файли.

Документ

Endpoints

GET	/documents	Отримує колекцію ресурсів Document.
POST	/documents	Створює ресурс Document.
GET	/documents/{id}	Отримує ресурс Document.
PATCH	/documents/{id}	Оновлює ресурс Document.
DELETE	/documents/{id}	Видаляє ресурс Document.
GET	/documents/action-needed	Отримує колекцію ресурсів Document.

Поля схеми

Поле	Тип	Опис
documentType*	string (iri-reference)
relationId*	integernull
relationUuid	stringnull
expiringAt	string,null (date-time)
storage*	string (iri-reference)
notes	stringnull

Зберігання

Endpoints

GET	/storage/{id}	Отримує ресурс Storage.
DELETE	/storage/{id}	Видаляє ресурс Storage.
GET	/storage/{id}/preview	Preview file
GET	/storage/mt940	Отримує колекцію ресурсів Storage.
POST	/storage/upload	Створює ресурс Storage.

Поля схеми

Поле	Тип	Опис
id	string
relationName*	string
relationId*	string
size	integer
mimeType	string

Тип документа

Endpoints

GET	/document-types	Отримує колекцію ресурсів DocumentType.
POST	/document-types	Створює ресурс DocumentType.
GET	/document-types/{id}	Отримує ресурс DocumentType.
PATCH	/document-types/{id}	Оновлює ресурс DocumentType.

Поля схеми

Поле	Тип	Опис
name*	string
relationName*	string
required	boolean
expiring	boolean
description	stringnull

Запит на підпис

Endpoints

GET	/signature-requests	Отримує колекцію ресурсів SignatureRequest.
POST	/signature-requests	Створює ресурс SignatureRequest.
GET	/signature-requests/{id}	Отримує ресурс SignatureRequest.
DELETE	/signature-requests/{id}	Видаляє ресурс SignatureRequest.
GET	/signature-requests/{id}/signature-status	Live per-signer signing status for a signature request.

Поля схеми

Поле	Тип	Опис
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)