Центр разработчиков

Завершить конверт

POST/esignglobal/v1/envelope/finish

Описание интерфейса

Завершить конверт вручную. Все подписанты в конверте должны завершить подписание до завершения конверта. После завершения процесса подписания все ресурсы не могут быть изменены.

Если платформа интеграции использует интерфейс «Быстрый запуск конверта» для создания конверта, то нет необходимости вызывать этот интерфейс, система автоматически вызовет его после завершения подписания.

Параметры запроса

Имя параметра

Тип

Обязательно

Описание

envelopeId

string

true

ID конверта

Пример запроса

{
  "envelopeId":"flow1234567890"
}

Параметры ответа

Имя параметра

Тип

Описание

envelopeId

string

ID конверта

envelopeStatus

int

Статус конверта

0 - Создан (черновик)

1 - В процессе подписания

2 - Завершен

3 - Просрочен

5 - Отозван

Пример ответа

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

 

Описание интерфейса
Параметры запроса
Пример запроса
Параметры ответа
Пример ответа