Documentos y firmas

Documentos, almacenamiento y solicitudes de firma electrónica — sube, organiza y firma archivos.

Documento

Endpoints

GET	/documents	Recupera la colección de recursos Document.
POST	/documents	Crea un recurso Document.
GET	/documents/{id}	Recupera un recurso Document.
PATCH	/documents/{id}	Actualiza el recurso Document.
DELETE	/documents/{id}	Elimina el recurso Document.
GET	/documents/action-needed	Recupera la colección de recursos Document.

Campos de schema

Campo	Tipo	Descripción
documentType*	string (iri-reference)
relationId*	integernull
relationUuid	stringnull
expiringAt	string,null (date-time)
storage*	string (iri-reference)
notes	stringnull

Almacenamiento

Endpoints

GET	/storage/{id}	Recupera un recurso Storage.
DELETE	/storage/{id}	Elimina el recurso Storage.
GET	/storage/{id}/preview	Preview file
GET	/storage/mt940	Recupera la colección de recursos Storage.
POST	/storage/upload	Crea un recurso Storage.

Campos de schema

Campo	Tipo	Descripción
id	string
relationName*	string
relationId*	string
size	integer
mimeType	string

Tipo de Documento

Endpoints

GET	/document-types	Recupera la colección de recursos DocumentType.
POST	/document-types	Crea un recurso DocumentType.
GET	/document-types/{id}	Recupera un recurso DocumentType.
PATCH	/document-types/{id}	Actualiza el recurso DocumentType.

Campos de schema

Campo	Tipo	Descripción
name*	string
relationName*	string
required	boolean
expiring	boolean
description	stringnull

Solicitud de Firma

Endpoints

GET	/signature-requests	Recupera la colección de recursos SignatureRequest.
POST	/signature-requests	Crea un recurso SignatureRequest.
GET	/signature-requests/{id}	Recupera un recurso SignatureRequest.
DELETE	/signature-requests/{id}	Elimina el recurso SignatureRequest.
GET	/signature-requests/{id}/signature-status	Live per-signer signing status for a signature request.

Campos de schema

Campo	Tipo	Descripción
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)