API description

Issue

The IdentRecord service described in Identity interface and Identity record returns this URL. The parameter token is also returned from the IdentRecord service.

In response to a HTTP POST to this URL, a ticketId and a startUrl are returned.

The ticketId is used in subsequent requests.

The user should be redirected to startUrl to accept the legal documents and issue the certificate.

After the certificate is issued, the user (browser) is redirected to the redirectUrl or, in case of an error, to the errorUrl.

Get certificate

Once the certificate has been issued according to the request in the chapter 1.1, the issued certificate can be downloaded via this URL.

Start signature

For signing, the hash values (hashes) must be uploaded. These also contain a document name (name) for display and a link (uri) to the original document so the user can view it.

The response contains a startUrl, the generated document IDs (docId) alongside the document name (name), which are later used to download the signature. The (docId) are in the same order as the uploaded hash values.

The user should be redirected to startUrl to sign the documents.

After the signature process is complete, the user (browser) is redirected to the redirectUrl or, in case of an error, to the errorUrl.

Get signature

Download all available signature, including the docId for reference. The hash and signature values are deleted from the server after downloading.

Get session info

Request to get the validity of the current session and the validity of the private key.

Close session

HTTP request to delete the session. Can be called at any time to cancel the transaction or end the session and prevent future signatures.