Memulai penandatanganan menggunakan templat amplop

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

Deskripsi Antarmuka

Gunakan "template amplop" yang telah dikonfigurasi sebelumnya di sisi halaman untuk memulai penandatanganan.

Parameter permintaan

Nama parameter				Tipe	Wajib	Keterangan
envelopeTemplateId				string	true	ID template amplop
envelopeConfig				object	true	Konfigurasi alur penandatanganan
	contractConfig			boolean	false	Konfigurasi penandatanganan kontrak
		envelopeRemark		array	false	Catatan kontrak
	envelopeSubject			string	true	Topik alur penandatanganan ini
	expireAfterSeconds			int	false	Batas waktu penandatanganan untuk alur ini. Setelah melewati waktu tersebut, penandatanganan tidak dapat dilanjutkan. Timestamp Unix dalam milidetik, masa berlaku default dan maksimum adalah 90 hari.
	callbackUrl			string	false	Alamat Web untuk menerima notifikasi callback
	redirectUrl			string	false	Harus berupa alamat https yang valid
	signConfig			object	false	Item konfigurasi penandatanganan
		allowTransfer		boolean	false	Apakah penandatangan diizinkan untuk menyerahkan amplop ini kepada orang lain untuk ditandatangani, default false true-Mengizinkan penandatangan dalam amplop memiliki hak untuk menyerahkan amplop kepada orang lain; false-Tidak mengizinkan penandatangan dalam amplop memiliki hak untuk menyerahkan amplop kepada orang lain;
participants				array	false	Konfigurasi peserta
	participantId			string	true	ID peserta
	authConfig			object	false	Item konfigurasi autentikasi
		willingnessAuthModes		array	false	Metode verifikasi niat penandatangan yang dapat dipilih, default noAuth noAuth-Tidak memverifikasi accessCode-Memverifikasi menggunakan kata sandi penandatanganan sms-Verifikasi OTP SMS idVerification-Verifikasi dokumen identitas emailAuth-Verifikasi OTP email digitalId-Verifikasi identitas digital whatsappAuth-Verifikasi OTP whatsapp
		accessCode		object	false	Pengaturan kode akses tanda tangan, wajib diisi saat authModes=accessCode
			accessCode	string	false	Isi kode akses, tidak membedakan huruf besar/kecil, dapat berisi huruf dan angka, batas panjang 45
			promptInfo	string	false	Pesan petunjuk kode akses, tidak boleh memuat kode akses, batas panjang 30, wajib diisi saat authModes=1.
		sms		object	false	Verifikasi OTP SMS, wajib diisi saat authModes=sms
			countryCode	string	false	Kode internasional negara/wilayah, tidak perlu memasukkan "+"
			number	string	false	Tidak dilakukan verifikasi format, hanya dibatasi panjang maksimal 13 karakter
		idVerification		object	false	Pengaturan verifikasi dokumen identitas, wajib diisi saat authModes=idVerification
			name	string	false	Nama lengkap pada dokumen identitas penandatangan, panjang maksimal 100 karakter
		emailAuth		object	false	Verifikasi OTP email, wajib diisi saat authModes=emailAuth
			authEmail	string	false	Alamat email verifikasi identitas penandatangan
		digitalId		array	false	Verifikasi identitas elektronik, wajib diisi saat authModes=digitalId
			authApp	string	false	Aplikasi yang digunakan untuk verifikasi identitas elektronik singpass-Menggunakan Singpass untuk autentikasi identitas iamsmart-Menggunakan iAM Smart untuk autentikasi identitas
			idNumber	string	false	Nomor dokumen identitas penandatangan yang akan diverifikasi
		whatsappAuth		object	false	Validasi OTP WhatsApp, wajib diisi saat authModes=whatsappAuth
			countryCode	string	false	Kode internasional negara/wilayah, tidak perlu memasukkan "+"
			number	string	false	Tidak ada validasi format, hanya membatasi panjang maksimal 13 karakter
	participantInfos			object	false	Pihak peserta perorangan
		userEmail		string	false	Email penandatangan
		phoneNumber		object	false	Nomor telepon, kosong secara default Parameter wajib jika diperlukan notifikasi SMS, countryCode dan number harus disertakan
			countryCode	string	false	Kode internasional negara/wilayah, tidak perlu memasukkan "+"
			number	string	false	Tidak ada validasi format, hanya membatasi panjang maksimal 13 karakter
		userName		string	false	Nama pribadi
		deliveryMethod		string	false	Metode notifikasi none-Tidak mengirim notifikasi pesan email-Mengirim notifikasi melalui email sms-Mengirim notifikasi melalui SMS WhatsApp-Mengirim notifikasi WhatsApp
		customizeSettings		object	false	Konfigurasi Kustom
			customizeMessage	object	false	Konfigurasi Kustom Notifikasi
			notificationLanguage	string	false	Bahasa notifikasi, default bahasa Inggris en-US Bahasa Inggris zh-CN Bahasa Mandarin Sederhana zh-Hant Bahasa Mandarin Tradisional ja Bahasa Jepang ES-MX Bahasa Spanyol
copiers				array	false	Tambahkan CC
	copierId			string	true	ID Pihak Terkait
	CCInfos			object	false	Informasi CC
		userEmail		string	false	Email
		userName		string	false	Nama Pribadi
		customizeSettings		object	false	Konfigurasi Kustom
			customizeMessage	object	false	Konfigurasi Kustom Notifikasi
			notificationLanguage	string	false	Bahasa notifikasi, default bahasa Inggris en-US Bahasa Inggris zh-CN Bahasa Mandarin Sederhana zh-Hant Bahasa Mandarin Tradisional ja Bahasa Jepang ES-MX Bahasa Spanyol
attchments				array	false	Informasi lampiran (file tanpa tanda tangan)
	documentId			string	false	ID file lampiran
	fileName			string	false	Nama file lampiran
components				array	false	Daftar kontrol
	documentId			string	false	ID file tempat kontrol berada
	componentId			string	false	ID kontrol
	componentKey			string	false	Kunci kontrol, (pilih salah satu antara ID kontrol dan kunci kontrol)
	componentValue			string	false	Nilai pengisian kontrol
	editComponentValue			boolean	false	Mengatur apakah penandatangan dapat mengubah konten pra-isi untuk kontrol ini, default true true-Penandatangan dapat mengubah nilai pra-isian false-Terkunci sebagai hanya baca jika terdapat nilai pra-isian, penandatangan tidak dapat mengubahnya

Contoh permintaan

{
  "envelopeTemplateId": "dc4be9641a3145b****9018d7a9180",
  "envelopeConfig": {
    "envelopeSubject": "*****"
  },
  "participants": [
    {
      "participantId": "42750b92c7a34******34dd5342",
      "participantInfos": {
        "userEmail": "***",
        "userName": "Preset Signer"
      }
    }
  ],
  "copiers": [],
  "attachments": [],
  "components": [
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142***2c3b02c3b5c663aa146",
      "componentId": "30c616512991***d68ab930210c",
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c74***2c3b5c663aa146",
      "componentId": "a130c54c1472444f***6c6e83a2f540"
    },
    {
      "componentValue": "123.4444",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "42b76dfbf15e4cf1***a409159c35"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c7***3b02c3b5c663aa146",
      "componentId": "556b60f7bd32442***3bbec8c54"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "7929410bb8754***497d6df30cb2"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c3***c663aa146",
      "componentId": "9e92a77b50b24cd***f6ade4b7d9"
    },
    {
      "componentValue": "123",
      "documentId": "d559142672c7402c3***b5c663aa146",
      "componentId": "9600135a35fb4ff***4ce42b6af"
    },
    {
      "componentValue": "0,1",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "d41cea8f288e***4c18c0289a"
    },
    {
      "componentValue": "1",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "9edab2c19***08b3c2dcc2d1a78171"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c74***c3b5c663aa146",
      "componentId": "4a6136cd81c54***01c113fcd30"
    },
    {
      "componentValue": "***",
      "documentId": "d559142672c7***02c3b5c663aa146",
      "componentId": "73d836894fb34***fb90fcd813"
    },
    {
      "componentValue": "***",
      "documentId": "d5591426***b02c3b5c663aa146",
      "componentId": "4e22fe4be9314a8***81d5354b51da4"
    }
  ]
}

Parameter respons

Nama parameter	Tipe	Keterangan
envelopeId	string	ID amplop

Contoh respons

{
  "code": "0",
  "data": {
    "envelopeId": "4e2eb9cc95044a7****a9a81f76397"
  },
  "message": "SUCCESS"
}