Overview
Quick reference
| URL | Method | Functionality |
|---|---|---|
| signaturebatches | POST | Open a new batch |
| signaturebatches/<ticket>/documents | POST | Add a document to a given batch |
| signaturebatches/<ticket>/mobilesignature | POST | Sign the batch with Handy-Signatur |
| signaturebatches/<ticket>/sealsignature | POST | Sign the batch with a.sign Seal |
| signaturebatches/<ticket>/documents/<id> | DELETE | Get the signed document |
| signaturebatches/<ticket>/certificate | GET | Get the used certificate |
| statelesssealsignature | POST | Directly sign a document with a.sign Seal |
| templates | POST | Add template |
| templates | GET | List templates |
| templates/<id> | GET | Get template |
| templates/<id> | PUT | Replace template |
| templates/<id> | DELETE | Delete template |
API Key
Every call has to be authorized with an API key. Therefore, the X-API-KEY HTTP header has to be set to the corresponding API key. An API key for testing can requested from A-Trust.
Generic return codes
The following return codes can be returned for every REST call. Therefore, they are not explicitly mentioned.
- 401 UNAUTHORIZED Call not allowed
- 500 INTERNAL SERVER ERROR Error handling the request
Timeouts
There are the following Timeouts:
User-Timeout (5 min) User has to complete the entry of their two factors in the ATrust Dialog in this period. The process gets terminated and has to be restarted from the beginning.
Signaturbox-Timeout (15 min) This timeout spans the process of creating the batch and the user interaction. When the user is redirected to the SUCCESS-Url the timeout is reset and starts again for downloading the docuemnts. The session cannot be resumed.
GDPR-Timeout (daily) There is a daily cleanup job which removes all usuccessfull session-data (including documents) if they are older than 24 hours.
GDPR
A-Trust SignatureBox is designed to store as little data as possible and delete the data as soon as possible according to the data minimizatin requirement of GDPR:
- After successful download the document is deleted immediately.
- After all documents of a signature Batch are successfully downloaded the session data is deleted.
- All dangling data (including documents) of sessions which have timed out are deleted daily.