📂Folders

Create a folder

Create a folder

A signature initiator creates and names a folder. Creating a folder is obligatory to upload files for singing. If the request has been successful, the documentFolderId is returned as a response.

POSThttps://professional.signius.eu:8970/services/document-folders

Body

application/json

name*string

Document folder name. The allowed signs are: A-Ź a-ź 0-9,.'!@#$%^&()-=_+ and space character.

Example: "name"

redirectUrlstring

Response

200

OK

Body

*/*

documentFolderIdstring (uuid)

Request

JavaScriptCurlPython

const response = await fetch('https://professional.signius.eu:8970/services/document-folders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "name"
    }),
});
const data = await response.json();

Response

200

{
  "documentFolderId": "123e4567-e89b-12d3-a456-426614174000"
}

Upload a document

Upload a document

To add a document to an existing folder a signature initiator needs to upload it. If request is successful, the documentId is returned as a response.

POSThttps://professional.signius.eu:8970/services/document-folders/{documentFolderId}/documents

Path parameters

documentFolderId*string (uuid)

The id of the folder that we want to use for adding the document. It is retrieved from Create Folder request. This parameter is placed in the path of the request endpoint to navigate to the right resource location.

Body

multipart/form-data

file*string (binary)

The document that we want to upload for signing purposes. It should be in PDF format and must not exceed 10 MB in size. Furthermore the name of the document should not be repeated within a folder.

fileThumbnailstring (binary)

The document thumbnail that is placed in GUI version of the system. It should be in PNG format. It will be generated automatically if not present using first page of pdf document.

Response

200

OK

Body

*/*

documentIdstring (uuid)

Request

JavaScriptCurlPython

const response = await fetch('https://professional.signius.eu:8970/services/document-folders/{documentFolderId}/documents', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "binary"
    }),
});
const data = await response.json();

Response

200

{
  "documentId": "123e4567-e89b-12d3-a456-426614174000"
}

Delete a folder

Delete a folder

Removes a folder from the system. In case you wish to delete the folder in which you have signed documents  – your request will be rejected. You must delete your documents first, to be able to remove the folder, while you can delete the folder along with documents that have not yet been signed.

DELETEhttps://professional.signius.eu:8970/services/document-folders/{documentFolderId}/

Path parameters

documentFolderId*string (uuid)

The id of the deleted folder

Response

200

OK

Body

*/*

object

Request

JavaScriptCurlPython

const response = await fetch('https://professional.signius.eu:8970/services/document-folders/{documentFolderId}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();