Pusat pembangun

Tamatkan Sampul Surat

POST/esignglobal/v1/envelope/finish

Deskripsi Antara Muka

Menamatkan sampul surat secara manual, semua penandatangan dalam sampul surat mesti menandatangani sebelum sampul surat ditamatkan, dan semua sumber tidak boleh diubah suai selepas proses menandatangani selesai.

Jika platform docking menggunakan antara muka "Lancarkan Sampul Surat Pantas" untuk membuat sampul surat, maka tidak perlu memanggil antara muka ini, sistem akan memanggilnya secara automatik selepas menandatangani selesai.

Parameter Permintaan

Nama Parameter

Jenis

Wajib

Keterangan

envelopeId

string

true

ID Sampul Surat

Contoh Permintaan

{
  "envelopeId":"flow1234567890"
}

Parameter Respons

Nama Parameter

Jenis

Keterangan

envelopeId

string

ID Sampul Surat

envelopeStatus

int

Status Sampul Surat

0-Dicipta (Draf)

1-Dalam Proses Menandatangani

2-Selesai

3-Telah Tamat Tempoh

5-Dibatalkan

Contoh Respons

{
  "code": "0",
    "data": {
    "envelopeId": "xxxx",
      "envelopeStatus": 2
  },
  "message": "success"
}

 

Deskripsi Antara Muka
Parameter Permintaan
Contoh Permintaan
Parameter Respons
Contoh Respons