API Documentation
docs.signius.eu
SEAL
SEAL
  • ๐ŸฆญSIGNIUS SEAL API Documentation
  • Server Methods
    • ๐ŸŽ’Batch Methods
    • ๐Ÿ“„Document Methods
    • ๐Ÿ“ˆProcess Methods
    • ๐Ÿ”ขStats Method
    • ๐Ÿฅ”TSA Methods
  • Client Methods
    • ๐Ÿ“ฒDocument Methods
Powered by GitBook
On this page
  • Create new batch
  • Create new batch
  • Upload package (ZIP)
  • Upload package (ZIP)
  • Get batch status
  • Get batch status
  • Delete batch from the cache
  • Delete batch from the cache
  • Accept batch
  • Accept batch
  • Download signed batch
  • Download signed batch
  1. Server Methods

Batch Methods

Batch methods are used to start the process of signing, upload files, which are meant to be signed, download signed files and delete the batch from the cache.

A batch is a package that contains files for sign or validation. The package format is ZIP (without directories).

Create new batch

Create new batch

POST /api/CreateBatch/{processId}

Method is used to create new batch with an assigned processID.

Path Parameters

Name
Type
Description

processId*

Integer

Example response:
{
    "id": โ€œ2123โ€,
    "providerSettingsId": โ€œ1โ€,
    "creationDate": "2023-01-01 12:00:00",
    "status": โ€œ1โ€
}

Upload package (ZIP)

Upload package (ZIP)

POST /api/upload/{batchId}

Method is used to upload a file to the batch. The BatchId value generated and returned during the CreateBatch (2.1.1) operation. The contents of the zip file should be sent as a binary octet stream (https://www.iana.org/assignments/media-types/application/octet-stream)

Path Parameters

Name
Type
Description

batchId*

Integer

Request Body

Name
Type
Description

<binary-octet-stream>

<binary-octet-stream>

Example response:
{
    "id": "1โ€,
    "counterpartyId": โ€œ1โ€,
    "name": "file_name.pdf",
    "signed": "falseโ€,
    "hash": null,
    "signature": null,
    "batchId": 2123,
    "creationDate": "2023-01-01 00:00:00",
    "isZip": "trueโ€,
    "tsaId": โ€œ1โ€
}

Get batch status

Get batch status

GET /api/BatchStatus/{batchId}

Use this method to get an information about the status of the batch. Possible statuses below.

Path Parameters

Name
Type
Description

batchId

Integer

Example response:
{
    "id":2123,
    "status": "READY",
    "creationDate": "2023-01-01 10:00:00",
    "documents": [
        {
            "id": "1โ€,
            "signed": "falseโ€,
            "fileName": "test.pdf",
            "signingResult_Success": "false"
        }
    ]
}

Possible statuses

Id
Value
Description

0

NEW

New batch successfully created

1

ACCEPTED

Batch successfully created

2

READY

For internal use

3

IN_PROGRESS

Signing/stamping process in progress

4

FINISHING

For internal use

5

CLOSED

Batch closed, ready for download

6

DELETED

Batch romoved from cache

Delete batch from the cache

Delete batch from the cache

DELETE /api/BatchDeleteCache/{batchId}

This method removes the batch from the cache on the server side

Path Parameters

Name
Type
Description

batchId*

Integer

Example response:
{
    "id":2123,
    "status": "DELETED",
    "creationDate": "2023-01-01 10:00:00",
    "documents": [<โ€œarray of documentsโ€>]
}

Accept batch

Accept batch

POST /api/AcceptBatch

This method accepts batch, starts the signature/validation process

Path Parameters

Name
Type
Description

batchId

Integer

Example response:
{
    "id": 2123,
    "providerSettingsId": โ€œ1โ€,
    "creationDate": "2023-01-01 10:00:00",
    "status": โ€œ0โ€
}

Download signed batch

Download signed batch

GET /api/batchfile/{batchId}

This method provides a signed package for download

Path Parameters

Name
Type
Description

batchId

Integer

Exaple response:

binary octet stream (https://www.iana.org/assignments/media-types/application/octet-stream)

PreviousSIGNIUS SEAL API DocumentationNextDocument Methods

Last updated 8 months ago

๐ŸŽ’