Редактировать подписанта

POST/esignglobal/v1/envelope/recipients/editSigners

Описание интерфейса

Изменение информации о подписантах, не завершивших подписание в конверте.

После создания конверта разработчик может использовать данный интерфейс для обновления информации о подписантах, не завершивших подписание, если были допущены ошибки в контактных данных, имени, настройках уведомлений или способе аутентификации, либо если требуется замена подписанта. Это позволяет избежать аннулирования конверта и необходимости его повторной отправки из-за некорректных данных.

Примечания

Поддерживается изменение только подписантов, не завершивших подписание.
Подписанты, достигшие конечного статуса (например, «Подписано» или «Отказано»), не подлежат изменению.
Изменение информации о подписантах невозможно, если конверт находится в конечном статусе или уже аннулирован.
При одновременном использовании SMS и электронной почты для уведомлений невозможно изменить только phoneNumber。
Интерфейс сопоставляет переданные данные о подписанте с текущими; при выявлении расхождений информация соответствующего подписанта будет обновлена.

Параметры запроса

Имя параметра				Тип	Обязательный	Описание
envelopeId				string	true	ID конверта
signerInfos				object	true	Информация о подписанте
	recipientId			string	true	ID участника
	businessId			string	false	Бизнес-идентификатор, задаваемый разработчиком, ограничение длины — 500
	deliveryMethods			string	false	Способ уведомления, по умолчанию auto auto — при передаче userEmail отправляется уведомление по электронной почте, при передаче phoneNumber — SMS-уведомление none — не отправлять уведомления email — отправка уведомления по электронной почте sms — отправка SMS-уведомления WhatsApp — отправка уведомления через WhatsApp
	userEmail			string	false	Адрес электронной почты подписанта
	userName			string	true	Имя подписанта, используется для отображения имени подписанта на странице подписания и на конверте. [Примечание] Запрещено использование следующих 9 специальных символов: / \ : * " < > \| ？ , а также любых эмодзи
	minimumReadingDuration			int	false	Время обратного отсчета для обязательного чтения страницы, значение по умолчанию 0 (единица измерения: секунды, максимум 999) 0 или отсутствие значения означает отключение, без необходимости обратного отсчета для чтения
	readToEndRequired			boolean	false	Указывает, обязательно ли прочитать документ до конца. По умолчанию false; true означает включение, false или отсутствие параметра — отключение.
	phoneNumber			object	false	Номер телефона, по умолчанию пустое значение. Обязательный параметр при необходимости отправки SMS-уведомления; необходимо передать countryCode и number.
		countryCode		string	false	Международный код страны или региона, символ «+» передавать не нужно.
		number		string	false	Проверка формата отсутствует, максимальная длина — 13 символов.
	customizeSettings			object	false	Пользовательские настройки
		notificationSettings		object	false	Пользовательские настройки уведомлений
			customizeMessage	string	false	Уведомление о персональном сообщении, ограничение до 200 символов
			notificationLanguage	string	false	Язык уведомления, по умолчанию применяется настройка «Язык уведомления по умолчанию» en-US Английский язык zh-CN Китайский язык (упрощенный) zh-Hant Китайский язык (традиционный) ja-JP Японский язык es-MX Испанский язык pt-PT Португальский язык th-TH тайский язык id-ID индонезийский язык vi-VN вьетнамский язык ms-MY малайский язык fil-PH филиппинский язык de-DE немецкий язык fr-FR французский язык ru-RU русский язык it-IT итальянский язык ko-KR корейский язык
	authModes			string	false	Способ проверки, по умолчанию noAuth noAuth-без проверки accessCode-проверка по коду подписания sms-проверка SMS OTP idVerification-проверка удостоверения личности emailAuth-Проверка OTP по электронной почте digitalId-Электронная идентификация whatsappAuth-Проверка OTP через WhatsApp
	authConfig			object	false	Настройки способа проверки
		accessCode		object	false	Настройка пароля для подписания, обязательно при authModes=accessCode
			accessCode	string	false	Содержимое пароля, регистр не учитывается, может содержать буквы и цифры, ограничение длины — 45 символов
			promptInfo	string	false	Подсказка для пароля доступа, не должна содержать сам пароль, ограничение длины — 30 символов, обязательно при authModes=1.
		sms		object	false	Проверка SMS OTP, обязательно при authModes=sms
			countryCode	string	false	Международный код страны или региона, символ «+» указывать не нужно
			number	string	false	Проверка формата не выполняется, максимальная длина ограничена 13 символами
		idVerification		object	false	Настройки проверки удостоверения личности, обязательно при authModes=idVerification
			name	string	false	Полное имя на документе, удостоверяющем личность подписанта, максимальная длина — 100 символов
		emailAuth		object	false	Проверка OTP по электронной почте, обязательно при authModes=emailAuth
			authEmail	string	false	Адрес электронной почты подписанта для проверки личности
		digitalId		array	false	Электронная идентификация, обязательно при authModes=digitalId
			authApp	string	false	Приложение для электронной аутентификации singpass-использование Singpass для аутентификации
			idNumber	string	false	Номер удостоверения личности подписанта для проверки
		whatsappAuth		object	false	Проверка OTP в WhatsApp, обязательно при authModes=whatsappAuth
			countryCode	string	false	Международный код страны или региона, знак "+" указывать не требуется
			number	string	false	Проверка формата не выполняется, максимальная длина ограничена 13 символами

Пример ответа

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