Editar Assinante

POST/esignglobal/v1/envelope/recipients/editSigners

Descrição da interface

Modifica as informações do signatário que ainda não concluiu a assinatura no envelope.

Após a criação do envelope, se os desenvolvedores detectarem erros no contato, nome, configurações de notificação ou método de autenticação do signatário, ou precisarem substituir essas informações, poderão utilizar esta interface para atualizar os dados do signatário pendente de assinatura, evitando que o envelope seja anulado e reenviado por erro de informação.

Observações

Apenas signatários pendentes de assinatura podem ser modificados.
Signatários em estado final, como assinado ou recusado, não suportam modificações.
Não é possível modificar as informações do signatário quando o envelope está em estado final ou já foi anulado.
Quando o método de notificação incluir simultaneamente SMS e e-mail, não será possível modificar apenas phoneNumber。
A interface compara as informações do signatário enviadas com as informações atuais; caso haja divergência, as informações correspondentes serão atualizadas.

Parâmetros de solicitação

Nome do parâmetro				Tipo	Obrigatório	Descrição
envelopeId				string	true	ID do envelope
signerInfos				object	true	Informações do signatário
	recipientId			string	true	ID do participante
	businessId			string	false	Número de negócio personalizado pelo desenvolvedor, limite de 500 caracteres
	deliveryMethods			string	false	Método de notificação, padrão: auto auto - envia notificação por e-mail quando o userEmail é fornecido, envia notificação por SMS quando o phoneNumber é fornecido none - não envia notificação de mensagem email - envia notificação por e-mail sms - envia notificação por SMS WhatsApp - envia notificação via WhatsApp
	userEmail			string	false	Endereço de e-mail do signatário
	userName			string	true	Nome do signatário, utilizado para exibir o nome do signatário na página de assinatura e no envelope. [Nota] Não pode conter os seguintes 9 caracteres especiais: / \ : * " < > \| ？ nem qualquer emoji
	minimumReadingDuration			int	false	Define o tempo de contagem regressiva obrigatória da página, valor padrão 0 (unidade: segundos, máximo 999) 0 ou não informar indica desativado, sem necessidade de contagem regressiva de leitura
	readToEndRequired			boolean	false	Indica se é obrigatório ler até o fim. Padrão: false; true indica ativado, false ou não informado indica desativado.
	phoneNumber			object	false	Número de telefone, padrão vazio Parâmetro obrigatório quando necessária notificação por SMS; countryCode e number devem ser informados
		countryCode		string	false	Código internacional do país/região, não é necessário informar o “+”
		number		string	false	Sem validação de formato, apenas limite máximo de 13 caracteres
	customizeSettings			object	false	Configuração personalizada
		notificationSettings		object	false	Configuração personalizada para notificações
			customizeMessage	string	false	Notificação de mensagem exclusiva, limite de 200 caracteres
			notificationLanguage	string	false	Idioma da notificação, padrão utiliza a configuração “idioma de notificação padrão” en-US Inglês zh-CN Chinês Simplificado zh-Hant Chinês Tradicional ja-JP Japonês es-MX Espanhol pt-PT Português th-TH Tailandês id-ID Indonésio vi-VN Vietnamita ms-MY Malaio fil-PH Filipino de-DE Alemão fr-FR Francês ru-RU Russo it-IT Italiano ko-KR Coreano
	authModes			string	false	Método de verificação, padrão é noAuth noAuth-sem verificação accessCode-verificação por senha de assinatura sms-verificação OTP por SMS idVerification-verificação de documento de identidade emailAuth-Verificação OTP por e-mail digitalId-Verificação de identidade eletrônica whatsappAuth-Verificação OTP via WhatsApp
	authConfig			object	false	Configuração do método de verificação
		accessCode		object	false	Configuração da senha de assinatura, obrigatório quando authModes=accessCode
			accessCode	string	false	Conteúdo da senha, não diferencia maiúsculas de minúsculas, pode conter caracteres alfanuméricos, limite de tamanho 45
			promptInfo	string	false	Mensagem de dica da senha de acesso, não pode conter a senha de acesso, limite de tamanho 30, obrigatório quando authModes=1.
		sms		object	false	Validação OTP por SMS, obrigatório quando authModes=sms
			countryCode	string	false	Código internacional do país ou região, não é necessário inserir o “+”
			number	string	false	Sem validação de formato, apenas limite máximo de 13 caracteres
		idVerification		object	false	Configuração de verificação de documento de identidade, obrigatório quando authModes=idVerification
			name	string	false	Nome completo do signatário conforme documento de identidade, comprimento máximo de 100 caracteres
		emailAuth		object	false	Validação OTP por e-mail, obrigatório quando authModes=emailAuth
			authEmail	string	false	Endereço de e-mail para verificação de identidade do signatário
		digitalId		array	false	Verificação de identidade eletrônica, obrigatório quando authModes=digitalId
			authApp	string	false	Aplicativo utilizado para autenticação de identidade eletrônica singpass - Utilização do Singpass para autenticação de identidade
			idNumber	string	false	Número do documento de identificação do signatário a verificar
		whatsappAuth		object	false	Verificação OTP do WhatsApp, obrigatório quando authModes=whatsappAuth
			countryCode	string	false	Código internacional do país/região, não é necessário informar o '+'
			number	string	false	Sem validação de formato, com limite máximo de 13 caracteres

Exemplo de resposta

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