Editar firmante

POST/esignglobal/v1/envelope/recipients/editSigners

Descripción de la interfaz

Modifica la información del firmante que aún no ha completado la firma en el sobre.

Una vez creado el sobre, si los desarrolladores detectan errores en el contacto del firmante, su nombre, la configuración de notificaciones o el método de autenticación, o necesitan cambiar la información del firmante, pueden usar esta interfaz para actualizar la información de los firmantes pendientes de firma, evitando así que el sobre se anule y deba reenviarse por errores de datos.

Notas

Solo se permite modificar a firmantes que aún no han completado la firma.
No se permiten modificaciones para firmantes en estados finales como "firmado" o "rechazado".
No se admite la modificación de la información del firmante cuando el sobre está en estado final o ha sido anulado.
Cuando el método de notificación incluye tanto SMS como correo electrónico, no se admite modificar solo phoneNumber。
La interfaz comparará la información del firmante proporcionada con la información actual del firmante; si difieren, se actualizará la información correspondiente del firmante.

Parámetros de solicitud

Nombre del parámetro				Tipo	Requerido	Descripción
envelopeId				string	true	ID del sobre
signerInfos				object	true	Información del firmante
	recipientId			string	true	ID del participante
	businessId			string	false	Número de negocio personalizado por el desarrollador, límite de longitud 500
	deliveryMethods			string	false	Método de notificación, el valor predeterminado es auto auto- envía notificación por correo electrónico cuando se pasa userEmail, y notificación por SMS cuando se pasa phoneNumber none- no envía notificaciones de mensaje email- envía notificación por correo electrónico sms- envía notificación por SMS WhatsApp- envía notificación por WhatsApp
	userEmail			string	false	Dirección de correo electrónico del firmante
	userName			string	true	Nombre del firmante, utilizado para mostrar el nombre del firmante en la página de firma y en el sobre. [Nota] No debe contener los siguientes 9 caracteres especiales: / \ : * " < > \| ？ y todos los emojis
	minimumReadingDuration			int	false	Tiempo de cuenta regresiva obligatoria para la lectura de la página, el valor predeterminado es 0 (unidad: segundos, máximo 999) 0 o no especificar indica que no está habilitado, sin necesidad de cuenta regresiva de lectura
	readToEndRequired			boolean	false	Indica si es obligatorio leer hasta el final. Valor predeterminado: false; true indica activado, false o no enviar indica desactivado.
	phoneNumber			object	false	Número de teléfono, vacío por defecto Parámetro obligatorio cuando se requiere notificación por SMS; deben enviarse tanto countryCode como number
		countryCode		string	false	Código internacional del país o región, no es necesario incluir el signo '+'
		number		string	false	Sin validación de formato, solo se limita la longitud máxima a 13 caracteres
	customizeSettings			object	false	Configuración personalizada
		notificationSettings		object	false	Configuración personalizada para notificaciones
			customizeMessage	string	false	Notificación de mensaje exclusivo, límite de 200 caracteres
			notificationLanguage	string	false	Idioma de notificación, toma por defecto la configuración de 'idioma de notificación predeterminado' en-US Inglés zh-CN Chino simplificado zh-Hant Chino tradicional ja-JP Japonés es-MX Español pt-PT Portugués th-TH tailandés id-ID indonesio vi-VN vietnamita ms-MY malayo fil-PH filipino de-DE alemán fr-FR francés ru-RU ruso it-IT italiano ko-KR coreano
	authModes			string	false	Método de verificación, por defecto noAuth noAuth-Sin verificación accessCode-Verificar con contraseña de firma sms-Verificación OTP por SMS idVerification-Verificación de documento de identidad emailAuth-Verificación OTP por correo electrónico digitalId-Verificación de identidad electrónica whatsappAuth-Verificación OTP de WhatsApp
	authConfig			object	false	Configuración del método de verificación
		accessCode		object	false	Configuración de la contraseña de firma, obligatoria cuando authModes=accessCode
			accessCode	string	false	Contenido de la contraseña, sin distinción de mayúsculas y minúsculas, puede contener letras y números, límite de longitud 45
			promptInfo	string	false	Mensaje de aviso de la contraseña de acceso, no debe contener la contraseña de acceso, límite de longitud 30, obligatorio cuando authModes=1.
		sms		object	false	Verificación OTP por SMS, obligatoria cuando authModes=sms
			countryCode	string	false	Código internacional del país o región, no es necesario introducir el “+”
			number	string	false	Sin validación de formato, solo se limita la longitud máxima a 13 caracteres
		idVerification		object	false	Configuración de verificación de documento de identidad, obligatoria cuando authModes=idVerification
			name	string	false	Nombre completo en el documento de identidad del firmante, longitud máxima de 100 caracteres
		emailAuth		object	false	Verificación OTP por correo electrónico, obligatoria cuando authModes=emailAuth
			authEmail	string	false	Dirección de correo electrónico para la verificación de identidad del firmante
		digitalId		array	false	Verificación de identidad electrónica, obligatoria cuando authModes=digitalId
			authApp	string	false	Aplicación utilizada para la verificación de identidad electrónica singpass - Autenticación de identidad mediante Singpass
			idNumber	string	false	Número de documento de identidad del firmante a verificar
		whatsappAuth		object	false	Verificación OTP de WhatsApp, obligatorio cuando authModes=whatsappAuth
			countryCode	string	false	Código internacional del país o región, no es necesario incluir el '+'
			number	string	false	No se realiza validación de formato, solo se limita la longitud máxima a 13 caracteres

Ejemplo de respuesta

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