signProperties (required)
| 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
} |
padesSignProperties
(required)
| JSON object: key | type | description | default value |
|---|
addVisualSeals
| boolean | If true, add visual signature seals to PDF. | (required) |
| "padesSignProperties": {
"addVisualSeals": true
} |
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, i.e. "My order name - 1" for the first document. | (optional) | pdf
| string | Base64 encoded PDF | (required) | endUserOnly | boolean | Set to true if only the end user signature is desired.
| false | merchantSealPos
| JSON object: key | type | description |
|---|
x
| number | Horizontal positioning of seal. | y
| number | Vertical positioning of seal. | page
| integer | Page number to place seal. |
| Specifies the position of merchant signature seal in PDF. The seal will be positioned according to the x and y coordinates (in points) with origin in the upper left corner. The visual seal size is adjusted according to the DPI of the document. If the page number is out of range it will be the seal will be placed on the first page. If the coordinates are out of bounds the seal will be placed below and left of existing seals or in the upper left corner if no other seals exist. See COI documentation for further details. | (optional) | endUserSealPos
| JSON object: | key | type | description |
|---|
x | number | Horizontal positioning of seal. | y | number | Vertical positioning
of seal. | page | integer | Page number to place seal. |
| Specifies the position of merchant signature seal in PDF. The seal will be positioned according to the x and y coordinates (in points) with origin in the upper left corner. The visual seal size is adjusted according to the DPI of the document. If the page number is out of range it will be the seal will be placed on the first page. If the coordinates are out of bounds the seal will be placed below and left of existing seals or in the upper left corner if no other seals exist. See COI documentation for further details. | (optional) |
Be aware that very large PDF files, typically files with a large number of images, might give a less than optimal user experience due to the document processing time. The total package size has no upper limit,but we recommend to keep the total size below 35MB.
| "documents": [
{ "description": "My document",
"pdf": "JVBER...",
"merchantSealPos": {
"x": 100,
"y": 80,
"page": 1
},
"endUserSealPos": {
"x": 200,
"y": 80,
"page": 1
}
}
] |
resultContent
(required) | JSON array of string. Must contain at either padesSignedPdf, or padesAppendix, or both. The string values will determine the content result when retrieving a completed sign order later: | result specifier | description |
|---|
padesSignedPdf | Result contains the signed PDF as a base64 encoded string | documentHash | Result contains the SHA256 hash over the unsigned and sign document hash | padesAppendix | Result contains the appended signature data to the original PDF document as a base64 encoded string |
| ["padesSignedPdf", "padesAppendix", "documentHash"] |
