Unterzeichner bearbeiten

POST/esignglobal/v1/envelope/recipients/editSigners

Schnittstellenbeschreibung

Ändern der Unterzeichnerinformationen für noch nicht unterzeichnete Unterzeichner im Briefumschlag.

Nachdem Entwickler einen Briefumschlag erstellt haben, können sie über diese Schnittstelle die Informationen von Unterzeichnern aktualisieren, die den Vorgang noch nicht abgeschlossen haben, falls Kontaktangaben, Name, Benachrichtigungskonfiguration oder Authentifizierungsmethode fehlerhaft sind oder ausgetauscht werden müssen. Dies verhindert, dass der Briefumschlag aufgrund falscher Daten ungültig gemacht und erneut versendet werden muss.

Hinweise

Nur das Ändern von Unterzeichnern, die den Vorgang noch nicht abgeschlossen haben, wird unterstützt.
Unterzeichner in Endzuständen wie „unterzeichnet“ oder „abgelehnt“ können nicht geändert werden.
Wenn sich der Briefumschlag in einem Endzustand oder als ungültig markiert befindet, können die Unterzeichnerinformationen nicht geändert werden.
Wenn die Benachrichtigungsmethode sowohl SMS als auch E-Mail umfasst, wird das reine Ändern von phoneNumber。
Die Schnittstelle vergleicht die übermittelten Unterzeichnerinformationen mit den aktuellen Unterzeichnerinformationen. Bei Abweichungen werden die entsprechenden Unterzeichnerinformationen aktualisiert.

Anforderungsparameter

Parametername				Typ	Erforderlich	Beschreibung
envelopeId				string	true	Envelope-ID
signerInfos				object	true	Unterschriftsinformationen
	recipientId			string	true	Teilnehmer-ID
	businessId			string	false	Vom Entwickler definierte Geschäftsnummer, maximale Länge 500
	deliveryMethods			string	false	Benachrichtigungsmethode, Standard ist auto auto-Sendet eine E-Mail-Benachrichtigung, wenn userEmail übergeben wird, und eine SMS-Benachrichtigung, wenn phoneNumber übergeben wird none-Sendet keine Nachrichtenbenachrichtigungen email-Sendet eine E-Mail-Benachrichtigung sms-Sendet eine SMS-Benachrichtigung WhatsApp-Sendet eine WhatsApp-Benachrichtigung
	userEmail			string	false	E-Mail-Adresse des Unterzeichners
	userName			string	true	Name des Unterzeichners, der auf der Unterschriftsseite und dem Umschlag angezeigt wird. [Hinweis] Darf nicht die folgenden 9 Sonderzeichen enthalten: / \ : * " < > \| ？ sowie alle Emoji-Zeichen
	minimumReadingDuration			int	false	Legt die Dauer des Pflicht-Lesecountdowns für die Seite fest, Standardwert ist 0 (Einheit: Sekunden, Maximalwert 999) 0 oder kein Wert deaktiviert die Funktion, kein Lesecountdown erforderlich
	readToEndRequired			boolean	false	Gibt an, ob bis zum Ende gelesen werden muss. Standard: false; true bedeutet aktiviert, false oder nicht angegeben bedeutet deaktiviert.
	phoneNumber			object	false	Telefonnummer, standardmäßig leer Pflichtparameter bei SMS-Benachrichtigungen; countryCode und number müssen beide übergeben werden.
		countryCode		string	false	Internationaler Ländercode, "+" muss nicht übergeben werden.
		number		string	false	Keine Formatprüfung, maximale Länge auf 13 Zeichen beschränkt.
	customizeSettings			object	false	Benutzerdefinierte Konfiguration
		notificationSettings		object	false	Benutzerdefinierte Konfiguration für Benachrichtigungen
			customizeMessage	string	false	Spezielle Nachrichtenbenachrichtigung, maximal 200 Zeichen
			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
	authModes			string	false	Validierungsmethode, standardmäßig noAuth noAuth-Keine Validierung accessCode-Validierung mit Signierpasswort sms-SMS-OTP-Validierung idVerification-Validierung des Identitätsdokuments emailAuth-E-Mail-OTP-Verifizierung digitalId-Elektronische Identitätsverifizierung whatsappAuth-WhatsApp-OTP-Verifizierung
	authConfig			object	false	Einstellungen zur Verifizierungsmethode
		accessCode		object	false	Einstellung des Signiercodes, erforderlich wenn authModes=accessCode
			accessCode	string	false	Code-Inhalt, Groß-/Kleinschreibung irrelevant, kann alphanumerisch sein, maximale Länge 45
			promptInfo	string	false	Hinweistext für den Zugriffscode, darf den Code nicht enthalten, maximale Länge 30, erforderlich wenn authModes=1.
		sms		object	false	SMS-OTP-Validierung, erforderlich wenn authModes=sms
			countryCode	string	false	Internationaler Ländercode, "+" muss nicht übergeben werden
			number	string	false	Keine Formatvalidierung, maximale Länge auf 13 Stellen beschränkt
		idVerification		object	false	Einstellungen zur Ausweisverifizierung, erforderlich wenn authModes=idVerification
			name	string	false	Vollständiger Name auf dem Ausweis 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 für die elektronische Authentifizierung singpass - Identitätsprüfung mit Singpass
			idNumber	string	false	Ausweisnummer des zu verifizierenden Unterzeichners
		whatsappAuth		object	false	WhatsApp-OTP-Verifizierung, erforderlich, wenn authModes=whatsappAuth ist
			countryCode	string	false	Internationaler Ländercode, "+" muss nicht übermittelt werden
			number	string	false	Keine Formatvalidierung, die Länge ist auf maximal 13 Zeichen begrenzt

Antwortbeispiel

{
  "code": 0,
  "message": "success",
  "data": {
    "envelopeId": "9fbe6c8190824227bde29136b0145c81",
    "signerInfos": [
      {
        "recipientId": "recipient_123456789",
        "businessId": "biz-20260604-001",
        "userEmail": "new_signer@example.com",
        "userName": "Alex Chen"
      }
    ]
  }
}