Supported URL-Parameters
Presets
name |
string |
fills the "Name" textfield |
|
string |
fills the "E-mail" textfield |
reason |
string |
fills the "Purpose" textfield |
location |
string |
fills the "Location" textfield |
certify |
boolean |
controls the "Certify" checkbox, default is false (“last signature on a pdf”) |
embedFonts |
boolean + "detect" |
keeps PDF/A compliance (under the assumption the rest of the document previously was compliant) – signature is visible and has text, adds the font of the signature box. Detect only enables the option if other fonts were embedded before. In case of multiple documents in the signer at once, each pdf is evaluated individualy by "detect" |
signatureVisible |
boolean |
determines whether the signature is visible when optically viewed/printed, default is true |
picturebase64 |
string |
this is the base64 encoded image (has no legal meaning, but QES newbies like it) |
userName login |
string |
fills the "Login" textfield for initial authorization of the signature towards PrivaSphere |
password |
string |
fills the "Password" textfield (attention: saving this in your favorites does not encrypt it – similarly, in the exported json configuration, it is not protected, but plain visible) |
hidePasswordField |
boolean |
disables the "Password" textfield – default is false. If you opt-out from “initial authorization of the signature towards PrivaSphere”, there is one less step, but attackers might create MobileID authorization requests for rogue documents. If you want to simplify the steps, doing the “initial authorization of the signature towards PrivaSphere” can be easily done with SSO / IDP – the end- user doesn’t notice the authorization towards PrivaSphere, but it is of high quality. |
lang |
"de" or "en" |
changes the signers language, default is en |
focusPage |
int + "first" |
on what page the signature box shows up, default is last |
boxleft |
int |
distance between signature box and left side of the document in px |
boxtop |
int |
distance between signature box and top of the document in px |
boxwidth |
int |
width of the signature box in px |
boxheight |
int |
height of the signature box in px |
noAlert |
boolean |
disables the success popup |
showSecSend |
boolean |
enables the offer to send the signed file |
sigUploadUrl |
string |
the URL of the plaform user for “secure sending” |
provider |
string |
url to which the document hashes will be sent and from which the signature-byteArray comes back that will be inserted into the document discretely inside the browser |
pictureName |
string |
the name of signature image file (only for debugging purposes if you have multiple similar versions of that image file) |
pictureContentType |
string |
MIME-Type of the signature image file |
Parameters to interact with an external repository
downloadUrl | String | json |
String : When using an external file storage system (e.g. NextCloud, SharePoint) to access the signer, points to the URL of the PDF that the signer will download and sign Alternatively, json: When using an external file storage system (e.g. NextCloud, SharePoint) to access the signer, points to the URL of the json that the signer will read and use to download one or multiple PDF files linked inside of it. |
uploadUrl | string |
When using an external file storage system (e.g. NextCloud, SharePoint) to access the signer, points to the URL where the signer will upload the previously downloaded and now signed file |
externalSource | string |
Specifies the external file storage system used for this instance of the signer (Currently supports "sharepoint" and "nexcloud") |
externalSourceAuthHeader |
string |
Access privileges sent by the external file storage system to access the downloadUrl and uploadUrl paths – this should be a short-lived one-time authenticator to prevent users/attackers from sharing it. The same can be achieved if the URLs are hard-to-guess one-time URLs. The download-URL can have a really short livetime (< 1 minute) while the upload should be valid for the anticipated duration of the end-user signing the document. If the PDFS Signer is embedded in the client's external source, there is no need for short-lived URLs as the system is secure at all times. |
For example for SharePoint, a File-context menu snippet can be integrated into the sharePoint menu/GUI that creates these 4 parameters without any further user input on the fly. For more information please see download the integration guide.
generic remarks
- boolean: "1"/"0"/"treue"/"false"
- string: text spaces are "%20" (i.e. name=John%20Doe) – see also https://de.wikipedia.org/wiki/URL-Encoding
- int: whole numbers
-
planned - not yet implemented
- fontSize (of the siganture box)
- dateString
- certificationLevel (as a sub-item to 'certify')
Example URL:
see also Signer Profile Export