Parametername | Typ | Pflichtfeld | Beschreibung |
subject | string | true | Betreff des Briefumschlags Beispiel: „Offer Letter“ |
remark | string | false | Notiz zum Briefumschlag, maximale Länge 1000 Zeichen |
signerSettings | object | false | Vom Unterzeichner zulässige Aktionen |
| | allowTransfer | boolean | false | Ob der Unterzeichner diesen Umschlag an eine andere Person zur Unterschrift weiterleiten darf, Standardwert false true – Erlaubt dem Unterzeichner im Umschlag, die Befugnis zur Weiterleitung des Umschlags an Dritte zu besitzen; false – Verweigert dem Unterzeichner im Umschlag die Befugnis zur Weiterleitung des Umschlags an Dritte; |
| | 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 (Länge 500), muss einer HTTPS-Protokolladresse entsprechen. |
sendLaterAfterSeconds | long | false | Unterstützt verzögertes Senden durch den Benutzer, in Sekunden angegeben Unterstützter Zeitbereich: 3.600 Sekunden (1 Stunde) bis 259.200 Sekunden (30 Tage) |
autoFinish | boolean | false | Steuerung, ob der Umschlag automatisch endet, Standardwert true true- Automatisches Beenden des Umschlags false- Manuelles Beenden des Umschlags |
CCInfos | array | false | Sammlungen von CC-Empfängerinformationen |
| userEmail | string | false | E-Mail-Adresse des CC-Empfängers |
| userName | string | false | Name des CC-Empfängers, der auf der Signaturseite und im Umschlag für die externe Anzeige verwendet wird. [Hinweis]: Darf keine der folgenden 9 Sonderzeichen enthalten: / \ : * " < > | ? sowie alle Emoji-Zeichen |
| | customizeSettings | object | false | Benutzerdefinierte Konfiguration |
| | | notificationSettings | object | false | Benachrichtigungsbezogene benutzerdefinierte Konfiguration |
| | | | notificationLanguage | string | false | Sprache der Benachrichtigung; standardmäßig wird die Einstellung „Standard-Benachrichtigungssprache“ ü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 |
signFiles | array | true | Sammlung von Informationen zu signierten Dokumenten, angeordnet in der Reihenfolge des Hinzufügens der Dokumente. |
| fileKey | string | true | fileKey des signierten Dokuments, nur PDF-Format unterstützt |
| | documentFields | array | false | Liste der Steuerelemente für dokumentenbezogene Felder. Wird verwendet, um dokumentenbezogene Felder ohne Zuordnung zu einem Unterzeichner auf einem bestimmten Dokument hinzuzufügen. |
| | fieldType | string | false | Steuerelementtyp. Ü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 zusammenhängende oder nicht zusammenhängende Mehrfachseiten werden nicht unterstützt. |
| | | posX | float | false | X-Achsenversatz, wobei die untere linke Ecke der Seite als Koordinatenursprung dient. Der Koordinatenbereich entspricht dem anderer Steuerelemente. |
| | | posY | float | false | Y-Achsenversatz, wobei die untere linke Ecke der Seite als Koordinatenursprung dient. Der Koordinatenbereich entspricht dem anderer Steuerelemente. |
attachments | array | false | Sammlung von Briefumschlag-Anhängen, angeordnet in der Reihenfolge des Datei-Hinzufügens. |
| fileKey | string | false | Datei fileKey |
signerInfos | array | true | Sammlung der Unterzeichnerinformationen |
| businessId | string | false | Vom Entwickler definierte geschäftliche Referenznummer, maximale Länge 500 Zeichen |
| | roleTypes | array | false | Unterzeichner-Aktionsmethode, Standardwert ist ["sign", "fill"] fill – Ausfüllen sign – Unterschreiben |
| | deliveryMethods | string | false | Benachrichtigungsmethode, 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, verwendet für die Anzeige des Unterzeichnernamens auf der Unterschriftsseite und nach außen hin. [Hinweis] Darf nicht die folgenden 9 Sonderzeichen enthalten: / \ : * " < > | ? sowie alle Emoji-Zeichen |
| | minimumReadingDuration | int | false | Legt die zwingend einzuhaltende Countdown-Zeit für das Lesen auf der Einstellungsseite fest. Standardwert ist 0 (Einheit: Sekunden, Maximalwert 999) 0 oder kein Wert bedeutet, dass keine Countdown-Funktion aktiviert wird und kein Lesen erforderlich ist |
| | readToEndRequired | boolean | false | Gibt an, ob der gesamte Inhalt gelesen werden muss. Standardwert ist false; true bedeutet Aktivierung; false oder kein Wert bedeutet Deaktivierung. |
| phoneNumber | object | false | Telefonnummer, standardmäßig leer Erforderliches Feld bei SMS-Benachrichtigungen; sowohl countryCode als auch number müssen übergeben werden |
| | countryCode | string | false | Internationale Länderkennung ohne „+“ |
| | number | string | false | Keine Formatvalidierung, 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 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 |
| signOrder | int | true | Reihenfolge der Unterschriften des Unterzeichners, mindestens 1. Bei unordentlichen Unterschriften kann derselbe Reihenfolgenwert angegeben werden. |
| anySigner | boolean | false | Unterstützt die Unterschrift durch jede beliebige Person, Standardwert ist false true- Bei derselben signOrder muss nur eine Person unterschreiben false- Bei derselben signOrder müssen alle Personen unterschreiben |
| authModes | string | false | Validierungsmethode, Standardwert ist noAuth noAuth- Keine Validierung accessCode- Validierung mit Unterschriftspasswort sms- SMS-OTP-Validierung idVerification- Identitätsdokumentenvalidierung emailAuth- E-Mail-OTP-Validierung digitalId- Elektronische Identitätsvalidierung whatsappAuth- WhatsApp-OTP-Validierung |
| authConfig | object | false | Einstellungen der Validierungsmethoden |
| | accessCode | object | false | Einstellungen des Unterschriftspassworts, erforderlich wenn authModes=accessCode |
| | | accessCode | string | false | Passwortinhalt, nicht zwischen Groß- und Kleinschreibung unterscheidend, kann Buchstaben und Zahlen enthalten, maximale Länge 45 |
| | | | promptInfo | string | false | Hinweistext für das Zugangs-Passwort darf kein Zugangs-Passwort enthalten, maximale Länge 30 Zeichen, erforderlich wenn authModes=accessCode. |
| | sms | object | false | SMS-OTP-Validierung, erforderlich wenn authModes=sms |
| | | countryCode | string | false | Ländercode ohne „+“ |
| | | number | string | false | Keine Formatprüfung, maximale Länge 13 Zeichen |
| | idVerification | object | false | Einstellungen zur Identitätsverifizierung über Ausweisdokumente, erforderlich wenn authModes=idVerification |
| | | name | string | false | Vollständiger Name auf dem Ausweisdokument des Unterzeichners, maximale Länge 100 Zeichen |
| | | emailAuth | object | false | E-Mail-OTP-Validierung, erforderlich wenn authModes=emailAuth |
| | | | authEmail | string | false | E-Mail-Adresse des Unterzeichners zur Identitätsverifizierung |
| | digitalId | array | false | Elektronische Identitätsverifizierung, erforderlich wenn authModes=digitalId |
| | | authApp | string | false | App zur elektronischen Identitätsverifizierung singpass-Verwendung von Singpass zur Authentifizierung iamsmart-Verwenden Sie i AM Smart zur Authentifizierung |
| | | idNumber | string | false | Ausweisnummer des Unterzeichners, die noch verifiziert werden muss Wenn authApp=singpassgelten folgende Eingaberegeln: Großbuchstabe + 7 oder 8 Ziffern + Großbuchstabe Wenn authApp=iamsmartgelten folgende Eingaberegeln: 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 Ziffer (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 im internationalen Format, ohne „+“ |
| | | number | string | false | Keine Formatprüfung, nur maximale Länge auf 13 Zeichen beschränkt |
| digitalSignature | boolean | false | Ob die digitale Signatur aktiviert ist, Standardwert false true – Aktiviert, false – Deaktiviert |
| freeFormSign | boolean | false | Ob der Unterzeichner frei signieren darf, Standardwert false Ergänzende Erläuterungen: 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]Bei der freien Signatur (freeFormSign) gibt es keine Einschränkungen für die Anzahl und Position der Stempel/Unterschriften, die der Unterzeichner einfügen kann. |
| sealInfos | array | false | Informationen zur Unterschriftsaufgabe |
| | fileKey | string | true | fileKey des zu unterschreibenden Dokuments |
| | signConfigs | array | false | Positionsinformation des Steuerelements. Die Positionsdaten des Steuerelements müssen angegeben sein, um eine elektronische Signatur durchführen zu können. |
| | | fieldType | string | false | Steuerelementtyp, Standardwert ist signature signature- Unterschrifts-Steuerelement stamp- Stempel-Steuerelement approval- Genehmigungs-Steuerelement |
| | | | required | boolean | false | Ob das Feld obligatorisch ist, Standardwert ist obligatorisch true- Obligatorisch false- Nicht obligatorisch |
| | | | signFieldStyle | string | false | Art der Platzierung des Unterschriftssteuerelements, Standardwert ist normalSeal. normalSeal- Normales Siegel pagingSeal- Seitenübergreifendes Siegel Nur das Signatur- und Stempelsteuerelement unterstützt die Einstellung eines seitenübergreifenden Siegels. |
| | | | pagingSealMode | string | false | Seitenbereich für das seitenübergreifende Siegel, Standardwert ist all. all- Alle Seiten assignedPages- Angegebene Seiten even- Gerade Seiten odd- Ungerade Seiten Nur bei signFieldStyle=pagingSegel kann dies angegeben werden. |
| | | | sizeRule | string | false | Darstellungsmethode der Größe des Signaturbereichs originalSize- Siegel entsprechend der tatsächlichen Größe der Signatur/des Siegels platzieren targetSize- Benutzerdefinierte Breite und Höhe des Signatur-/Siegelbereichs Wenn sizeRule, height und width alle leer sind, wird das Siegel entsprechend der tatsächlichen Größe der Signatur/des Siegels platziert; Wenn sizeRule leer ist, height und width jedoch nicht leer sind, wird das Siegel entsprechend der angegebenen Größe platziert; Wenn sizeRule nicht leer ist, wird das Siegel entsprechend der angegebenen Darstellungsmethode platziert; Für das Überlappungsstempel ist die Angabe dieses Parameters nicht erforderlich; der Stempel wird lediglich entsprechend den tatsächlichen Abmessungen platziert. |
| | | height | int | false | Höhe des Unterschrift-Steuerelements, gültig für fieldType=signature/stamp, Einheit px, nur positive ganze Zahlen sind zulässig, Standardwert auto (d. h. automatische Systemgröße); Bei fieldType=signature kann der Wert im Bereich von 20–250 px festgelegt werden; Bei fieldType=stamp kann der Wert im Bereich von 30–280 px festgelegt werden; Für das Überlappungsstempel ist die Angabe dieses Parameters nicht erforderlich. |
| | | width | int | false | Breite des Unterschrift-Steuerelements, gültig für fieldType=signature/stamp, Einheit px, nur positive ganze Zahlen sind zulässig, Standardwert auto (d. h. automatische Systemgröße); Bei fieldType=signature kann der Wert im Bereich von 20–250 px festgelegt werden; Bei fieldType=stamp kann der Wert im Bereich von 30–280 px festgelegt werden; Für das Überlappungsstempel ist die Angabe dieses Parameters nicht erforderlich. |
| | | signatureOptions | string | false | Optionen für das Signatur-Steuerelement. Nur gültig für fieldType=signature Mögliche Eingabeparameter: template: Vorlagenunterschrift handDrawn: Freihandunterschrift upload: Lokales Hochladen eines Signaturbilds Mehrere Werte möglich, durch Komma getrennt, standardmäßig alle ausgewählt |
| | | movable | boolean | false | Position kann beim Signieren verschoben werden, Standardwert false false – Unterschriftsberechtigte können die Position ihrer Signierelemente nicht anpassen true – Unterschriftsberechtigte können die Position ihrer Signierelemente anpassen |
| | | allowedOptions | array | false | Optionen, die es dem Unterschriftsberechtigten ermöglichen, zu genehmigen; gilt für fieldType = approval. Standardwert ist ["approve", "decline"] approve- Zustimmen decline- Ablehnen |
| | | pageNo | string | false | Seitenzahlen der Signaturseite; zusammenhängende Seitenzahlen werden mit „-“ verbunden, einzelne Seitenzahlen mit „,“ getrennt Beispiel: 1-3,6-10 Gibt den Seitenbereich an, auf den das Stempelzeichen gesetzt wird, wenn pagingSealMode=assignedPages verwendet wird. Das Stempelzeichen kann nur bei Dokumenten mit mehr als einer Seite angewendet werden. |
| | | posX | float | false | X-Koordinate [Hinweis] Wenn fieldType signature ist, bezieht sich die Koordinatenposition auf den SignaturbereichUntere linke Ecke; Wenn fieldType stamp ist, bezieht sich die Koordinatenposition auf den StempelbereichMittelpunktPosition Ab dem 3. Februar 2026, wenn fieldType signature oder stamp ist, bezieht sich die Koordinatenposition auf den Mittelpunkt 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 | float | false | y-Achsenkoordinate [Hinweis] Wenn fieldType signature ist, bezieht sich die Koordinatenposition auf den Signaturbereichuntere linke Ecke; Wenn fieldType stamp ist, bezieht sich die Koordinatenposition auf den StempelbereichMittelpunktPosition Ab dem 3. Februar 2026, wenn fieldType signature oder stamp ist, bezieht sich die Koordinatenposition auf den Mittelpunkt des Stempelbereichs. |
| | fillConfigs | array | false | Steuerelementinformationen ausfüllen |
| | | fieldName | string | false | Name des Steuerelements, maximale Zeichenzahl 128 |
| | | required | boolean | false | Pflichtfeld, standardmäßig erforderlich true – Pflichtfeld false – kein Pflichtfeld |
| | | fieldType | string | false | Steuerelementtyp: 1-Einzeiliger Text 15-Auswahlkästchen |
| | | textField | object | false | Attribute des Textsteuerelements |
| | | | overflowType | int | false | Gilt nur für text, Standardwert 1 1-Schriftgröße automatisch anpassen 2-Eingabe begrenzen |
| | | | 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 | Breite des Steuerelements, Standardwert 160px |
| | | | font | int | false | Gilt nur für text, Schriftart, Standardwert Songti 1-Songti 2-New 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, Standard ist Schwarz #000 |
| | | | bold | boolean | false | Gilt nur für Text, ob die Schrift fett dargestellt wird, Standard ist false true - Fett false - Nicht fett |
| | | | italic | boolean | false | Gilt nur für Text, ob die Schrift kursiv dargestellt wird, Standard ist false true - Kursiv false - Nicht kursiv |
| | | | underline | boolean | false | Gilt nur für Text, ob ein Unterstrich hinzugefügt wird, Standard ist false true - Unterstrich hinzufügen false - Kein Unterstrich |
| | | | lineThrough | boolean | false | Gilt nur für Text, ob eine Durchstreichung hinzugefügt wird, Standard ist false true - Durchstreichung hinzufügen false - Keine Durchstreichung |
| | | | horizontalAlignment | string | false | Gilt nur für Text, horizontale Ausrichtung, Standard ist left LEFT - Links CENTER-Zentriert RIGHT-Rechtsbündig |
| | | tickBoxField | object | false | Eigenschaften der Kontrollkästchen |
| | | | tickOptions | array | false | Gilt nur für tickBox, Standardwert ist 1 1-Haken 2-Kreuz |
| | | posX | float | false | X-Koordinate der Position des Steuerelements |
| | | posY | float | false | Y-Koordinate der Position des Steuerelements |
| | | pageNo | string | false | Seitennummer, auf der sich das Steuerelement befindet |
| | signDateConfigs | array | false | Positionsinformationen zum Unterzeichnungsdatum |
| | | movable | boolean | false | Ermöglicht die Positionsänderung während der Unterzeichnung, Standardwert false false-Unterschreiber können die Position ihrer Unterzeichnungssteuerelemente nicht anpassen true-Unterschreiber können die Position ihrer Unterzeichnungssteuerelemente anpassen |
| | | pageNo | string | false | Seitennummer(n) für die Unterzeichnung; bei fortlaufenden Seitennummern mit "-" verbinden, bei einzelnen Seitennummern mit "," trennen, Beispiel: 1-3, 6-10; Bei nicht fortlaufenden Nummern zur Trennung "," verwenden. |
| | | posX | float | false | X-Achsen-Offset, Koordinatenursprung ist die linke untere Ecke der Seite |
| | | posY | float | false | Y-Achsen-Offset, Koordinatenursprung ist die linke untere Ecke der Seite |
| | | signDateFormat | string | false | Format des Unterzeichnungsdatums, Standardformat ist yyyy-MM-dd Unterstützte Formate: yyyy-JJJJ MM-Monat dd-Tag yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MMM dd,yyyy dd MMM yyyy |