Инициация подписания с использованием шаблона конверта

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

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

Для инициирования подписания используйте «шаблон конверта», предварительно настроенный на стороне страницы.

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

Имя параметра				Тип	Обязательный	Описание
envelopeTemplateId				string	true	ID шаблона конверта
envelopeConfig				object	true	Настройка процесса подписания
	contractConfig			boolean	false	Настройка подписания договора
		envelopeRemark		array	false	Примечание к договору
	envelopeSubject			string	true	Тема текущего процесса подписания
	expireAfterSeconds			int	false	Срок окончания подписания для данного процесса. Подписание становится невозможным после истечения этого срока. Задается в миллисекундах по Unix-времени. По умолчанию и максимальный срок действия — 90 дней.
	callbackUrl			string	false	Веб-адрес для приема callback-уведомлений
	redirectUrl			string	false	Должен быть корректным HTTPS-адресом
	signConfig			object	false	Параметры подписания
		allowTransfer		boolean	false	Разрешить ли подписанту передать данный конверт другому лицу для подписания, по умолчанию false true — разрешает подписанту в данном конверте передавать его другим лицам; false — не разрешает подписанту в данном конверте передавать его другим лицам;
participants				array	false	Настройки участников
	participantId			string	true	Идентификатор участника
	authConfig			object	false	Параметры аутентификации
		willingnessAuthModes		array	false	Способ подтверждения намерения для подписанта, по умолчанию noAuth noAuth — без проверки accessCode — проверка с помощью пароля для подписания sms — проверка по SMS OTP idVerification — проверка удостоверения личности emailAuth — проверка по OTP на электронную почту digitalId — проверка цифровой идентичности whatsappAuth — проверка OTP через WhatsApp
		accessCode		object	false	Настройки пароля для подписания, обязательно при authModes=accessCode
			accessCode	string	false	Содержимое пароля, регистр не учитывается, может содержать буквы и цифры, ограничение длины — 45
			promptInfo	string	false	Подсказка для пароля доступа, не должна содержать сам пароль, ограничение длины — 30, обязательно при authModes=1.
		sms		object	false	Проверка SMS OTP, обязательно при authModes=sms
			countryCode	string	false	Международный код страны/региона, символ "+" передавать не требуется
			number	string	false	Проверка формата не выполняется, ограничение максимальной длины — 13 символов
		idVerification		object	false	Настройки проверки удостоверения личности, обязательно при authModes=idVerification
			name	string	false	Полное имя на удостоверении личности подписанта, максимальная длина — 100 символов
		emailAuth		object	false	Проверка OTP по электронной почте, обязательно при authModes=emailAuth
			authEmail	string	false	Адрес электронной почты подписанта для проверки личности
		digitalId		array	false	Электронная проверка личности, обязательно при authModes=digitalId
			authApp	string	false	Приложение, используемое для электронной проверки личности singpass-аутентификация личности с помощью Singpass iamsmart-аутентификация личности с помощью IAM Smart
			idNumber	string	false	Номер удостоверения личности подписанта, подлежащий проверке
		whatsappAuth		object	false	Проверка OTP WhatsApp, обязательно при authModes=whatsappAuth
			countryCode	string	false	Международный код страны или региона, знак «+» указывать не нужно
			number	string	false	Проверка формата не выполняется, максимальная длина — 13 символов
	participantInfos			object	false	Физическое лицо
		userEmail		string	false	Электронная почта подписанта
		phoneNumber		object	false	Номер телефона, по умолчанию пустое значение Обязательный параметр при необходимости отправки SMS-уведомления, необходимо передать countryCode и number
			countryCode	string	false	Международный код страны или региона, знак «+» указывать не нужно
			number	string	false	Проверка формата не выполняется, максимальная длина — 13 символов
		userName		string	false	Имя физического лица
		deliveryMethod		string	false	Способ уведомления none-не отправлять уведомления email-отправлять уведомления по электронной почте sms-отправлять SMS-уведомления WhatsApp-отправлять уведомления через WhatsApp
		customizeSettings		object	false	Пользовательская конфигурация
			customizeMessage	object	false	Пользовательская конфигурация уведомлений
			notificationLanguage	string	false	Язык уведомлений, по умолчанию английский en-US Английский zh-CN Упрощённый китайский zh-Hant Традиционный китайский ja Японский ES-MX Испанский
copiers				array	false	Добавить получателя копии
	copierId			string	true	Идентификатор участника
	CCInfos			object	false	Информация о получателе копии
		userEmail		string	false	Электронная почта
		userName		string	false	Личное имя
		customizeSettings		object	false	Пользовательская конфигурация
			customizeMessage	object	false	Пользовательская конфигурация уведомлений
			notificationLanguage	string	false	Язык уведомлений, по умолчанию английский en-US Английский zh-CN Упрощенный китайский zh-Hant Традиционный китайский ja Японский ES-MX Испанский
attchments				array	false	Информация о добавляемом вложении (файле, не требующем подписи)
	documentId			string	false	Идентификатор файла вложения
	fileName			string	false	Название файла вложения
components				array	false	Список элементов управления
	documentId			string	false	Идентификатор файла, содержащего элемент управления
	componentId			string	false	Идентификатор элемента управления
	componentKey			string	false	Ключ элемента управления (выберите один параметр: идентификатор или ключ)
	componentValue			string	false	Значение предзаполнения элемента управления
	editComponentValue			boolean	false	Разрешает подписанту изменять предзаполненное содержимое элемента управления. По умолчанию true true — подписант может изменять предзаполненные значения false — при наличии предзаполненных значений они фиксируются в режиме только для чтения, подписант не может их изменять

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

{
  "envelopeTemplateId": "dc4be9641a3145b****9018d7a9180",
  "envelopeConfig": {
    "envelopeSubject": "*****"
  },
  "participants": [
    {
      "participantId": "42750b92c7a34******34dd5342",
      "participantInfos": {
        "userEmail": "***",
        "userName": "Preset Signer"
      }
    }
  ],
  "copiers": [],
  "attachments": [],
  "components": [
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142***2c3b02c3b5c663aa146",
      "componentId": "30c616512991***d68ab930210c",
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c74***2c3b5c663aa146",
      "componentId": "a130c54c1472444f***6c6e83a2f540"
    },
    {
      "componentValue": "123.4444",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "42b76dfbf15e4cf1***a409159c35"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c7***3b02c3b5c663aa146",
      "componentId": "556b60f7bd32442***3bbec8c54"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "7929410bb8754***497d6df30cb2"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c3***c663aa146",
      "componentId": "9e92a77b50b24cd***f6ade4b7d9"
    },
    {
      "componentValue": "123",
      "documentId": "d559142672c7402c3***b5c663aa146",
      "componentId": "9600135a35fb4ff***4ce42b6af"
    },
    {
      "componentValue": "0,1",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "d41cea8f288e***4c18c0289a"
    },
    {
      "componentValue": "1",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "9edab2c19***08b3c2dcc2d1a78171"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c74***c3b5c663aa146",
      "componentId": "4a6136cd81c54***01c113fcd30"
    },
    {
      "componentValue": "***",
      "documentId": "d559142672c7***02c3b5c663aa146",
      "componentId": "73d836894fb34***fb90fcd813"
    },
    {
      "componentValue": "***",
      "documentId": "d5591426***b02c3b5c663aa146",
      "componentId": "4e22fe4be9314a8***81d5354b51da4"
    }
  ]
}

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

Имя параметра	Тип	Описание
envelopeId	string	ID конверта

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

{
  "code": "0",
  "data": {
    "envelopeId": "4e2eb9cc95044a7****a9a81f76397"
  },
  "message": "SUCCESS"
}