Создание конверта

POST /esignglobal/v1/envelope/create

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

Создание конверта в статусе черновика.

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

Имя параметра		Тип	Обязательный	Описание
subject		string	true	Тема конверта, пример: «Offer Letter»
remark		string	false	Примечание к конверту, ограничение длины — 1000 символов
signerSettings		object	false	Действия, разрешенные подписантам
	allowTransfer	boolean	false	Разрешить ли подписантам передавать этот конверт другим лицам для подписания, по умолчанию false true- Разрешить подписантам в конверте право передачи конверта другим лицам; false- Запретить подписантам в конверте право передачи конверта другим лицам;
	allowModifyName	boolean	false	Разрешить ли сторонам подписания изменять имя, действует только для шаблонов подписи, по умолчанию false true- Разрешить подписантам изменять имя false-Подписант не может изменять имя
tspScope		array	false	Диапазон TSP на уровне конверта, по умолчанию false. После указания при добавлении подписанта необходимо выбрать TSP, который будет использоваться подписантом, из указанного диапазона. Перечисляемые значения включают: 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。
expireAfterSeconds		long	false	Время истечения срока действия конверта: через сколько секунд конверт истекает Диапазон истечения: от 86 400 секунд (1 день) до 7 776 000 секунд (90 дней).
redirectUrl		string	false	Адрес перенаправления после завершения подписания (длина 2048), должен быть действительным http-адресом
callBackUrl		string	false	Адрес обратного вызова (длина 500), должен соответствовать адресу протокола https/http

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

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

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

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

Тип

Описание

envelopeId

string

ID конверта

envelopeStatus

int

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

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

1-Подписание

2-Завершено

3-Просрочено

5-Отменено

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

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}