Documenti e firme

Documenti, archiviazione e richieste di firma elettronica — carica, organizza e firma i file.

Questo riferimento è generato dallo schema API. Le descrizioni dei campi e qualsiasi testo non ancora tradotto sono mostrati in inglese.

Documento

Endpoint

Documento: Endpoint
MetodoPercorso
GET/documents
POST/documents
GET/documents/{id}
PATCH/documents/{id}
DELETE/documents/{id}
GET/documents/action-needed

Campi schema

Documento: Campi schema
CampoTipo
documentType*string (iri-reference)
relationId*integernull
relationUuidstringnull
expiringAtstring,null (date-time)
storage*string (iri-reference)
notesstringnull

Archiviazione

Endpoint

Archiviazione: Endpoint
MetodoPercorso
GET/storage/{id}
DELETE/storage/{id}
GET/storage/{id}/preview
GET/storage/mt940
POST/storage/upload

Campi schema

Archiviazione: Campi schema
CampoTipo
idstring
relationName*string
relationId*string
sizeinteger
mimeTypestring

Tipo di documento

Endpoint

Tipo di documento: Endpoint
MetodoPercorso
GET/document-types
POST/document-types
GET/document-types/{id}
PATCH/document-types/{id}

Campi schema

Tipo di documento: Campi schema
CampoTipo
name*string
relationName*string
requiredboolean
expiringboolean
descriptionstringnull

Richiesta di firma

Endpoint

Richiesta di firma: Endpoint
MetodoPercorso
GET/signature-requests
POST/signature-requests
GET/signature-requests/{id}
DELETE/signature-requests/{id}
GET/signature-requests/{id}/signature-status

Campi schema

Richiesta di firma: Campi schema
CampoTipo
idstring
documentTitlestring
statusstringnull
sentAtstring,null (date-time)
completedAtstring,null (date-time)
sourceFilenamestringnull
signersSummaryarray
contractstring,null (iri-reference)
createdAtstring (date-time)