Nama Parameter | Tipe | Wajib | Keterangan |
subject | string | true | Subjek Amplop Contoh: "Surat Penawaran" |
remark | string | false | Catatan amplop, batas panjang 1000 karakter |
signerSettings | object | false | Operasi yang diperbolehkan bagi penandatangan |
| | allowTransfer | boolean | false | Apakah penandatangan diperbolehkan untuk menyerahkan amplop ini kepada orang lain untuk ditandatangani, default false true - mengizinkan penandatangan dalam amplop memiliki hak untuk menyerahkan amplop kepada pihak lain; false - tidak mengizinkan penandatangan dalam amplop memiliki hak untuk menyerahkan amplop kepada pihak lain; |
| | allowModifyName | boolean | false | Apakah penandatangan diperbolehkan mengubah nama, hanya berlaku untuk tanda tangan template, default false true - mengizinkan penandatangan mengubah nama false - tidak mengizinkan penandatangan mengubah nama |
expireAfterSeconds | long | false | Waktu kedaluwarsa amplop, setelah berapa detik amplop akan kedaluwarsa Rentang kedaluwarsa: 86.400 detik (1 hari) ~ 7.776.000 detik (90 hari) |
redirectUrl | string | false | Harus berupa alamat https yang valid |
callBackUrl | string | false | Alamat callback (panjang 500), harus sesuai dengan alamat protokol https. |
sendLaterAfterSeconds | long | false | Mendukung penundaan pengiriman oleh pengguna, dalam satuan detik Rentang waktu yang didukung: 3.600 detik (1 jam) ~ 259.200 detik (30 hari) |
autoFinish | boolean | false | Mengontrol apakah amplop berakhir secara otomatis, default true true- Amplop berakhir secara otomatis false- Amplop berakhir secara manual |
CCInfos | array | false | Kumpulan informasi penerima salinan |
| userEmail | string | false | Alamat email penerima salinan |
| userName | string | false | Nama penerima salinan, digunakan untuk menampilkan nama penerima salinan di halaman penandatanganan dan amplop. [Perhatian]: Tidak boleh mengandung 9 karakter khusus berikut: / \ : * " < > | ? serta semua emoji |
| ccOrder | int | false | Posisi urutan penerima salinan dalam alur penandatanganan, berbagi urutan yang sama dengan signOrder penandatangan. Jika tidak dikirim, akan mengikuti logika notifikasi salinan yang sudah ada sebelumnya. |
| | customizeSettings | object | false | Konfigurasi kustom |
| | | notificationSettings | object | false | Konfigurasi kustom untuk jenis notifikasi |
| | | | notificationLanguage | string | false | Bahasa notifikasi, secara default menggunakan 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 |
signFiles | array | true | Kumpulan informasi dokumen penandatanganan, ditampilkan sesuai urutan penambahan dokumen. |
| fileKey | string | true | fileKey dokumen penandatanganan, hanya mendukung format PDF |
| | documentFields | array | false | Daftar kontrol dimensi dokumen. Digunakan untuk menambahkan kontrol dimensi dokumen pada file tertentu tanpa mengaitkan dengan penandatangan. |
| | fieldType | string | false | Tipe kontrol. Gunakan eMeterai untuk menunjukkan kontrol bea meterai Indonesia. |
| | pageNo | string | false | Nomor halaman tempat kontrol berada. Kontrol bea meterai Indonesia hanya mendukung satu halaman tertentu; harus memasukkan nomor halaman tunggal, tidak mendukung format multi-halaman berurutan atau tidak berurutan seperti 1-3, 1,3, dll. |
| | | posX | float | false | Offset sumbu x, titik asal koordinat adalah sudut kiri bawah halaman. Rentang koordinat sama dengan rentang koordinat kontrol lainnya. |
| | | posY | float | false | Offset sumbu Y, dengan titik asal koordinat di sudut kiri bawah halaman. Rentang koordinat konsisten dengan rentang koordinat kontrol lainnya. |
attachments | array | false | Kumpulan lampiran amplop, urutan tampilan sesuai dengan urutan penambahan file. |
| fileKey | string | false | fileKey file |
signerInfos | array | true | Kumpulan informasi penandatangan |
| businessId | string | false | Nomor bisnis kustom pengembang, batas panjang 500 |
| | roleTypes | array | false | Metode operasi penandatangan, nilai default adalah ["sign", "fill"] fill-isian sign-tanda tangan |
| | deliveryMethods | string | false | Metode notifikasi, default auto auto- Kirim notifikasi email saat userEmail diteruskan, kirim notifikasi SMS saat phoneNumber diteruskan none- Tidak mengirim notifikasi pesan email- Kirim notifikasi email sms- Kirim notifikasi SMS WhatsApp- Kirim notifikasi WhatsApp |
| userEmail | string | false | Alamat email penandatangan |
| userName | string | true | Nama penandatangan, digunakan untuk menampilkan nama penandatangan pada halaman penandatanganan dan amplop. [Catatan] Tidak boleh mengandung 9 karakter khusus berikut: / \ : * " < > | ? serta semua emoji |
| | minimumReadingDuration | int | false | Atur waktu hitung mundur wajib membaca di halaman pengaturan, nilai default adalah 0 (satuan: detik, maksimum 999) 0 atau tidak mengirimkan berarti tidak mengaktifkan, tidak perlu hitung mundur membaca |
| | readToEndRequired | boolean | false | Menunjukkan apakah harus dibaca sampai akhir. Default false; true berarti mengaktifkan, false atau tidak mengirimkan berarti tidak mengaktifkan. |
| phoneNumber | object | false | Nomor telepon, default kosong Parameter wajib saat diperlukan notifikasi SMS, countryCode dan number harus dikirimkan |
| | countryCode | string | false | Kode internasional negara/wilayah, tidak perlu mengirim tanda “+” |
| | number | string | false | Tidak ada validasi format, hanya membatasi panjang maksimal 13 digit |
| | customizeSettings | object | false | Konfigurasi kustom |
| | | notificationSettings | object | false | Konfigurasi kustom untuk notifikasi |
| | | | customizeMessage | string | false | Notifikasi pesan khusus, batas karakter 200 |
| | | | notificationLanguage | string | false | Bahasa notifikasi, default mengambil 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 |
| signOrder | int | true | Urutan penandatanganan oleh penandatangan, nilai minimum adalah 1. Penandatanganan tanpa urutan dapat menetapkan nilai urutan yang sama. |
| signTaskSuspend | boolean | false | Apakah akan mengatur node hambatan alur kerja sebelum posisi penandatanganan ini, default false. true - atur node hambatan; false - tidak atur node hambatan. Konfigurasi hambatan dalam grup penandatanganan paralel dengan signOrder yang sama harus konsisten. |
| suspensionKey | string | false | Identitas node hambatan, maksimal 500 karakter, unik dalam satu amplop. Wajib diisi ketika signTaskSuspend=true; tidak boleh diisi ketika signTaskSuspend=false atau tidak dikirimkan. |
| suspendReason | string | false | Alasan hambatan, tidak boleh kosong saat dikirimkan, maksimal 50 karakter. Hanya dapat dikirimkan ketika signTaskSuspend=true; jika tidak dikirimkan, secara default menunjukkan perlunya menunggu pemrosesan dari sistem eksternal. Tidak boleh diisi ketika signTaskSuspend=false atau tidak dikirimkan. |
| anySigner | boolean | false | Apakah mendukung penandatanganan oleh siapa saja, default false true- Hanya perlu satu orang dari signOrder yang sama untuk menandatangani false- Semua orang dari signOrder yang sama harus menandatangani |
| authModes | string | false | Metode verifikasi, default noAuth noAuth- Tidak memverifikasi accessCode- Verifikasi menggunakan kata sandi penandatanganan sms- Verifikasi OTP SMS idVerification- Verifikasi identitas dokumen resmi 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 saat authModes=accessCode |
| | | accessCode | string | false | Konten kata sandi, tidak membedakan huruf besar/kecil, dapat mengandung huruf dan angka, batas panjang 45 karakter |
| | | | promptInfo | string | false | Pesan panduan akses kata sandi, tidak boleh memuat kata sandi akses, batas panjang 30 karakter, wajib diisi saat authModes=accessCode. |
| | sms | object | false | Verifikasi OTP SMS, wajib diisi saat authModes=sms |
| | | countryCode | string | false | Kode internasional negara/wilayah, tidak perlu menyertakan tanda “+” |
| | | number | string | false | Tidak ada validasi format, hanya dibatasi panjang maksimal 13 digit |
| | idVerification | object | false | Pengaturan verifikasi dokumen identitas, wajib diisi saat authModes=idVerification |
| | | name | string | false | Nama lengkap sesuai 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-Gunakan Singpass untuk autentikasi identitas iamsmart-Gunakan i AM Smart untuk autentikasi identitas |
| | | idNumber | string | false | Nomor dokumen identitas penandatangan yang akan diverifikasi Saat authApp=singpassaturan inputnya adalah: huruf kapital + 7 atau 8 digit angka + huruf kapital Saat authApp=iamsmartaturan inputnya adalah: 1. Satu huruf kapital (A-Z), atau dua huruf kapital (AA-ZZ), sebagai awal urutan; 2. Diikuti oleh 6 digit angka; 3. Terakhir adalah kode pemeriksaan, bisa berupa angka (0-9) atau huruf (A-Z). Contoh: A888888(A) |
| | whatsappAuth | object | false | Verifikasi OTP WhatsApp, wajib diisi saat authModes=whatsappAuth |
| | | countryCode | string | false | Kode internasional negara/wilayah, tidak perlu memasukkan "+" |
| | | number | string | false | Tidak melakukan validasi format, hanya membatasi panjang maksimal 13 digit |
| digitalSignature | boolean | false | Apakah mengaktifkan tanda tangan digital, default false true-Aktif, false-Tidak aktif |
| tsp | string | false | Pilih TSP yang digunakan oleh penandatangan, default false. Jika tidak diatur, penandatangan dapat memilih sendiri TSP yang diperlukan. Enum termasuk: vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha |
| freeFormSign | boolean | false | Apakah penandatangan bebas menggunakan cap/tanda tangan, nilai default false Keterangan tambahan: Ketika freeFormSign ditetapkan true, parameter lain di bawah sealInfos tidak perlu dimasukkan. Jika keduanya dimasukkan, prioritas freeFormSign lebih tinggi daripada sealInfos, dan parameter di bawah sealInfos tidak akan berlaku [Perhatian]Cap/tanda tangan bebas berarti tidak membatasi jumlah dan posisi cap/tanda tangan yang dapat diseret oleh penandatangan |
| documentVisibility | object | false | Konfigurasi visibilitas dokumen, default semua terlihat. |
| | documentViewType | string | false | Strategi visibilitas, default all; all menunjukkan bahwa semua dokumen penandatanganan dalam amplop dapat dilihat, limited menunjukkan bahwa hanya dokumen penandatanganan pribadi dan dokumen tambahan yang dapat dilihat. |
| | viewableFileKeys | array | false | Daftar fileKey tambahan yang diizinkan untuk dilihat oleh pihak penandatangan; hanya boleh dimasukkan dan berlaku ketika documentViewType=limited. |
| sealInfos | array | false | Informasi tugas penandatanganan |
| | fileKey | string | true | fileKey dokumen penandatanganan |
| | signConfigs | array | false | Informasi posisi kontrol, informasi posisi kontrol harus ditentukan untuk melakukan tanda tangan elektronik. |
| | | fieldType | string | false | Tipe kontrol, defaultnya adalah signature signature-Kontrol tanda tangan stamp-Kontrol stempel approval-Kontrol persetujuan |
| | | | required | boolean | false | Apakah wajib diisi, defaultnya wajib diisi true-Wajib diisi false-Tidak wajib diisi |
| | | | signFieldStyle | string | false | Metode penempatan stempel pada kontrol tanda tangan, defaultnya adalah normalSeal. normalSeal-Stempel biasa pagingSeal-Stempel sambung halaman Hanya kontrol tanda tangan dan kontrol stempel yang mendukung pengaturan stempel sambung halaman. |
| | | | pagingSealMode | string | false | Rentang jumlah halaman untuk stempel sambung halaman, defaultnya adalah all. all-Semua nomor halaman assignedPages-Nomor halaman tertentu even-Halaman genap odd-Halaman ganjil Hanya dapat ditentukan ketika signFieldStyle=pagingSeal. |
| | | | sizeRule | string | false | Tampilan ukuran area penandatanganan originalSize-Tempelkan cap sesuai ukuran asli tanda tangan/stempel targetSize-Kustomisasi lebar dan tinggi area tanda tangan/stempel Ketika sizeRule, height, width semuanya kosong, tempelkan cap sesuai ukuran asli tanda tangan/stempel; Ketika sizeRule kosong, tetapi height dan width tidak kosong, tempelkan cap sesuai ukuran yang ditentukan; Ketika sizeRule tidak kosong, tempelkan cap sesuai tampilan yang ditentukan; Cap sambungan tidak memerlukan parameter ini, hanya menempelkan cap sesuai ukuran asli. |
| | | height | int | false | Tinggi kontrol penandatanganan, berlaku untuk fieldType signature/stamp, satuan px, hanya menerima bilangan bulat positif, default auto (yaitu ukuran otomatis sistem); Ketika fieldType=signature, rentang pengaturan adalah 20-250px; Ketika fieldType=stamp, rentang pengaturan adalah 30-280px; Cap sambungan tidak memerlukan parameter ini. |
| | | width | int | false | Lebar kontrol penandatanganan, berlaku untuk fieldType signature/stamp, satuan px, hanya menerima bilangan bulat positif, default auto (yaitu ukuran otomatis sistem); Saat fieldType=signature, rentang yang dapat diatur adalah 20-250px; Saat fieldType=stamp, rentang yang dapat diatur adalah 30-280px; Cap stempel tidak memerlukan parameter ini. |
| | | signatureOptions | string | false | Opsi kontrol tanda tangan. Hanya berlaku untuk fieldType signature Parameter input: template: Tanda tangan template handDrawn: Tanda tangan gambar tangan upload: Unggah gambar tanda tangan lokal aiHandDrawn: Tanda tangan tulisan tangan AI Dapat dipilih beberapa, dipisahkan dengan ",", default semua terpilih |
| | | movable | boolean | false | Memungkinkan pemindahan posisi saat penandatanganan, default false false-Tidak memungkinkan penandatangan menyesuaikan posisi kontrol tanda tangannya sendiri true-Memungkinkan penandatangan menyesuaikan posisi kontrol tanda tangannya sendiri |
| | | allowedOptions | array | false | Opsi yang memungkinkan penandatangan menyetujui, berlaku untuk fieldType approval. Defaultnya adalah ["approve", "decline"] approve-Setuju decline-Ditolak |
| | | pageNo | string | false | Nomor halaman tanda tangan; halaman yang berurutan dihubungkan dengan "-", halaman terpisah dihubungkan dengan "," Contoh: 1-3,6-10 Masukkan rentang nomor halaman tempat cap jilid ditempatkan saat pagingSealMode=assignedPages. Cap jilid hanya dapat digunakan untuk dokumen dengan lebih dari 1 halaman. |
| | | posX | float | false | Koordinat sumbu-x [Perhatian] Jika fieldType adalah signature, posisi koordinat merujuk pada area tanda tanganKiri bawah; Jika fieldType adalah stamp, posisi koordinat merujuk pada area capTitik tengahPosisi Mulai 3 Februari 2026, jika fieldType adalah signature atau stamp, posisi koordinatnya merujuk pada titik tengah area cap. Nilai untuk cap jilid dapat berupa 0, tidak boleh null; kontrol akan tetap menempel di tepi kanan dokumen. |
| | | posY | float | false | Koordinat sumbu-y [Perhatian] Jika fieldType adalah signature, posisi koordinat merujuk pada area tanda tanganKiri bawah; Jika fieldType adalah stamp, posisi koordinat merujuk pada area cap.Titik tengahPosisi Mulai dari 3 Februari 2026, jika fieldType adalah signature atau stamp, posisi koordinatnya merujuk pada titik tengah area cap. |
| | fillConfigs | array | false | Isi informasi kontrol |
| | | fieldName | string | false | Nama kontrol, batas jumlah karakter 128 |
| | | required | boolean | false | Wajib diisi, default wajib diisi true-wajib diisi false-tidak wajib diisi |
| | | fieldType | string | false | Tipe kontrol: 1-teks satu baris 15-kotak centang |
| | | textField | object | false | Atribut kontrol teks |
| | | | overflowType | int | false | Hanya berlaku untuk text, default 1 1-ukuran font otomatis mengecil 2-Membatasi input |
| | | | minFontSize | float | false | Hanya berlaku untuk text, hanya berlaku saat overflowType=1, default 8 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72 |
| | | | width | int | false | Lebar kontrol, default 160px |
| | | | font | int | false | Hanya berlaku untuk text, font, default SimSun 1-SimSun 2-Xin SimSun 4-HeiTi 5-KaiTi 6-Arial 7-Helvetica 9-Times New Roman 10-FangSong 11-Georgia 12-Monospace |
| | | | fontSize | float | false | Hanya berlaku untuk text, ukuran font, default 12 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72 |
| | | | textColor | string | false | Hanya berlaku untuk text, warna heksadesimal, default hitam #000 |
| | | | bold | boolean | false | Hanya berlaku untuk text, apakah font tebal, default false true-Tebal false-Tidak tebal |
| | | | italic | boolean | false | Hanya berlaku untuk text, apakah miring, default false true-italic false-non-italic |
| | | | underline | boolean | false | Hanya berlaku untuk text, apakah font diberi garis bawah, default false true-menambahkan garis bawah false-tidak menambahkan garis bawah |
| | | | lineThrough | boolean | false | Hanya berlaku untuk text, apakah diberi coretan, default false true-menambahkan coretan false-tidak menambahkan coretan |
| | | | horizontalAlignment | string | false | Hanya berlaku untuk text, format rata tengah horizontal, default left LEFT-rata kiri CENTER-rata tengah RIGHT-rata kanan |
| | | tickBoxField | object | false | Atribut kotak centang |
| | | | tickOptions | array | false | Hanya berlaku untuk tickBox, default 1 1-centang 2-akar |
| | | posX | float | false | Koordinat X posisi kontrol |
| | | posY | float | false | Koordinat Y posisi kontrol |
| | | pageNo | string | false | Nomor halaman tempat kontrol berada |
| | signDateConfigs | array | false | Informasi posisi tanggal penandatanganan |
| | | movable | boolean | false | Memungkinkan untuk memindahkan posisi saat menandatangani, default false false-Tidak memungkinkan penandatangan menyesuaikan posisi kontrol penandatangan mereka sendiri true-Memungkinkan penandatangan menyesuaikan posisi kontrol penandatangan mereka sendiri |
| | | pageNo | string | false | Nomor halaman penandatanganan; halaman berurutan dihubungkan dengan "-", halaman terpisah dihubungkan dengan ",", contoh: 1-3, 6-10; Jika tidak berurutan, gunakan "," sebagai pemisah. |
| | | posX | float | false | Offset sumbu x, titik asal koordinat adalah sudut kiri bawah halaman |
| | | posY | float | false | Offset sumbu y, titik asal koordinat adalah sudut kiri bawah halaman |
| | | signDateFormat | string | false | Format tanggal penandatanganan, format default adalah yyyy-MM-dd Mendukung format yang ditentukan: yyyy tahun MM bulan dd hari yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MMM dd,yyyy dd MMM yyyy |