Batch signature
Signing a batch is done with the following steps. First, the batch is opened. Second, the documents to be signed are added to the batch. At least one document is required, but up to 200 documents can be added. Afterwards, the batch has to be closed. This can be done either by starting a mobile signature or by starting a seal signature. Finally, the signed documents can be downloaded.
State - initial
Create a new signature batch
To be able to sign documents, it is required to open a batch. This can be done with a HTTP POST call. Two HTTP multipart/form-data parameter are supported:
- RedirectUrl The user will be redirected to the URL after a successful signature
- ErrorUrl The user will be redirected to the URL when the signing process fails
State - batch open
Add document
This call is used to add documents to an open signature batch. It is required to add at least one document. The maximum number of documents supported by the Handy- Signature is 200. There are three options to use this call: The first option is just to use the required parameter (location, reason and document). This will result in an invisible signature. As second option, the ID of the template can be set additionally with the template Parameter. In this case, a figurative mark is placed on the PDF. It is placed on the default location as defined in template. As third option, the placement options for the figurative mark can be given explicitly. When placement parameters are provided in userspace units[^1]. After all documents have been added, the batch can be signed with Handy-Signature or (if configured) with a.sign Seal.
Option Template: Specifying image position explicitly
| Name | Type | Description |
|---|---|---|
| document | File | The document to sign |
| location | string | Location of the signature |
| reason | string | Reason of the signature |
| template | string | ID of the template |
| x | string | X0 in userspace units[^1] |
| y | string | Y0 in userspace units[^1] |
| w | string | X1 in userspace units[^1] |
| h | string | Y1 in userspace units[^1] |
| page | string | page of the signature seal |
** Option Placeholder** (to make the template workflows easier): In this case, a document with a placeholder image is needed. The image needs to have an EXIF image description in the meta-data (see figure below). In order to create an image containing the required meta-data, the following applications can be used:
The resulting image can then be imported into the text processing software that will be used to create the PDF to be signed. Make sure that the meta-data is not lost during the export. When performing multiple signatures, different images have to be inserted into the source document, since identical images are optimized out in the export process.
| Name | Type | Description |
|---|---|---|
| document | File | The document to sign |
| location | string | Location of the signature |
| reason | string | Reason of the signature |
| template | string | ID of the template |
| page | string | must be -1 |
Sign batch with Handy-Signature
To close the the batch and sign the contained documents, an other REST call is required:
Sign batch with a.sign Seal
Instead of Handy-Signature, the documents can be signed with a corporate certificate (a.sign Seal). Therefore, instead of mobilesignature, the sealsignature REST call should be used. It is possible to use one certificate per API Key. The configuration has to be done by A-Trust.
This call closes the the batch and signs the documents. These can be retrieved in the same way as after a Handy-Signatur, no further action is required. A sample request looks like:
State - signature Finished
Get signer certificate
After a signature, the signer certificate can be requested.
Get a signed document
When the signature process is finished, the signed documents can be received with an HTTP DELETE call. It has to contain the ticket and the document id. After requesting the last document of the batch, the session data is deleted. Afterwards, it is not possible to request the user certificate.
Footnotes
[^1] https://opensource.adobe.com/dc-acrobat-sdk-docs/library/interapp/IAC_API_CoordinateSystems.html