📂Folders

Create a folder

Create a folder

post

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.

Body

namestringRequired

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

Example: name

redirectUrlstringOptional

Responses

*/*

objectOptional

post

HTTPcURLJavaScriptPython

POST /services/document-folders HTTP/1.1
Host: professional.signius.eu:8970
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "name",
  "redirectUrl": "text"
}

200

OK

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

Upload a document

Upload a document

post

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.

Path parameters

documentFolderIdstring · uuidRequired

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

filestring · binaryRequired

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 · binaryOptional

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.

Responses

*/*

objectOptional

post

HTTPcURLJavaScriptPython

POST /services/document-folders/{documentFolderId}/documents HTTP/1.1
Host: professional.signius.eu:8970
Content-Type: multipart/form-data
Accept: */*
Content-Length: 42

{
  "file": "binary",
  "fileThumbnail": "binary"
}

200

OK

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

Delete a folder

Delete a folder

delete

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.

Path parameters

documentFolderIdstring · uuidRequired

The id of the deleted folder

Responses

*/*

objectOptional

delete

HTTPcURLJavaScriptPython

DELETE /services/document-folders/{documentFolderId}/ HTTP/1.1
Host: professional.signius.eu:8970
Accept: */*

200

OK

{}