Modifier le signataire

POST/esignglobal/v1/envelope/recipients/editSigners

Description de l'interface

Modifie les informations du signataire dont la signature n'est pas encore finalisée dans le dossier.

Après la création du dossier, si le développeur constate une erreur dans les coordonnées du signataire, son nom, la configuration de notification ou le mode d'authentification, ou s'il doit modifier les informations du signataire, il peut utiliser cette interface pour mettre à jour les informations du signataire dont la signature n'est pas encore finalisée, afin d'éviter l'annulation et le renvoi du dossier en cas d'erreur d'information.

Remarques

Seuls les signataires dont la signature n'est pas encore finalisée peuvent être modifiés.
Les signataires ayant atteint un état final (signé, refusé, etc.) ne peuvent pas être modifiés.
La modification des informations du signataire n'est pas prise en charge lorsque le dossier est dans un état final ou annulé.
Lorsque le mode de notification comprend à la fois le SMS et l'e-mail, la modification exclusive de phoneNumber。
L'interface compare les informations du signataire transmises avec celles actuellement enregistrées ; si elles diffèrent, les informations correspondantes sont mises à jour.

Paramètres de requête

Nom du paramètre				Type	Obligatoire	Description
envelopeId				string	true	ID du dossier
signerInfos				object	true	Informations du signataire
	recipientId			string	true	ID du participant
	businessId			string	false	Numéro de référence personnalisé par le développeur, longueur maximale de 500
	deliveryMethods			string	false	Mode de notification, par défaut auto auto- Envoi d'un e-mail lorsque userEmail est fourni, envoi d'un SMS lorsque phoneNumber est fourni none- Aucune notification n'est envoyée email- Envoi d'une notification par e-mail sms- Envoi d'une notification par SMS WhatsApp- Envoi d'une notification WhatsApp
	userEmail			string	false	Adresse e-mail du signataire
	userName			string	true	Nom du signataire, utilisé pour afficher le nom du signataire sur la page de signature et sur l'enveloppe. [Remarque] Ne doit pas contenir les 9 caractères spéciaux suivants : / \ : * " < > \| ? ainsi que tous les emojis
	minimumReadingDuration			int	false	Durée du compte à rebours de lecture obligatoire pour la page, valeur par défaut 0 (unité : seconde, maximum 999) 0 ou valeur manquante indique que la fonction est désactivée, aucun compte à rebours de lecture requis
	readToEndRequired			boolean	false	Indique s'il est obligatoire de lire jusqu'au bout. Valeur par défaut : false ; true indique activé, false ou l'absence de valeur indique désactivé.
	phoneNumber			object	false	Numéro de téléphone, vide par défaut Paramètre obligatoire pour les notifications par SMS, countryCode et number doivent tous deux être fournis
		countryCode		string	false	Code international du pays ou de la région, le « + » n'est pas requis
		number		string	false	Aucune validation de format, longueur maximale de 13 caractères
	customizeSettings			object	false	Configuration personnalisée
		notificationSettings		object	false	Configuration personnalisée pour les notifications
			customizeMessage	string	false	Notification de message dédié, limite de 200 caractères
			notificationLanguage	string	false	Langue de notification, utilise par défaut la configuration « Langue de notification par défaut » en-US Anglais zh-CN Chinois simplifié zh-Hant Chinois traditionnel ja-JP Japonais es-MX Espagnol pt-PT Portugais th-TH thaï id-ID indonésien vi-VN vietnamien ms-MY malais fil-PH philippin de-DE allemand fr-FR français ru-RU russe it-IT italien ko-KR coréen
	authModes			string	false	Mode de vérification, par défaut noAuth noAuth-Aucune vérification accessCode-Vérification par code de signature sms-Vérification OTP par SMS idVerification-Vérification par pièce d'identité emailAuth-Vérification OTP par e-mail digitalId-Vérification d'identité électronique whatsappAuth-Vérification OTP WhatsApp
	authConfig			object	false	Paramètres des méthodes de vérification
		accessCode		object	false	Paramètres du mot de passe de signature, obligatoire lorsque authModes=accessCode
			accessCode	string	false	Contenu du mot de passe, insensible à la casse, peut contenir des lettres et des chiffres, longueur maximale de 45 caractères
			promptInfo	string	false	Message d'invite pour le mot de passe d'accès, ne doit pas contenir le mot de passe d'accès, longueur maximale de 30 caractères, obligatoire lorsque authModes=1.
		sms		object	false	Vérification OTP par SMS, obligatoire lorsque authModes=sms
			countryCode	string	false	Indicatif international du pays ou de la région, sans le signe +
			number	string	false	Aucune validation de format, seule une limite de longueur maximale de 13 caractères s'applique
		idVerification		object	false	Paramètres de vérification de pièce d'identité, obligatoire lorsque authModes=idVerification
			name	string	false	Nom complet tel qu'il figure sur la pièce d'identité du signataire, longueur maximale de 100 caractères
		emailAuth		object	false	Vérification OTP par e-mail, obligatoire lorsque authModes=emailAuth
			authEmail	string	false	Adresse e-mail de vérification d'identité du signataire
		digitalId		array	false	Vérification d'identité électronique, obligatoire lorsque authModes=digitalId
			authApp	string	false	Application utilisée pour l'authentification électronique singpass - Authentification à l'aide de Singpass
			idNumber	string	false	Numéro de pièce d'identité du signataire à vérifier
		whatsappAuth		object	false	Vérification OTP WhatsApp, obligatoire lorsque authModes=whatsappAuth
			countryCode	string	false	Code international du pays ou de la région, sans inclure le signe « + »
			number	string	false	Aucune validation de format, seule une longueur maximale de 13 caractères est requise

Exemple de réponse

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