Chỉnh sửa người ký

POST/esignglobal/v1/envelope/recipients/editSigners

Mô tả giao diện

Chỉnh sửa thông tin người ký chưa hoàn tất ký trong phong bì.

Sau khi tạo phong bì, nếu phát hiện thông tin liên hệ, tên người ký, cấu hình thông báo hoặc phương thức xác thực danh tính bị điền sai, hoặc cần thay đổi thông tin người ký, nhà phát triển có thể sử dụng giao diện này để cập nhật thông tin người ký chưa hoàn tất ký, nhằm tránh việc phong bì bị hủy và phải gửi lại do lỗi thông tin.

Lưu ý

Chỉ hỗ trợ chỉnh sửa người ký chưa hoàn tất ký.
Không hỗ trợ chỉnh sửa người ký ở trạng thái cuối cùng như đã ký, đã từ chối ký, v.v.
Không hỗ trợ chỉnh sửa thông tin người ký khi phong bì đang ở trạng thái cuối cùng hoặc đã bị hủy.
Khi phương thức thông báo bao gồm cả tin nhắn SMS và email, không hỗ trợ chỉ chỉnh sửa phoneNumber。
Giao diện sẽ đối chiếu thông tin người ký được truyền vào với thông tin người ký hiện tại; nếu thông tin không khớp, hệ thống sẽ cập nhật thông tin của người ký tương ứng.

Tham số yêu cầu

Tên tham số				Kiểu	Bắt buộc	Mô tả
envelopeId				string	true	ID phong bì
signerInfos				object	true	Thông tin người ký
	recipientId			string	true	ID người tham gia
	businessId			string	false	Mã nghiệp vụ do nhà phát triển tự định nghĩa, giới hạn độ dài 500
	deliveryMethods			string	false	Phương thức thông báo, mặc định là auto auto - khi truyền userEmail sẽ gửi thông báo qua email, khi truyền phoneNumber sẽ gửi thông báo qua SMS none - không gửi thông báo tin nhắn email - gửi thông báo qua email sms - gửi thông báo qua SMS WhatsApp - gửi thông báo WhatsApp
	userEmail			string	false	Địa chỉ email của người ký
	userName			string	true	Tên người ký, dùng để hiển thị tên người ký trên trang ký và phong bì. 【Lưu ý】Không được chứa 9 ký tự đặc biệt sau: / \ : * " < > \| ? và tất cả biểu tượng cảm xúc emoji
	minimumReadingDuration			int	false	Thời gian đếm ngược bắt buộc đọc trang, giá trị mặc định là 0 (đơn vị: giây, tối đa 999) 0 hoặc không truyền có nghĩa là không kích hoạt, không cần đếm ngược thời gian đọc
	readToEndRequired			boolean	false	Cho biết có bắt buộc phải đọc đến cuối hay không. Mặc định là false; true để bật, false hoặc không truyền để tắt.
	phoneNumber			object	false	Số điện thoại, mặc định là rỗng Tham số bắt buộc khi cần thông báo tin nhắn, cả countryCode và number đều phải truyền vào
		countryCode		string	false	Mã quốc gia/khu vực, không cần truyền dấu "+"
		number		string	false	Không kiểm tra định dạng, chỉ giới hạn độ dài tối đa là 13 ký tự
	customizeSettings			object	false	Cấu hình tùy chỉnh
		notificationSettings		object	false	Cấu hình tùy chỉnh loại thông báo
			customizeMessage	string	false	Thông báo tin nhắn chuyên dụng, giới hạn 200 ký tự
			notificationLanguage	string	false	Ngôn ngữ thông báo, mặc định lấy cấu hình "Ngôn ngữ thông báo mặc định" en-US Tiếng Anh zh-CN Tiếng Trung giản thể zh-Hant Tiếng Trung phồn thể ja-JP Tiếng Nhật es-MX Tiếng Tây Ban Nha pt-PT Tiếng Bồ Đào Nha th-TH tiếng Thái id-ID tiếng Indonesia vi-VN tiếng Việt ms-MY tiếng Mã Lai fil-PH tiếng Philippines de-DE tiếng Đức fr-FR tiếng Pháp ru-RU tiếng Nga it-IT tiếng Ý ko-KR tiếng Hàn
	authModes			string	false	Phương thức xác thực, mặc định là noAuth noAuth-Không xác thực accessCode-Xác thực bằng mật khẩu ký sms-Xác thực OTP SMS idVerification-Xác thực giấy tờ tùy thân emailAuth-Xác thực OTP qua email digitalId-Xác thực danh tính điện tử whatsappAuth-Xác thực OTP qua WhatsApp
	authConfig			object	false	Thiết lập phương thức xác thực
		accessCode		object	false	Thiết lập mật khẩu ký, bắt buộc khi authModes=accessCode
			accessCode	string	false	Nội dung mật khẩu, không phân biệt chữ hoa thường, có thể chứa chữ cái và số, giới hạn độ dài 45
			promptInfo	string	false	Lời nhắc mật khẩu truy cập, không được chứa mật khẩu truy cập, giới hạn độ dài 30, bắt buộc khi authModes=1.
		sms		object	false	Kiểm tra OTP qua SMS, bắt buộc khi authModes=sms
			countryCode	string	false	Mã quốc tế của quốc gia/khu vực, không cần truyền dấu “+”
			number	string	false	Không kiểm tra định dạng, chỉ giới hạn độ dài tối đa là 13 ký tự
		idVerification		object	false	Thiết lập xác thực giấy tờ tùy thân, bắt buộc khi authModes=idVerification
			name	string	false	Họ và tên đầy đủ trên giấy tờ tùy thân của người ký, độ dài tối đa 100 ký tự
		emailAuth		object	false	Kiểm tra OTP qua email, bắt buộc khi authModes=emailAuth
			authEmail	string	false	Địa chỉ email xác thực danh tính của người ký
		digitalId		array	false	Xác thực danh tính điện tử, bắt buộc khi authModes=digitalId
			authApp	string	false	Ứng dụng dùng để xác thực danh tính điện tử singpass-Sử dụng Singpass để xác thực danh tính
			idNumber	string	false	Số giấy tờ tùy thân của người ký cần xác thực
		whatsappAuth		object	false	Xác thực OTP qua WhatsApp, bắt buộc khi authModes=whatsappAuth
			countryCode	string	false	Mã quốc tế của quốc gia/khu vực, không cần truyền ký tự “+”
			number	string	false	Không kiểm tra định dạng, chỉ giới hạn độ dài tối đa là 13 ký tự

Ví dụ phản hồi

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