Documents et signatures

Documents, stockage et demandes de signature électronique — importez, organisez et signez des fichiers.

Document

Points de terminaison

GET	/documents	Récupère la collection de ressources Document.
POST	/documents	Crée une ressource Document.
GET	/documents/{id}	Récupère une ressource Document.
PATCH	/documents/{id}	Met à jour la ressource Document.
DELETE	/documents/{id}	Supprime la ressource Document.
GET	/documents/action-needed	Récupère la collection de ressources Document.

Champs de schéma

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

Stockage

Points de terminaison

GET	/storage/{id}	Récupère une ressource Storage.
DELETE	/storage/{id}	Supprime la ressource Storage.
GET	/storage/{id}/preview	Preview file
GET	/storage/mt940	Récupère la collection de ressources Storage.
POST	/storage/upload	Crée une ressource Storage.

Champs de schéma

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

Type de document

Points de terminaison

GET	/document-types	Récupère la collection de ressources DocumentType.
POST	/document-types	Crée une ressource DocumentType.
GET	/document-types/{id}	Récupère une ressource DocumentType.
PATCH	/document-types/{id}	Met à jour la ressource DocumentType.

Champs de schéma

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

Demande de signature

Points de terminaison

GET	/signature-requests	Récupère la collection de ressources SignatureRequest.
POST	/signature-requests	Crée une ressource SignatureRequest.
GET	/signature-requests/{id}	Récupère une ressource SignatureRequest.
DELETE	/signature-requests/{id}	Supprime la ressource SignatureRequest.
GET	/signature-requests/{id}/signature-status	Live per-signer signing status for a signature request.

Champs de schéma

Champ	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)