CIB doXisign technischer Leitfaden
3. Serverseitige REST-Schnittstelle
3.1. Signaturprozess starten
Post |
<baseUrl>/rest/process/create |
File |
Das PDF welches Unterschrieben werden soll. Es muss mindestens ein Signaturfeld besitzen und mehrere Signaturfelder dürfen nicht die gleiche ID haben. |
sealDocument |
Legt fest ob das Dokument nach der Unterschrift versiegelt werden soll, dadurch können keine Änderungen mehr gemacht werden (z. B. Formularfelder ausfüllen). Aktuell sind die Werte „FirstSignature“ und „NoSeal“ (default) erlaubt. |
requireName |
Legt fest ob der Unterzeichner seinen Namen eingeben muss (dieser wird nicht verifiziert) |
requireMail |
Legt fest ob der Unterzeichner seine E-Mail-Adresse angeben muss. Diese wird dann Verifiziert indem eine E-Mail mit einem verifikationslink an die Angegebene Adresse gesendet wird. |
requireSms |
Legt fest ob der Unterzeichner seine Handynummer angeben muss. Diese wird dann Verifiziert indem eine SMS mit einem Code an die angegebene Nummer gesendet wird. Dieser Code muss in einem Folgeschritt eingegeben werden. |
return |
JSON mit der generierten Prozess-ID welche für alle anderen aufrufe benötigt wird. |
Es kann keine Unterschrift geleistet werden solange die benötigten Angaben (requireName, requireMail, requireSms) nicht gemacht und Verifiziert wurden. Diese Voraussetzung gilt für alle Unterschriften auf diesem Dokument.
Sollten diese optionalen Angaben fehlen werden die Standardeinstellungen (siehe Konfiguration) benutzt.