Unterzeichner hinzufügen

Parametername

Typ

Pflichtfeld

Beschreibung

envelopeId

string

true

Umschlag-ID

signerInfos

array

true

Sammlung der Unterzeichnerinformationen

businessId

string

false

Vom Entwickler benutzerdefinierte Geschäftsnummer, Länge 500

roleTypes

array

false

Unterzeichner-Aktionsmethode, Standardwert ist ["sign", "fill"]

fill – Ausfüllen

sign – Unterschreiben

string

false

userEmail

string

false

E-Mail-Adresse des Unterzeichners

documentVisibility

object

false

Konfiguration der Sichtbarkeit von Dateien, standardmäßig sind alle sichtbar.

documentViewType

string

false

Sichtbarkeitsrichtlinie, Standardwert ist all; all bedeutet, dass alle Unterlage im Umschlag eingesehen werden können, limited bedeutet, dass nur die eigenen Unterlage und ergänzend sichtbare Unterlage eingesehen werden können.

viewableFileKeys

array

false

Liste der fileKeys, die dem Unterzeichner zusätzlich zum Anzeigen erlaubt sind; kann nur eingegeben und gilt nur, wenn documentViewType=limited ist.

phoneNumber

object

false

Bei Bedarf an SMS-Benachrichtigungen erforderlich; countryCode und number müssen als Parameter übergeben werden, Standardwert ist leer.

countryCode

string

false

Internationale Vorwahl des Landes/der Region, das '+' Zeichen muss nicht eingegeben werden.

number

string

false

Keine Formatprüfung, maximale Länge beträgt 13 Stellen.

customizeSettings

object

false

Benutzerdefinierte Konfiguration

notificationSettings

object

false

Benutzerdefinierte Konfiguration für Benachrichtigungen

customizeMessage

string

false

Exklusive Nachrichtenbenachrichtigung, Zeichengrenze 200

notificationLanguage

string

false

Benachrichtigungssprache, Standardwert wird aus der Konfiguration „Standardbenachrichtigungssprache“ übernommen.

en-US Englisch

zh-CN Vereinfachtes Chinesisch

zh-Hant Traditionelles Chinesisch

ja-JP Japanisch

es-MX Spanisch

pt-PT Portugiesisch
th-TH Thailändisch
id-ID Indonesisch
vi-VN Vietnamesisch
ms-MY Malaysisch
fil-PH Philippinisch
de-DE Deutsch
fr-FR Französisch
ru-RU Russisch
it-IT Italienisch
ko-KR Koreanisch

userName

string

true

Name des Unterzeichners, der auf der Unterzeichnungsseite und im Prozess zur externen Darstellung des Unterzeichners verwendet wird.

[Hinweis] Darf nicht folgende 9 Sonderzeichen enthalten: / \ : * " < > | ? sowie alle Emoji-Zeichen

signOrder

int

true

Unterschriftenreihenfolge des Unterzeichners, mindestens 1. Bei gleichzeitiger Unterschrift kann derselbe Reihenfolgenwert angegeben werden.

signTaskSuspend

boolean

false

Ob vor dieser Signierposition ein Prozessblockierungsknoten eingerichtet wird, standardmäßig false. true – Blockierungsknoten wird eingerichtet; false – Blockierungsknoten wird nicht eingerichtet. Die Blockierungskonfiguration innerhalb einer Or-Signiergruppe mit derselben signOrder muss konsistent sein.

suspensionKey

string

false

Kennzeichnung des Blockierungsknotens, maximal 500 Zeichen, innerhalb desselben Briefumschlags eindeutig. Erforderlich, wenn signTaskSuspend=true ist; darf nicht übergeben werden, wenn signTaskSuspend=false oder nicht angegeben ist.

suspendReason

string

false

Grund für die Blockierung, darf bei Übergabe nicht leer sein, maximal 50 Zeichen. Nur übertragbar, wenn signTaskSuspend=true ist; bei Nichtübertragung gilt standardmäßig, dass auf die Verarbeitung durch ein externes System gewartet werden muss. Darf nicht übergeben werden, wenn signTaskSuspend=false oder nicht angegeben ist.

anySigner

boolean

false

Ob das Unterschreiben durch eine beliebige Person unterstützt wird, standardmäßig false

true – Innerhalb derselben signOrder muss nur eine Person unterschreiben

false – Innerhalb derselben signOrder müssen alle Personen unterschreiben

authModes

string

false

Art der Identitätsprüfung, standardmäßig noAuth

Aufzählungstyp:

authConfig

object

false

Einstellung der Verifizierungsmethode

accessCode

object

false

Einstellung des Signierpassworts, erforderlich wenn authModes=accessCode, ist erforderlich

accessCode

string

false

Passwortinhalt, nicht case-sensitiv, kann alphanumerische Zeichen enthalten, maximale Länge 45

promptInfo

string

false

Hinweistext für das Zugriffs-Passwort, darf das Zugriffs-Passwort nicht enthalten, maximale Länge 30, erforderlich wenn authModes=accessCode, ist erforderlich.

sms

object

false

SMS-OTP-Verifizierung, erforderlich wenn authModes=sms, ist erforderlich

countryCode

string

false

Ländercode im internationalen Format, ohne „+“

number

string

false

Keine Formatprüfung, maximale Länge 13 Stellen

idVerification

object

false

Einstellung der Identitätsdokumentenverifizierung, erforderlich wenn authModes=idVerification, ist erforderlich

name

string

false

Vollständiger Name auf dem Ausweisdokument des Unterzeichners, maximale Länge 100 Zeichen

emailAuth

object

false

E-Mail-OTP-Prüfung, erforderlich wenn authModes=emailAuth, ist erforderlich

authEmail

string

false

E-Mail-Adresse zur Identitätsverifizierung des Unterzeichners

digitalId

array

false

Elektronische Identitätsverifizierung, erforderlich wenn authModes=digitalId

authApp

string

false

App für die elektronische Identitätsverifizierung

singpass-Identitätsverifizierung über Singpass

iamsmart-Identitätsverifizierung über myInfo

idNumber

string

false

Ausweisnummer des Unterzeichners zur Verifizierung

Wenn authApp=singpassGilt die Eingaberegeln: Großbuchstaben + 7 oder 8 Ziffern + Großbuchstaben

Wenn authApp=iamsmartGilt die Eingaberegeln:

1. Ein Großbuchstabe (A-Z) oder zwei Großbuchstaben (AA-ZZ) als Anfang der Sequenz;

2. gefolgt von 6 Ziffern;

3. abschließend eine Prüfziffer, die eine Zahl (0-9) oder ein Buchstabe (A-Z) sein kann. Beispiel: A888888(A)

whatsappAuth

object

false

WhatsApp OTP-Verifizierung, erforderlich wenn authModes=whatsappAuth

countryCode

string

false

Ländercode ohne „+“

number

string

false

Keine Formatvalidierung, nur maximale Länge von 13 Stellen beschränkt

digitalSignature

boolean

false

Ob die digitale Signatur aktiviert ist, Standardwert false

true- Aktiviert

false- Nicht aktiviert

tsp

string

false

Auswahl des vom Unterzeichner zu verwendenden TSP, Standardwert false.

Wenn nicht festgelegt, wählt der Unterzeichner selbst das zu verwendende TSP. Die Aufzählung umfasst:

vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni

belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia

estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom

harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId

mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign

smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe

certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha

freeFormSign

boolean

false

Ob der Unterzeichner frei signieren kann, Standardwert false

Ergänzende Hinweise:

Wenn freeFormSign auf true gesetzt ist, müssen keine weiteren Parameter unter sealInfos übergeben werden. Werden beide gleichzeitig übergeben, hat freeFormSign Vorrang vor sealInfos, und die Parameter unter sealInfos werden nicht wirksam.

[Hinweis] Freie Signatur bedeutet, dass die Anzahl und Position der Stempel/Unterschriften, die der Unterzeichner einfügen kann, nicht eingeschränkt sind.

sealInfos

array

false

Informationen zur Unterschriftsaufgabe

fileKey

string

true

fileKey der zu unterschreibenden Datei

signConfigs

array

false

Positionsinformationen des Steuerelements; die Positionsangaben des Steuerelements müssen angegeben sein, um eine elektronische Signatur durchführen zu können.

fieldType

string

false

Steuerelementtyp, Eingabeparameter:

signature- Unterschrifts-Steuerelement

stamp-Stempel-Steuerung

Standardmäßig signature

Pflichtfeld, standardmäßig erforderlich

true-Pflichtfeld

false-Nicht-Pflichtfeld

signFieldStyle

string

false

Art der Stempelplatzierung für die Unterschriftssteuerung, standardmäßig normalSeal.

normalSeal-Normaler Stempel

pagingSeal-Kantenstempel

Nur die Unterschriftssteuerung und die Stempel-Steuerung unterstützen die Einstellung eines Kantenstempels.

pagingSealMode

string

false

Seitenbereich für die Kantenstempelplatzierung, standardmäßig all.

all-Alle Seitennummern

assignedPages-Bestimmte Seitennummern

even-Gerade Seiten

odd-Ungerade Seiten

Nur unterstützt, wenn signFieldStyle=pagingSeal.

sizeRule

string

false

Anzeigeart der Größe des Signaturbereichs

originalSize- Platzierung basierend auf der tatsächlichen Größe von Unterschrift/Stempel

targetSize- Benutzerdefinierte Breite und Höhe des Unterschrift-/Stempelbereichs

Wenn sizeRule, height und width alle leer sind, erfolgt die Platzierung basierend auf der tatsächlichen Größe von Unterschrift/Stempel;

Wenn sizeRule leer ist, height und width jedoch nicht leer sind, erfolgt die Platzierung in der angegebenen Größe;

Wenn sizeRule nicht leer ist, erfolgt die Platzierung gemäß der angegebenen Anzeigeart;

Für Seitenstempel ist diese Parameter nicht erforderlich; die Platzierung erfolgt ausschließlich basierend auf der tatsächlichen Größe.

height

int

false

Höhe des Signatursteuerelements, gültig für fieldType=signature/stamp, Einheit px, nur positive Ganzzahlen sind zulässig, Standardwert auto (d. h. automatische Systemgröße);

Wenn fieldType=signature, kann der Bereich 20–250 px betragen;

Wenn fieldType=stamp, kann der Bereich 30–280 px betragen;

Für Seitenstempel ist dieser Parameter nicht erforderlich.

width

int

false

Breite des Signatursteuerelements, gültig für fieldType=signature/stamp, Einheit px, nur positive Ganzzahlen sind zulässig, Standardwert auto (d. h. automatische Systemgröße);

Wenn fieldType=signature, kann der Bereich 20–250 px betragen;

Wenn fieldType=stamp, kann der Bereich 30–280 px betragen;

Für das Stempel-Overlay ist diese Parameter nicht erforderlich.

signatureOptions

string

false

Optionen für das Signatur-Steuerelement. Gilt nur, wenn fieldType den Wert signature hat.

Mögliche Eingabeparameter:

template

handDrawn

upload

aiHandDrawn

Mehrere Werte möglich, durch Komma getrennt; standardmäßig sind alle ausgewählt

movable

boolean

false

Ermöglicht das Verschieben der Position während des Unterzeichnens; Standardwert ist false

false- Der Unterzeichner kann die Position seines Signatur-Steuerelements nicht anpassen

true- Der Unterzeichner kann die Position seines Signatur-Steuerelements anpassen

allowedOptions

array

false

Optionen zur Genehmigung durch den Unterzeichner; gilt, wenn fieldType den Wert approval hat. Standardwert ist ["approve", "decline"]

approve- Zustimmen

decline- Ablehnen

pageNo

string

false

Seitennummerierung; zusammenhängende Seiten werden mit „-“ verbunden, einzelne Seiten mit „,“, z. B.: 1-3, 6-10

Geben Sie den Seitenbereich an, auf dem der Stempel-Overlay platziert wird, wenn pagingSealMode=assignedPages gesetzt ist. Der Stempel-Overlay kann nur bei Dokumenten mit mehr als einer Seite verwendet werden.

posX

string

false

X-Koordinate

Ergänzende Hinweise:

Wenn fieldType den Wert signature hat, bezieht sich die Koordinatenposition auf den Signaturbereichuntere linke Ecke；

Wenn fieldType stamp ist, bezieht sich die Koordinatenposition auf den Bereich des Stempels.MittelpunktPosition

Ab dem 3. Februar 2026, wenn fieldType signature oder stamp ist, bezieht sich die Koordinatenposition auf die Position des Mittelpunkts des Stempelbereichs.

Für den Seitenstempel kann 0 übergeben werden, null ist nicht zulässig; das Steuerelement ist am rechten Rand der Datei fixiert.

posY

string

false

Y-Koordinate

Ergänzende Hinweise:

Wenn fieldType signature ist, bezieht sich die Koordinatenposition auf den Bereich der Unterschrift.untere linke Ecke；

Wenn fieldType stamp ist, bezieht sich die Koordinatenposition auf den Bereich des Stempels.MittelpunktPosition

Ab dem 3. Februar 2026, wenn fieldType signature oder stamp ist, bezieht sich die Koordinatenposition auf die Position des Mittelpunkts des Stempelbereichs.

fillConfigs

array

false

Steuerelementinformationen ausfüllen

fieldName

string

false

Steuerungsname, maximal 128 Zeichen

required

boolean

false

Pflichtfeld, standardmäßig erforderlich

true – Pflichtfeld

false – nicht erforderlich

fieldType

string

false

Steuerungstyp:

1 – einzeiliger Text

15 – Kontrollkästchen

textField

object

false

Attribute des Textsteuerelements

overflowType

int

false

Gilt nur für text, Standardwert 1

1 – Schriftgröße automatisch anpassen

2 – Eingabe beschränken

minFontSize

float

false

Gilt nur für text und nur bei overflowType=1, Standardwert 8.

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

width

int

false

Breite der Steuerung, Standardwert 160px

font

int

false

Gilt nur für text, Schriftart, Standardwert SimSun.

1 – SimSun

2-Neue SimSun

4-SimHei

5-KaiTi

6-Arial

7-Helvetica

9-Times New Roman

10-FangSong

11-Georgia

12-Monospace

fontSize

float

false

Wirkt nur auf Text, Schriftgröße, Standardwert 12

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

textColor

string

false

Wirkt nur auf Text, hexadezimale Farbe, Standardwert Schwarz #000

bold

boolean

false

Wirkt nur auf Text, ob die Schrift fett dargestellt wird, Standardwert false

true-fett

false-nicht fett

italic

boolean

false

Wirkt nur auf Text, ob die Schrift kursiv dargestellt wird, Standardwert false

true-kursiv

false-nicht kursiv

underline

boolean

false

Wirkt nur auf Text, ob der Schrift ein Unterstrich hinzugefügt wird, Standardwert false

true-Unterstrich hinzufügen

false-keinen Unterstrich hinzufügen

lineThrough

boolean

false

Gilt nur für Text, ob durchgestrichen wird, Standardwert false

true - durchgestrichen

false - nicht durchgestrichen

horizontalAlignment

string

false

Gilt nur für Text, horizontale Zentrierung, Standardwert left

LEFT - linksbündig

CENTER - zentriert

RIGHT - rechtsbündig

tickBoxField

object

false

Eigenschaften der Kontrollkästchen

tickOptions

array

false

Gilt nur für Check, Standardwert 1

1 - Häkchen

2 - Kreuz

posX

float

false

X-Koordinate der Steuerelementposition

posY

float

false

Y-Koordinate der Steuerelementposition

pageNo

string

false

Seitennummer des Steuerelements

signDateConfigs

array

false

Positionsinfo zum Unterzeichnungsdatum

movable

boolean

false

Position kann beim Unterzeichnen verschoben werden, Standardwert false

false- Unterschriftsberechtigte dürfen die Position ihrer Unterschriftssteuerelemente nicht anpassen

true- Unterschriftsberechtigte dürfen die Position ihrer Unterschriftssteuerelemente anpassen

pageNo

string

false

Seitennummerierung für die Unterzeichnung; zusammenhängende Seitennummern werden mit "-" verbunden, einzelne Seitennummern mit ",", z. B.: 1-3, 6-10

Bei nicht zusammenhängenden Nummern wird "," als Trennzeichen verwendet

posX

float

false

x-Achsen-Versatz, Koordinatenursprung ist die linke untere Ecke der Seite

posY

float

false

y-Achsen-Versatz, Koordinatenursprung ist die linke untere Ecke der Seite

signDateFormat

string

false

Datumsformat bei der Unterzeichnung, Standardformat ist yyyy-MM-dd

Unterstützte Formate:

yyyy-JJJJ-MM-Monatsname-dd-Tag

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy