The signdoc API is used in the context of SEID-SDO electronic signing. For a quick-start, please refer to our Get started with electronic signing guide for electronic signing.

1 Overview
2 Upload sign order to SignDoc resource server
- 2.1 Request
- 2.2 Example request
- 2.3 Response
3 Check status of sign order
- 3.1 Request
- 3.2 Example request
- 3.3 Response
4 Delete sign order and download signing results
- 4.1 Request
- 4.2 Example request
- 4.3 Response
5 Additional examples of sign order upload requests to SignDoc resource server
- 5.1 Simplified sign flow expressed like a full flow
- 5.2 SEID-SDO: Two texts and one XML

Overview

URL	`https://<`signdoc-baseurl`>/signdoc`
Authorization	Access Token as Bearer Token in Authorization Header

Upload sign order to SignDoc resource server

POST [signdoc-baseurl]/signdoc

Request

Headers

Key	Value

Key	Value
Authorization	Bearer `access_token`
Content-Type	application/json

Request body

Key	Type / Description	Example JSON

Key

Type / Description

Example JSON

signProperties

JSON object:

key	type	description	default value
`orderName`	string	Order name	(required)
`documentDisplayMode`	string	Must be "interior", "window" or "overlay".	"interior"
`showConfirmation`	boolean	Show "Signing completed" in client after signing.	true
`showUnderstanding`	boolean	Show box for "Content is understood" in client.	true
`timeoutSeconds`	integer	Timeout in seconds for end user signing.	1800

"signProperties": {
"orderName": "My order name",
"documentDisplayMode": "interior",
"showConfirmation": true,
"showUnderstanding": true,
"timeoutSeconds": 1800
}

documents

JSON array of documents to be signed (minimum one).

The document to be signed is represented as a JSON object:

key	type	description	default value
`description`	string	Description of document. Displayed to end user in client. If not specified, orderName from signProperties will be used combined with a number, e.g. "My order name - 1" for the first document.	(optional)
`text`	string	Text to sign.	(optional)*
`pdf`	string	Base64 encoded PDF.	(optional)*
`xml`	string	XML. Must be used together with "xsl".	(optional)*
`xsl`	string	XML Stylesheet. Must be used together with "xml".	(optional)*

*Each document must provide a value for either "text", "pdf" or the pair "xml" and "xsl".

"documents": [
{
"description": "My PDF document",
"pdf": "JVBER..."
},
{
"description": "My text",
"text": "My text to sign...",
},
{
"xml": "<?xml version=\"1.0\" encoding=\"ISO-8859-1\" ?> ...",
"xls": "<?xml version=\"1.0\" encoding=\"ISO-8859-1\" ?><xsl:stylesheet ..."
}
]

resultContent

JSON array of string.

The string values will determine the content result when retrieving a completed sign order:

result specifier	description
`basicSignature`	Result contains the end user and merchant signatures (in ISO-8859 text format)
`documentHash`	Result contains the SHA256 hash over the documents to be signed (in UTF-8 text format).
`sdo`	Result contains the documents and signature data in the SEID-SDO format.

["basicSignature", "documentHash", "sdo"]