Sunting Penandatangan

POST/esignglobal/v1/envelope/recipients/editSigners

Deskripsi API

Memodifikasi informasi penandatangan yang belum ditandatangani dalam amplop.

Setelah membuat amplop, pengembang dapat menggunakan API ini untuk memperbarui informasi penandatangan yang belum ditandatangani jika terjadi kesalahan pada kontak, nama, konfigurasi notifikasi, atau metode autentikasi penandatangan, atau jika perlu mengganti penandatangan. Langkah ini mencegah pembatalan dan pengiriman ulang amplop akibat kesalahan data.

Catatan Penting

Hanya mendukung modifikasi penandatangan yang belum ditandatangani.
Penandatangan dengan status akhir seperti telah ditandatangani atau ditolak tidak dapat dimodifikasi.
Modifikasi informasi penandatangan tidak didukung saat amplop berada dalam status akhir atau telah dibatalkan.
Ketika metode notifikasi mencakup SMS dan email, tidak mendukung hanya memodifikasi phoneNumber。
API akan membandingkan informasi penandatangan yang dikirimkan dengan informasi penandatangan saat ini; jika tidak sesuai, informasi penandatangan terkait akan diperbarui.

Parameter Permintaan

Nama Parameter				Tipe	Wajib Diisi	Keterangan
envelopeId				string	true	ID Amplop
signerInfos				object	true	Informasi Penandatangan
	recipientId			string	true	ID Peserta
	businessId			string	false	Nomor bisnis kustom pengembang, batas panjang 500
	deliveryMethods			string	false	Metode notifikasi, default auto auto-kirim notifikasi email saat userEmail diisi, kirim notifikasi SMS saat phoneNumber diisi none-tidak mengirim notifikasi pesan email-mengirim notifikasi email sms-mengirim notifikasi SMS WhatsApp-mengirim notifikasi WhatsApp
	userEmail			string	false	Alamat email penandatangan
	userName			string	true	Nama penandatangan, digunakan untuk menampilkan nama penandatangan pada halaman tanda tangan dan amplop. 【Catatan】Tidak boleh mengandung 9 karakter khusus berikut: / \ : * " < > \| ? serta semua emoji
	minimumReadingDuration			int	false	Atur waktu hitung mundur bacaan wajib halaman, nilai default 0 (satuan: detik, maksimum 999) 0 atau tidak dikirim berarti tidak diaktifkan, tanpa hitung mundur bacaan
	readToEndRequired			boolean	false	Menunjukkan apakah harus dibaca hingga selesai. Default false; true menunjukkan aktif, false atau tidak diisi menunjukkan tidak aktif.
	phoneNumber			object	false	Nomor telepon, secara default kosong Parameter wajib ketika diperlukan notifikasi SMS, countryCode dan number harus disertakan
		countryCode		string	false	Kode internasional negara/wilayah, tidak perlu menyertakan tanda '+'
		number		string	false	Tidak ada validasi format, hanya membatasi panjang maksimal 13 karakter
	customizeSettings			object	false	Konfigurasi kustom
		notificationSettings		object	false	Konfigurasi kustom untuk jenis notifikasi
			customizeMessage	string	false	Notifikasi pesan khusus, batas karakter 200
			notificationLanguage	string	false	Bahasa notifikasi, secara default mengikuti konfigurasi 'Bahasa Notifikasi Default' en-US Bahasa Inggris zh-CN Bahasa Mandarin Sederhana zh-Hant Bahasa Mandarin Tradisional ja-JP Bahasa Jepang es-MX Bahasa Spanyol pt-PT Bahasa Portugis th-TH Bahasa Thailand id-ID Bahasa Indonesia vi-VN Bahasa Vietnam ms-MY Bahasa Melayu fil-PH Bahasa Filipina de-DE Bahasa Jerman fr-FR Bahasa Prancis ru-RU Bahasa Rusia it-IT Bahasa Italia ko-KR Bahasa Korea
	authModes			string	false	Metode verifikasi, default adalah noAuth noAuth-Tidak memverifikasi accessCode-Verifikasi menggunakan kata sandi penandatanganan sms-Verifikasi SMS OTP idVerification-Verifikasi dokumen identitas emailAuth-Verifikasi OTP Email digitalId-Verifikasi Identitas Elektronik whatsappAuth-Verifikasi OTP WhatsApp
	authConfig			object	false	Pengaturan Metode Verifikasi
		accessCode		object	false	Pengaturan kata sandi penandatanganan, wajib diisi ketika authModes=accessCode
			accessCode	string	false	Konten kata sandi, tidak membedakan huruf besar/kecil, dapat mengandung huruf dan angka, batas panjang 45
			promptInfo	string	false	Pesan petunjuk kata sandi akses, tidak boleh memuat kata sandi akses, batas panjang 30, wajib diisi ketika authModes=1.
		sms		object	false	Validasi OTP SMS, wajib diisi ketika authModes=sms
			countryCode	string	false	Kode internasional negara/wilayah, tidak perlu memasukkan tanda “+”
			number	string	false	Tidak ada validasi format, hanya dibatasi panjang maksimal 13 karakter
		idVerification		object	false	Pengaturan validasi dokumen identitas, wajib diisi ketika authModes=idVerification
			name	string	false	Nama lengkap sesuai dokumen identitas penandatangan, panjang maksimal 100 karakter
		emailAuth		object	false	Validasi OTP Email, wajib diisi ketika authModes=emailAuth
			authEmail	string	false	Alamat email verifikasi identitas penandatangan
		digitalId		array	false	Verifikasi identitas elektronik, wajib diisi ketika authModes=digitalId
			authApp	string	false	Aplikasi yang digunakan untuk verifikasi identitas elektronik singpass-Menggunakan Singpass untuk autentikasi identitas
			idNumber	string	false	Nomor dokumen identitas penandatangan yang akan diverifikasi
		whatsappAuth		object	false	Verifikasi OTP WhatsApp, wajib diisi ketika authModes=whatsappAuth
			countryCode	string	false	Kode internasional negara/wilayah, tidak perlu menyertakan tanda '+'
			number	string	false	Tidak memvalidasi format, hanya membatasi panjang maksimal 13 digit

Contoh respons

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