Modifica firmatario

POST/esignglobal/v1/envelope/recipients/editSigners

Descrizione dell'interfaccia

Modifica le informazioni del firmatario con firma incompleta nella busta.

Dopo la creazione della busta, se gli sviluppatori riscontrano errori nei contatti, nel nome, nelle configurazioni di notifica o nei metodi di autenticazione del firmatario, o necessitano di modificarli, possono utilizzare questa interfaccia per aggiornare i dati del firmatario con firma incompleta, evitando così l'annullamento e il reinoltro della busta per errori.

Note importanti

È supportata esclusivamente la modifica dei firmatari con firma incompleta.
I firmatari in stato definitivo (es. firmato, rifiutato) non sono modificabili.
Quando la busta si trova in stato definitivo o è stata annullata, non è possibile modificare le informazioni del firmatario.
Quando il metodo di notifica include sia SMS che email, non è supportata la sola modifica di phoneNumber。
L'interfaccia confronta le informazioni del firmatario fornite con quelle attualmente registrate; in caso di discrepanza, aggiorna i dati del firmatario corrispondente.

Parametri della richiesta

Nome del parametro				Tipo	Obbligatorio	Descrizione
envelopeId				string	true	ID della busta
signerInfos				object	true	Informazioni del firmatario
	recipientId			string	true	ID partecipante
	businessId			string	false	Numero di riferimento personalizzato dallo sviluppatore, limite di lunghezza 500
	deliveryMethods			string	false	Metodo di notifica, predefinito auto auto - invia notifica via email quando viene passato userEmail, invia notifica SMS quando viene passato phoneNumber none - non invia notifiche messaggio email - invia notifica via email sms - invia notifica SMS WhatsApp - invia notifica WhatsApp
	userEmail			string	false	Indirizzo email del firmatario
	userName			string	true	Nome del firmatario, utilizzato per visualizzare il nome del firmatario nella pagina di firma e sulla busta. [Nota] Non deve contenere i seguenti 9 caratteri speciali: / \ : * " < > \| ? e tutte le emoji
	minimumReadingDuration			int	false	Imposta il tempo di countdown obbligatorio per la lettura della pagina, valore predefinito 0 (unità: secondi, massimo 999) 0 o non specificato indica disattivazione, nessun countdown di lettura richiesto
	readToEndRequired			boolean	false	Indica se deve essere letto fino alla fine. Valore predefinito false; true indica l'attivazione, false o la mancata trasmissione indicano la disattivazione.
	phoneNumber			object	false	Numero telefonico, vuoto per impostazione predefinita Parametro obbligatorio quando è necessaria una notifica SMS, devono essere inviati sia countryCode che number
		countryCode		string	false	Codice internazionale del paese o regione, non è necessario inviare il simbolo '+'
		number		string	false	Nessuna convalida del formato, lunghezza massima di 13 caratteri
	customizeSettings			object	false	Configurazione personalizzata
		notificationSettings		object	false	Configurazione personalizzata per le notifiche
			customizeMessage	string	false	Notifica messaggio dedicato, limite di 200 caratteri
			notificationLanguage	string	false	Lingua della notifica, per impostazione predefinita utilizza la configurazione 'Lingua di notifica predefinita' en-US Inglese zh-CN Cinese semplificato zh-Hant Cinese tradizionale ja-JP Giapponese es-MX Spagnolo pt-PT Portoghese th-TH Tailandese id-ID Indonesiano vi-VN Vietnamita ms-MY Malese fil-PH Filippino de-DE Tedesco fr-FR Francese ru-RU Russo it-IT Italiano ko-KR Coreano
	authModes			string	false	Metodo di verifica, predefinito noAuth noAuth-Nessuna verifica accessCode-Verifica tramite codice di firma sms-Verifica OTP via SMS idVerification-Verifica documento d'identità emailAuth-Verifica OTP via email digitalId-Autenticazione identità elettronica whatsappAuth-Verifica OTP via WhatsApp
	authConfig			object	false	Impostazioni modalità di verifica
		accessCode		object	false	Impostazioni codice di firma, obbligatorio quando authModes=accessCode
			accessCode	string	false	Contenuto del codice, non distingue tra maiuscole e minuscole, può contenere lettere e numeri, lunghezza massima 45
			promptInfo	string	false	Messaggio informativo per il codice di accesso, non deve contenere il codice di accesso, lunghezza massima 30, obbligatorio quando authModes=1.
		sms		object	false	Verifica OTP SMS, obbligatorio quando authModes=sms
			countryCode	string	false	Codice internazionale del Paese/Regione, non è necessario trasmettere il simbolo '+'
			number	string	false	Nessuna verifica del formato, limite massimo di lunghezza di 13 caratteri
		idVerification		object	false	Impostazioni verifica documento d'identità, obbligatorio quando authModes=idVerification
			name	string	false	Nome completo riportato sul documento d'identità del firmatario, lunghezza massima 100 caratteri
		emailAuth		object	false	Verifica OTP email, obbligatorio quando authModes=emailAuth
			authEmail	string	false	Indirizzo email per la verifica dell'identità del firmatario
		digitalId		array	false	Autenticazione identità elettronica, obbligatorio quando authModes=digitalId
			authApp	string	false	APP utilizzata per la verifica dell'identità elettronica singpass - Utilizzare Singpass per l'autenticazione dell'identità
			idNumber	string	false	Numero del documento di identità del firmatario da verificare
		whatsappAuth		object	false	Verifica OTP WhatsApp, obbligatoria quando authModes=whatsappAuth
			countryCode	string	false	Prefisso internazionale del Paese/regione, non è necessario trasmettere il simbolo '+'
			number	string	false	Nessuna convalida del formato, lunghezza massima di 13 caratteri

Esempio di risposta

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