eSign.AIeSign.AI
Pusat Pengembang

Tambahkan file tanda tangan

POST /esignglobal/v1/envelope/files/addSignFiles

Deskripsi Antarmuka

Saat amplop belum dibuka, Anda dapat menambahkan dokumen yang perlu ditandatangani ke dalam amplop. Amplop yang sudah dibuka tidak mendukung penambahan dokumen untuk penandatanganan.

Parameter Permintaan

Nama Parameter

Tipe

Wajib

Keterangan

envelopeId

string

true

ID Amplop

signFiles

array

true

Kumpulan informasi dokumen penandatanganan, urutan tampilannya sesuai dengan urutan penambahan dokumen.

 

fileKey

string

true

fileKey dokumen penandatanganan, hanya mendukung format PDF

 documentFieldsarrayfalseDaftar kontrol dimensi file. Digunakan untuk menambahkan kontrol dimensi file pada file tertentu tanpa mengikat 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; masukkan nomor halaman tunggal saja, tidak mendukung format beberapa halaman berurutan atau tidak berurutan seperti 1-3 atau 1,3.

  posXfloatfalseOffset sumbu x, titik asal koordinat adalah sudut kiri bawah halaman. Rentang koordinat sama dengan rentang koordinat kontrol lainnya.
  posYfloatfalseOffset sumbu y, titik asal koordinat adalah sudut kiri bawah halaman. Rentang koordinat sama dengan rentang koordinat kontrol lainnya.

Contoh Permintaan

{   
  "envelopeId": "9fbe6c8190824227bde29136b0145c81",
  "signFiles": [
  {
    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
  }
]
}

Parameter Respons

Nama Parameter

Tipe

Keterangan

code

int

Kode bisnis, 0 menunjukkan sukses, bukan 0 menunjukkan anomali.

message

string

Informasi Bisnis

【Perhatian】 Silakan tentukan kondisi kesalahan berdasarkan code, jangan mengandalkan pencocokan message karena message mungkin akan disesuaikan.

data

object

Data Bisnis

Contoh Respons

{
    "code": "0",
    "message": "success",
    "data": null
}