Documentos e assinaturas

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

Esta referência é gerada a partir do esquema da API. As descrições dos campos e qualquer texto ainda não traduzido são apresentados em inglês.

Documento

Endpoints

Documento: Endpoints
MétodoCaminho
GET/documents
POST/documents
GET/documents/{id}
PATCH/documents/{id}
DELETE/documents/{id}
GET/documents/action-needed

Campos de schema

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

Armazenamento

Endpoints

Armazenamento: Endpoints
MétodoCaminho
GET/storage/{id}
DELETE/storage/{id}
GET/storage/{id}/preview
GET/storage/mt940
POST/storage/upload

Campos de schema

Armazenamento: Campos de schema
CampoTipo
idstring
relationName*string
relationId*string
sizeinteger
mimeTypestring

Tipo de Documento

Endpoints

Tipo de Documento: Endpoints
MétodoCaminho
GET/document-types
POST/document-types
GET/document-types/{id}
PATCH/document-types/{id}

Campos de schema

Tipo de Documento: Campos de schema
CampoTipo
name*string
relationName*string
requiredboolean
expiringboolean
descriptionstringnull

Pedido de Assinatura

Endpoints

Pedido de Assinatura: Endpoints
MétodoCaminho
GET/signature-requests
POST/signature-requests
GET/signature-requests/{id}
DELETE/signature-requests/{id}
GET/signature-requests/{id}/signature-status

Campos de schema

Pedido de Assinatura: Campos de schema
CampoTipo
idstring
documentTitlestring
statusstringnull
sentAtstring,null (date-time)
completedAtstring,null (date-time)
sourceFilenamestringnull
signersSummaryarray
contractstring,null (iri-reference)
createdAtstring (date-time)