Schnelles Erstellen eines Briefumschlags

Parametername

Typ

Pflichtfeld

Beschreibung

subject

string

true

Betreff des Briefumschlags

Beispiel: „Offer Letter“

remark

string

false

Notiz für den Briefumschlag, maximale Länge 1000 Zeichen

signerSettings

object

false

Vom Unterzeichner erlaubte Aktionen

allowTransfer

boolean

false

Ob der Unterzeichner den Umschlag an andere Personen zur Unterschrift weitergeben darf, Standardwert false

true – Erlaubt dem Unterzeichner im Umschlag, diesen an Dritte zur Unterschrift weiterzugeben;

false – Verweigert dem Unterzeichner im Umschlag das Recht, diesen an Dritte zur Unterschrift weiterzugeben;

allowModifyName

boolean

false

Ob die unterzeichnende Partei den Namen ändern darf, gilt nur für Vorlagenunterschriften, Standardwert false

true – Der Unterzeichner darf den Namen ändern

false – Der Unterzeichner darf den Namen nicht ändern

expireAfterSeconds

long

false

Ablaufzeit des Umschlags; nach wie vielen Sekunden wird der Umschlag ungültig

Gültiger Bereich: 86.400 Sekunden (1 Tag) bis 7.776.000 Sekunden (90 Tage)

redirectUrl

string

false

Muss eine gültige HTTPS-Adresse sein

callBackUrl

string

false

Callback-Adresse (max. 500 Zeichen), muss einem HTTPS-Protokoll-Format entsprechen.

sendLaterAfterSeconds

long

false

Unterstützt verzögertes Senden durch den Benutzer, angegeben in Sekunden

Unterstützter Zeitbereich: 3.600 Sekunden (1 Stunde) bis 259.200 Sekunden (30 Tage)

autoFinish

boolean

false

Steuerung, ob der Umschlag automatisch beendet wird, Standardwert true

true- Automatischer Abschluss des Umschlags

false- Manueller Abschluss des Umschlags

CCInfos

array

false

Sammler der CC-Empfängerinformationen

userEmail

string

false

E-Mail-Adresse des CC-Empfängers

userName

string

false

Name des CC-Empfängers, der auf der Unterzeichnungsseite und im Umschlag für externe Darstellungen angezeigt wird.

[Hinweis]: Folgende 9 Sonderzeichen sind nicht zulässig: / \ : * " < > | ? sowie alle Emoji-Zeichen

ccOrder

int

false

Die Reihenfolgeposition des CC-Empfängers im Unterzeichnungsprozess; teilt sich die Reihenfolge mit signOrder der Unterzeichner. Bei Nichtübernahme wird die ursprüngliche Logik zur CC-Benachrichtigung beibehalten.

customizeSettings

object

false

Benutzerdefinierte Konfiguration

notificationSettings

object

false

Benachrichtigungsbezogene benutzerdefinierte Konfiguration

notificationLanguage

string

false

Sprache der Benachrichtigung; standardmäßig wird die Einstellung „Standardbenachrichtigungssprache“ verwendet

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 Malaiisch
fil-PH Philippinisch
de-DE Deutsch
fr-FR Französisch
ru-RU Russisch
it-IT Italienisch
ko-KR Koreanisch

signFiles

array

true

Sammlung von Informationen zu unterzeichnenden Dokumenten, angeordnet in der Reihenfolge ihrer Hinzufügung.

fileKey 

string

true

fileKey des zu unterzeichnenden Dokuments; nur PDF-Format unterstützt

fieldType

string

false

Typ des Steuerelements. Übergeben Sie eMeterai, um das indonesische Stempelsteuerelement anzugeben.

pageNo

string

false

Seitennummer, auf der sich das Steuerelement befindet. Das indonesische Stempelsteuerelement unterstützt nur die Angabe einer einzelnen Seite; es muss eine einzelne Seitennummer übergeben werden. Formate wie 1-3 oder 1,3 für mehrere zusammenhängende oder nicht zusammenhängende Seiten werden nicht unterstützt.

attachments

array

false

Sammlung von Briefumschlag-Anhängen, angeordnet in der Reihenfolge des Hinzufügens der Dateien.

fileKey 

string

false

Datei-fileKey

signerInfos

array

true

Sammlung der Informationen zum Unterzeichner

businessId

string

false

Vom Entwickler benutzerdefinierte Geschäftsnummer, maximale Länge 500

roleTypes

array

false

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

fill-Ausfüllen

sign-Unterschreiben

string

false

Benachrichtigungsmodus, Standardwert ist auto

auto-Bei Übermittlung von userEmail wird eine E-Mail-Benachrichtigung gesendet, bei Übermittlung von phoneNumber wird eine SMS-Benachrichtigung gesendet

none-Keine Nachrichtenbenachrichtigung senden

email-E-Mail-Benachrichtigung senden

sms-SMS-Benachrichtigung senden

WhatsApp-WhatsApp-Benachrichtigung senden

userEmail

string

false

E-Mail-Adresse des Unterzeichners

userName

string

true

Name des Unterzeichners, der auf der Unterzeichnungsseite und im Briefumschlag angezeigt wird.

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

phoneNumber

object

false

Telefonnummer, standardmäßig leer

Bei Bedarf an SMS-Benachrichtigungen obligatorisches Feld; countryCode und number müssen beide angegeben werden

countryCode

string

false

Ländercode nach internationalem Standard, ohne „+“

number

string

false

Keine Formatprüfung, nur maximale Länge von 13 Zeichen begrenzt

customizeSettings

object

false

Benutzerdefinierte Konfiguration

notificationSettings

object

false

Benutzerdefinierte Konfiguration für Benachrichtigungen

customizeMessage

string

false

Exklusive Nachrichtenbenachrichtigung, Zeichengrenze 200

notificationLanguage

string

false

Benachrichtigungssprache, standardmäßig wird die Einstellung „Standard-Benachrichtigungssprache“ verwendet

en-US Englisch

zh-CN Chinesisch (Vereinfacht)

zh-Hant Chinesisch (Traditionell)

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

signOrder

int

true

Reihenfolge der Unterschrift des Unterzeichners, mindestens 1. Bei unordentlicher Unterschrift kann derselbe Reihenfolge-Wert angegeben werden.

signTaskSuspend

boolean

false

Ob vor dieser Unterschriftsposition ein Prozessblockierungsknoten eingerichtet wird, standardmäßig false. true – Blockierungsknoten einrichten; false – keinen Blockierungsknoten einrichten. Die Blockierungskonfiguration innerhalb einer OR-Gruppe mit demselben signOrder muss konsistent sein.

suspensionKey

string

false

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

suspendReason

string

false

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

anySigner

boolean

false

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

true- Innerhalb desselben signOrder muss nur eine Person unterschreiben

false- Innerhalb desselben signOrder müssen alle Personen unterschreiben

authModes

string

false

Verifizierungsart, standardmäßig noAuth

noAuth- Keine Verifizierung

accessCode- Verifizierung mit Unterschriftspasswort

sms- SMS-OTP-Verifizierung

idVerification- Identitätsdokumentenverifizierung

emailAuth- E-Mail-OTP-Verifizierung

digitalId- Elektronische Identitätsverifizierung

whatsappAuth- WhatsApp-OTP-Verifizierung

authConfig

object

false

Einstellungen für die Verifizierungsmethode

accessCode

object

false

Einstellungen für das Signaturpasswort, erforderlich, wenn authModes=accessCode, ist erforderlich

accessCode

string

false

Passwortinhalt, nicht zwischen Groß- und Kleinschreibung unterscheidbar, kann alphanumerische Zeichen enthalten, maximale Länge 45

promptInfo

string

false

Hinweistext für das Zugriffs-Passwort, darf kein Zugriffs-Passwort 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, "+" muss nicht übergeben werden

number

string

false

Keine Formatprüfung, nur maximale Länge von 13 Stellen beschränkt

idVerification

object

false

Einstellungen zur Überprüfung der Identitätsdokumente, 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-Verifizierung, 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

Für die elektronische Identitätsverifizierung verwendete APP

singpass-Identitätsverifizierung mit Singpass

iamsmart-Identitätsverifizierung mit i AM Smart

idNumber

string

false

Ausweisnummer des Unterzeichners zur Verifizierung

Wenn authApp=singpassGültigkeitsregel: Großbuchstaben + 7 oder 8 Ziffern + Großbuchstaben

Wenn authApp=iamsmartGültigkeitsregel:

1. Ein Großbuchstabe (A-Z) oder zwei Großbuchstaben (AA-ZZ) als Beginn 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 nach internationalem Standard, ohne "+" einzugeben

number

string

false

Keine Formatvalidierung, nur maximale Länge von 13 Zeichen beschränken

digitalSignature

boolean

false

Ob die digitale Signatur aktiviert ist, Standardwert false

true – Aktiviert, false – Deaktiviert

tsp

string

false

Auswahl des vom Unterzeichner zu verwendenden TSP, Standardwert false.

Wenn nicht festgelegt, wählt der Unterzeichner den zu verwendenden TSP selbst. 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 das Siegel frei platzieren kann, Standardwert false

Ergänzende Hinweise:

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

[Hinweis]Freie Siegelplatzierung bedeutet, dass die Anzahl und Position der vom Unterzeichner eingefügten Siegel/Unterschriften nicht eingeschränkt sind.

documentVisibility

object

false

Konfiguration der Sichtbarkeit der Datei, standardmäßig für alle sichtbar.

documentViewType

string

false

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

viewableFileKeys

array

false

Liste der fileKeys, die der Unterzeichner zusätzlich einsehen darf; nur zulässig und wirksam bei documentViewType=limited.

sealInfos

array

false

Informationen zur Unterschriftsaufgabe

fileKey

string

true

fileKey der unterschriebenen Datei

signConfigs

array

false

Steuerpositionsinformationen. Die Steuerpositionsinformationen müssen angegeben werden, um eine elektronische Signatur durchführen zu können.

fieldType

string

false

Steuerungstyp, standardmäßig signature

signature-Signiersteuerung

stamp-Stempelsteuerung

approval-Genehmigungssteuerung

required

boolean

Pflichtfeld, standardmäßig erforderlich

true-Pflichtfeld

false-Nicht Pflichtfeld

signFieldStyle

string

false

Art des Stempelauftrags für die Signiersteuerung, standardmäßig normalSeal.

normalSeal-Normaler Stempel

pagingSeal-Überschneidungsstempel

Nur Signiersteuerelemente und Stempelsteuerelemente unterstützen die Einstellung eines Überschneidungsstempels.

pagingSealMode

string

false

Seitenbereich für den Überschneidungsstempel, 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-Stempel basierend auf der tatsächlichen Größe der Unterschrift/des Stempels platzieren

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

Wenn sizeRule, height und width alle leer sind, wird der Stempel basierend auf der tatsächlichen Größe der Unterschrift/des Stempels platziert;

Wenn sizeRule leer ist, height und width jedoch nicht leer sind, wird der Stempel in der angegebenen Größe platziert;

Wenn sizeRule nicht leer ist, wird der Stempel gemäß der angegebenen Anzeigeart platziert;

Für den Seitenstempel (paging seal) muss dieser Parameter nicht angegeben werden; er wird nur basierend auf der tatsächlichen Größe platziert.

height

int

false

Höhe des Signatursteuerelements, gültig für fieldType signature/stamp, Einheit px, nur positive ganze Zahlen zulässig, Standardwert auto (automatische Systemgröße);

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

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

Für den Seitenstempel (paging seal) muss dieser Parameter nicht angegeben werden.

width

int

false

Breite des Signatursteuerelements, gültig für fieldType signature/stamp, Einheit px, nur positive ganze Zahlen zulässig, Standardwert auto (automatische Systemgröße);

Wenn fieldType=signature, kann der Bereich auf 20-250px festgelegt werden;

Wenn fieldType=stamp, kann der Bereich auf 30-280px festgelegt werden;

Für den Stempel am Rand ist die Angabe dieses Parameters nicht erforderlich.

signatureOptions

string

false

Optionen für das Signatur-Steuerelement. Nur anwendbar, wenn fieldType signature ist

Mögliche Eingabeparameter:

template: Vorlagen-Signatur

handDrawn: Freihand-Signatur

upload: Lokales Hochladen eines Signaturbilds

aiHandDrawn: KI-generierte Handschrift-Signatur

Mehrere Werte können ausgewählt werden, getrennt durch ",", standardmäßig sind alle ausgewählt

movable

boolean

false

Ermöglicht das Verschieben der Position während der Unterzeichnung, Standardwert false

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

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

allowedOptions

array

false

Optionen zur Genehmigung durch den Unterzeichner, anwendbar bei fieldType approval. Standardwert ist ["approve", "decline"]

approve- Zustimmen

decline-Ablehnen

pageNo

string

false

Seitenzahl der Unterschrift; fortlaufende Seitenzahlen werden mit "-" verbunden, einzelne Seitenzahlen mit ","

Beispiel: 1-3,6-10

Übergeben Sie den Seitenbereich für das Stempeln des Überlappungsstempels, wenn pagingSealMode=assignedPages. Der Überlappungsstempel kann nur für Dateien mit mehr als einer Seite verwendet werden.

posX

float

false

X-Koordinate

[Hinweis] Wenn fieldType signature ist, bezieht sich die Koordinatenposition auf den Signaturbereich.Unten links；

Wenn fieldType stamp ist, bezieht sich die Koordinatenposition auf den Stempelbereich.MittelpunktPosition

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

Für den Überlappungsstempel kann 0 übergeben werden, null ist nicht erlaubt; das Steuerelement ist am rechten Rand der Datei fixiert.

posY

float

false

Y-Koordinate

[Hinweis] Wenn fieldType signature ist, bezieht sich die Koordinatenposition auf den Signaturbereich.Unten links；

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

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

fillConfigs

array

false

Steuerelementinformationen ausfüllen

fieldName

string

false

Name des Steuerelements, maximale Zeichenanzahl 128

required

boolean

false

Pflichtfeld, standardmäßig erforderlich

true – Pflichtfeld

false – nicht erforderlich

fieldType

string

false

Steuerelementtyp:

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, gilt 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

Steuerelementbreite, Standardwert 160px

font

int

false

Gilt nur für Text, Schriftart, Standardwert Songti

1-Songti

2-Neues Songti

4-Heiti

5-Kaiti

6-Arial

7-Helvetica

9-Times New Roman

10-Fangsong

11-Georgia

12-Monospace

fontSize

float

false

Gilt nur für 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

Gilt nur für Text, hexadezimale Farbe, Standardwert Schwarz #000

bold

boolean

false

Gilt nur für Text, ob die Schrift fett ist, Standardwert false

true-fett

false-nicht fett

italic

boolean

false

Gilt nur für Text, ob kursiv, Standardwert false

true-Kursiv

false-Nicht kursiv

underline

boolean

false

Wirkt nur auf Text, ob der Schriftzug unterstrichen wird, Standardwert false

true-Unterstrich hinzufügen

false-Kein Unterstrich

lineThrough

boolean

false

Wirkt nur auf Text, ob ein Durchgestrichen hinzugefügt wird, Standardwert false

true-Durchgestrichen hinzufügen

false-Kein Durchgestrichen

horizontalAlignment

string

false

Wirkt nur auf Text, horizontale Ausrichtung, Standardwert left

LEFT-Nach links

CENTER-Zentriert

RIGHT-Nach rechts

tickBoxField

object

false

Eigenschaften des Kontrollkästchens

tickOptions

array

false

Wirkt nur auf tickBox, Standardwert 1

1-Haken

2-fach

posX

float

false

X-Koordinate der Steuerelementposition

posY

float

false

Y-Koordinate der Steuerelementposition

pageNo

string

false

Seitennummer, auf der sich das Steuerelement befindet

signDateConfigs

array

false

Positionsinformationen für das Signaturdatum

movable

boolean

false

Ermöglicht das Verschieben der Position während der Signatur, Standardwert false

false – Der Unterzeichner darf die Position seines Signatursteuerelements nicht anpassen

true – Der Unterzeichner darf die Position seines Signatursteuerelements anpassen

pageNo

string

false

Seitennummer(n) für die Signatur; zusammenhängende Seitennummern werden mit "-" verbunden, einzelne Seitennummern mit ",", Beispiel: 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

Format des Signaturdatums, Standardformat ist yyyy-MM-dd

Unterstützt folgende Formate:

yyyy-JJJJ-MMMM-TTTT

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MMM dd,yyyy

dd MMM yyyy

Parametername

Typ

Beschreibung

envelopeId

string

Umschlag-ID

CCInfos

array

Sammlung der CC-Empfängerinformationen

userEmail

string

E-Mail-Adresse des CC-Empfängers

userName

string

Name des CC-Empfängers

signFiles

array

Sammlung der Signaturdokumenteninformationen

fileKey

string

fileKey des signierten Dokuments

attachments

array

Sammlung der Umschlag-Anhänge

fileKey

string

Datei-fileKey

signerInfos

array

Signaturinformationen

recipientId

string

ID des Unterzeichners

businessId

string

Vom Entwickler benutzerdefinierte Geschäftsnummer, maximale Länge 500

userEmail

string

E-Mail-Adresse des Unterzeichners

userName

string

Name des Unterzeichners

signOrder

int

Unterzeichnungsreihenfolge des Unterzeichners, Mindestwert 1

accessCode

string

Passwort für den Zugriff auf die Unterzeichnungsseite