Documentos e assinaturas

Documentos, armazenamento e pedidos de assinatura eletrónica — carregue, organize e assine ficheiros.

Documento

Endpoints

GET	/documents	Recupera a coleção de recursos Document.
POST	/documents	Cria um recurso Document.
GET	/documents/{id}	Recupera um recurso Document.
PATCH	/documents/{id}	Atualiza o recurso Document.
DELETE	/documents/{id}	Remove o recurso Document.
GET	/documents/action-needed	Recupera a coleção de recursos Document.

Campos de schema

Campo	Tipo	Descrição
documentType*	string (iri-reference)
relationId*	integernull
relationUuid	stringnull
expiringAt	string,null (date-time)
storage*	string (iri-reference)
notes	stringnull

Armazenamento

Endpoints

GET	/storage/{id}	Recupera um recurso Storage.
DELETE	/storage/{id}	Remove o recurso Storage.
GET	/storage/{id}/preview	Preview file
GET	/storage/mt940	Recupera a coleção de recursos Storage.
POST	/storage/upload	Cria um recurso Storage.

Campos de schema

Campo	Tipo	Descrição
id	string
relationName*	string
relationId*	string
size	integer
mimeType	string

Tipo de Documento

Endpoints

GET	/document-types	Recupera a coleção de recursos DocumentType.
POST	/document-types	Cria um recurso DocumentType.
GET	/document-types/{id}	Recupera um recurso DocumentType.
PATCH	/document-types/{id}	Atualiza o recurso DocumentType.

Campos de schema

Campo	Tipo	Descrição
name*	string
relationName*	string
required	boolean
expiring	boolean
description	stringnull

Pedido de Assinatura

Endpoints

GET	/signature-requests	Recupera a coleção de recursos SignatureRequest.
POST	/signature-requests	Cria um recurso SignatureRequest.
GET	/signature-requests/{id}	Recupera um recurso SignatureRequest.
DELETE	/signature-requests/{id}	Remove o recurso SignatureRequest.
GET	/signature-requests/{id}/signature-status	Live per-signer signing status for a signature request.

Campos de schema

Campo	Tipo	Descrição
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)