Edit Signer

POST/esignglobal/v1/envelope/recipients/editSigners

API Description

Modifies the signer information for signers who have not yet completed signing in the envelope.

After creating an envelope, if developers find that the signer's contact information, name, notification settings, or authentication method is entered incorrectly, or if they need to change the signer information, they can use this API to update the information of signers who have not yet completed signing. This avoids invalidating and resending the envelope due to incorrect information.

Notes

Only supports modifying signers who have not yet completed signing.
Signers in terminal states, such as 'Signed' or 'Rejected', cannot be modified.
Signer information cannot be modified when the envelope is in a terminal state or has been invalidated.
When the notification method includes both SMS and email, it does not support modifying only phoneNumber。
The API compares the passed-in signer information with the current signer information; if they differ, it updates the corresponding signer information.

Request Parameters

Parameter Name				Type	Required	Description
envelopeId				string	true	Envelope ID
signerInfos				object	true	Signer Information
	recipientId			string	true	Participant ID
	businessId			string	false	Developer-defined business number, length limit 500
	deliveryMethods			string	false	Notification method, defaults to auto auto-Sends email notification when userEmail is passed, sends SMS notification when phoneNumber is passed none-No message notification sent email-Sends email notification sms-Sends SMS notification WhatsApp-Sends WhatsApp notification
	userEmail			string	false	Signer email address
	userName			string	true	Signer name, used to display the signer's name on the signing page and envelope. [Note] Must not contain the following 9 special characters: / \ : * " < > \| ? and any emoji
	minimumReadingDuration			int	false	Sets the mandatory reading countdown time for the page, default value is 0 (unit: seconds, maximum 999) 0 or not passing indicates disabled, no reading countdown required
	readToEndRequired			boolean	false	Indicates whether full reading is mandatory. Default is false; true indicates enabled; false or omission indicates disabled.
	phoneNumber			object	false	Phone number, defaults to empty. Required parameter when SMS notification is needed; both countryCode and number must be passed.
		countryCode		string	false	International country/region code; do not include '+'.
		number		string	false	No format validation; maximum length is 13 characters.
	customizeSettings			object	false	Custom configuration
		notificationSettings		object	false	Custom configuration for notifications
			customizeMessage	string	false	Dedicated message notification, character limit 200
			notificationLanguage	string	false	Notification language, defaults to the 'Default Notification Language' configuration. en-US English zh-CN Simplified Chinese zh-Hant Traditional Chinese ja-JP Japanese es-MX Spanish pt-PT Portuguese th-TH Thai id-ID Indonesian vi-VN Vietnamese ms-MY Malay fil-PH Filipino de-DE German fr-FR French ru-RU Russian it-IT Italian ko-KR Korean
	authModes			string	false	Verification method, defaults to noAuth noAuth-No verification accessCode-Verify using signing passcode sms-SMS OTP verification idVerification-ID verification emailAuth-Email OTP Verification digitalId-Digital ID Verification whatsappAuth-WhatsApp OTP Verification
	authConfig			object	false	Verification Method Settings
		accessCode		object	false	Signing password settings, required when authModes=accessCode
			accessCode	string	false	Password content, case-insensitive, can contain alphanumeric characters, length limit 45
			promptInfo	string	false	Access password prompt message, cannot contain the access password, length limit 30, required when authModes=1.
		sms		object	false	SMS OTP verification, required when authModes=sms
			countryCode	string	false	International country/region code, no need to include '+'
			number	string	false	No format validation, only limits maximum length to 13 characters
		idVerification		object	false	ID document verification settings, required when authModes=idVerification
			name	string	false	Full name on the signer's ID document, maximum length 100 characters
		emailAuth		object	false	Email OTP verification, required when authModes=emailAuth
			authEmail	string	false	Signer's identity verification email address
		digitalId		array	false	Digital ID verification, required when authModes=digitalId
			authApp	string	false	APP used for electronic identity verification singpass - Identity authentication using Singpass
			idNumber	string	false	Signer's ID document number to be verified
		whatsappAuth		object	false	WhatsApp OTP verification, required when authModes=whatsappAuth
			countryCode	string	false	International code for country/region, no need to pass '+'
			number	string	false	No format validation, only restricted to a maximum length of 13 characters

Response example

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