Проверено

Соединитель для проверенного API для включения создания процессов подписывания пользовательских документов.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Проверено
URL	https://verified.eu/en/#about-us
Адрес электронной почты	support@verified.eu

Метаданные соединителя
Publisher	Crm - Konsulterna i Sverige AB
Веб-сайт	https://verified.eu/
Политика конфиденциальности	https://verified.eu/trust-center
Категории	Содержимое и файлы; Продуктивность

Проверено, что программное обеспечение является поставщиком услуг электронной идентификации и цифровой подписи. Этот соединитель позволяет интегрироваться с API проверенных и интуитивно понятных процессов подписывания в приложении.

Предпосылки

Для продолжения вам потребуется следующее:

• Регистрация для проверенной учетной записи

Получение учетных данных

Этот соединитель использует обычную проверку подлинности. Пользователь должен представить имя пользователя, пароль и идентификатор компании при создании подключения. Имя пользователя и пароль одинаковы для входа на проверенный портал. Чтобы получить идентификатор компании, который необходимо войти на проверенный портал, выберите правильную компанию, если у вас несколько и скопируйте идентификатор компании из URL-адреса.

Начало работы

Распространенным вариантом использования является запуск процесса подписывания и управление им, т. е. настройка автоматизации для отправки документов, которые должны быть подписаны в Verified и получать подписанные документы на регулярной основе. Распространенные действия, которые используются для запуска проверенного процесса подписывания, включают создание конверта — дескриптор или создание конверта — по умолчанию, добавление документа в конверт, добавление файла в документ, добавление получателя в конверт и обновление состояния публикации для конверта. Распространенные действия, используемые для проверки состояния проверенных документов, включают получение конверта по идентификатору, Получение всех документов по идентификатору конверта, Получение файлов по идентификатору документа, URL-адрес файла по идентификатору. Обратите внимание, что действие "Создание маркера безопасности" всегда используется в качестве первого шага для получения маркера безопасности, который будет использоваться в следующих шагах.

Известные проблемы и ограничения

В настоящее время известны следующие ограничения.

• В начале каждого потока необходимо создать маркер проверки подлинности для повторного использования на каждом следующем шаге.
• Чтобы добавить документ, необходимо отправить HTTP-запрос на определенный URL-адрес.
• Чтобы использовать новую конечную точку поиска, ее необходимо активировать для учетной записи с помощью проверенной suppoert.

Часто задаваемые вопросы

Как отправить документ в Проверено?

Чтобы отправить фактический документ, необходимо создать файл в проверенном API и отправить хэш документа в URL-адрес БОЛЬШОго двоичного объекта, ответив от проверенного API.

Как получить удержание конверта после использования действия "Получить идентификатор конверта"?

Действия, которые создают конверт, отвечают пользовательскому интерфейсу, который представляет собой полный путь к конверту (например, "/конверты/ABCDE"). Для других шагов требуется только последняя часть пользовательского интерфейса (которая является фактическим идентификатором конверта, в нашем примере "ABCDE").

Ниже приведен пример того, как это сделать

substring(outputs('Create_new_default_envelope')?['body/uid'],11)

Как получить удержание идентификатора документа после использования действия "Добавить документ в конверт"?

Действия, которые создают документ, отвечают на расположение нового документа в заголовке. Расположение — это полный путь к документу (например, "/api/конверты/ABCDE/documents/FGHIJ"). Для выполнения следующих действий требуется только идентификатор документа (в нашем случае: FGHIJ).

Ниже приведен пример того, как это сделать

substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))

Как получить удержание идентификатора потока из конверта?

При загрузке сведений о конверте связанный поток будет частью ответа (например, "/flow/default"). В ответе он называется идентификатором потока, однако он нуждается только в последней части, когда другой шаг (например, состояние потока get) запрашивает идентификатор потока.

Ниже приведен пример того, как это сделать

substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)

Как использовать новое действие поиска?

Чтобы использовать новое действие поиска, необходимо активировать конечную точку поиска для проверенной организации. Для этого необходимо написать сообщение электронной почты в проверенную службу поддержки, включая идентификатор организации, чтобы они могли активировать конечную точку для вас.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

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

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
username	securestring	Имя пользователя для этого API	True
пароль	securestring	Пароль для этого API	True
Идентификатор компании	струна	Идентификатор компании предоставляется проверенным. Можно найти в URL-адресе, выполнив вход в app.verified.eu	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Добавление документа в конверт	Добавляет новый документ в существующий конверт.
Добавление получателя в конверт	Добавляет получателя в заданный конверт.
Добавление файла в документ	Добавляет файл в существующий документ.
Запрос всех конвертов (не рекомендуется)	Запрашивает все конверты, соответствующие заданному фильтру. (Устарело)
Настройка состояния корзины конверта	Задает состояние заданного конверта в корзину.
Настройка состояния прерывания документа	Задает состояние заданного документа прерванным.
Настройка состояния прерывания конверта	Задает состояние заданного конверта прерванным.
Обновление параметров конверта	Обновляет параметры заданного конверта.
Обновление получателя по идентификатору	Обновляет получателя.
Обновление состояния публикации для конверта	Обновляет состояние публикации заданного конверта.
Отправка уведомления	Отправляет уведомление получателю заданного конверта.
Поиск всех конвертов	Выполните поиск всех конвертов, соответствующих заданному фильтру.
Получение URL-адреса файла по идентификатору	Возвращает URL-адрес заданного файла.
Получение всех дескрипторов	Возвращает список всех дескрипторов, присутствующих в текущей компании. Список можно отфильтровать.
Получение всех документов по идентификатору конверта	Возвращает все документы, связанные с заданным конвертом.
Получение всех получателей конверта	Возвращает всех получателей заданного конверта.
Получение дескриптора по идентификатору	Возвращает сведения о заданном дескрипторе.
Получение дескриптора по умолчанию	Возвращает дескриптор по умолчанию для конвертов.
Получение документа по идентификатору	Возвращает сведения о заданном документе.
Получение компании по идентификатору	Получает сведения о данной компании.
Получение конверта по идентификатору	Возвращает сведения о заданном конверте.
Получение конкретного получателя для конверта	Получает конкретного получателя для заданного конверта.
Получение параметров пользователя	Возвращает параметры заданного пользователя.
Получение сведений о пользователе	Возвращает сведения о пользователе, вошедшего в систему.
Получение состояния потока по идентификатору конверта	Возвращает текущее состояние потока заданного конверта.
Получение файла по идентификатору	Возвращает сведения о заданном файле.
Получение файлов по идентификатору документа	Возвращает все файлы, подключенные к заданному документу.
Создание документа из шаблона	Создает документ из предварительно настроенного шаблона.
Создание конверта по умолчанию	Создает новый конверт с помощью дескриптора по умолчанию.
Создание конверта — дескриптор	Создает конверт на основе определенного дескриптора.
Создание маркера безопасности	Возвращает маркер проверки подлинности из проверенного API.
Создание ссылки подписи	Создает ссылку подписи. Реализация зависит от потока и может быть отсутствует для конкретного потока.
Удаление документа по идентификатору	Удаляет указанный документ.
Удаление конверта по идентификатору	Удаляет заданный конверт.

Добавление документа в конверт

Идентификатор операции:

PostEnvelopesEnvelopeIdDocuments

Добавляет новый документ в существующий конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Hash	hash		integer
Имя	name	True	string
Исходный материал	source		string

Добавление получателя в конверт

Идентификатор операции:

PostEnvelopesEnvelopeIdRecipients

Добавляет получателя в заданный конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Имя (Первое имя)	givenName	True	string
Фамилия	familyName	True	string
Language	language	True	string
Метод подписи	signingMethod	True	string
Метод уведомления	notificationMethod		string
Электронная почта	email	True	string
Телефон	telephone		string	Формат должен иметь номер телефона +<countryCode><>
Заказ	order		integer
Действие	action	True	string	Имя проверенного действия, который должен выполнить получатель.
Этикетка	label	True	string	Метка для роли или действия получателя
Имя	name	True	string	Проверенное имя роли получателя
Secure	secure		boolean
СМС	sms		boolean
Номер социального страхования	ssn		string
Денежные средства	bank		string

Добавление файла в документ

Идентификатор операции:

PostEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Добавляет файл в существующий документ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор документа	document-id	True	string	Идентификатор документа, который в данном вопросе
Имя	name	True	string
FileType	fileType	True	string
Hash	hash		string

Возвращаемое значение

Файл

File

Запрос всех конвертов (не рекомендуется)

Идентификатор операции:

GetQueryEnvelopes

Запрашивает все конверты, соответствующие заданному фильтру. (Устарело)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Фильтры	filters		string	Фильтрация запроса для выбора вложенных элементов
От	from		integer	Дата
Лимит	limit		integer	Сумма лимита
Сортировать	sort		string	Сортировать по

Возвращаемое значение

response

array of EnvelopeDescriptorString

Настройка состояния корзины конверта

Идентификатор операции:

PutEnvelopesEnvelopeIdTrashStatus

Задает состояние заданного конверта в корзину.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Комментарий	comment		string

Настройка состояния прерывания документа

Идентификатор операции:

PostEnvelopesEnvelopeIdDocumentsDocumentIdStatusAborted

Задает состояние заданного документа прерванным.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор документа	document-id	True	string	Идентификатор документа, который в данном вопросе

Настройка состояния прерывания конверта

Идентификатор операции:

PutEnvelopesEnvelopeIdAbortStatus

Задает состояние заданного конверта прерванным.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Комментарий	comment		string

Обновление параметров конверта

Идентификатор операции:

PutEnvelopesEnvelopeId

Обновляет параметры заданного конверта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Последовательная подпись	sequentialSigning		boolean
Приветствие	greeting		string
Expiration	expiration		date	Дата в следующем формате 2017-02-26T21:59:59.999Z
Автоматические напоминания	automaticReminders		number	X Дней до истечения срока действия

Обновление получателя по идентификатору

Идентификатор операции:

PutEnvelopesEnvelopeIdRecipientsRecipientId

Обновляет получателя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор получателя	recipient-id	True	string	Идентификатор вопросов получателей
Имя (Первое имя)	givenName	True	string
Фамилия	familyName	True	string
Language	language	True	string
Метод подписи	signingMethod	True	string
Метод уведомления	notificationMethod		string
Электронная почта	email	True	string
Телефон	telephone		string	Формат должен иметь номер телефона +<countryCode><>
Заказ	order		integer
Действие	action	True	string	Имя проверенного действия, который должен выполнить получатель.
Этикетка	label	True	string	Метка для роли или действия получателя
Имя	name	True	string	Проверенное имя роли получателя
Secure	secure		boolean
СМС	sms		boolean
Номер социального страхования	ssn		string
Денежные средства	bank		string

Обновление состояния публикации для конверта

Идентификатор операции:

PutEnvelopesEnvelopeIdPublishStatus

Обновляет состояние публикации заданного конверта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Опубликовано	published	True	boolean

Отправка уведомления

Идентификатор операции:

PostEnvelopesEnvelopIdJobsSendNotification

Отправляет уведомление получателю заданного конверта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Приветствие	greeting		string
Идентификатор получателя	id	True	string	Идентификатор получателя, на который должно отправляться уведомление.

Поиск всех конвертов

Идентификатор операции:

GetSearchEnvelopes

Выполните поиск всех конвертов, соответствующих заданному фильтру.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Фильтры	filters		string	Фильтрация запроса для выбора вложенных элементов
От	from		integer	Дата
Лимит	limit		integer	Сумма лимита
Сортировать	sort		string	Сортировать по

Возвращаемое значение

response

array of EnvelopeDescriptorString

Получение URL-адреса файла по идентификатору

Идентификатор операции:

GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileIdUrl

Возвращает URL-адрес заданного файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор документа	document-id	True	string	Идентификатор документа, который в данном вопросе
Идентификатор файла	file-id	True	string	Идентификатор файла, который в этом вопросе
Как объект	asObject		boolean	Определяет, является ли ответ объектом

Возвращаемое значение

Имя	Путь	Тип	Описание
URL	url	string	URL-адрес файла

Получение всех дескрипторов

Идентификатор операции:

GetEnvelopeDescriptors

Возвращает список всех дескрипторов, присутствующих в текущей компании. Список можно отфильтровать.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Фильтры	filters		string	Фильтрация запроса для выбора вложенных элементов

Возвращаемое значение

response

array of Descriptor

Получение всех документов по идентификатору конверта

Идентификатор операции:

GetEnvelopesEnvelopeIdDocuments

Возвращает все документы, связанные с заданным конвертом.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе

Возвращаемое значение

response

array of Document

Получение всех получателей конверта

Идентификатор операции:

GetEnvelopesEnvelopeIdRecipients

Возвращает всех получателей заданного конверта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе

Возвращаемое значение

response

array of Recipient

Получение дескриптора по идентификатору

Идентификатор операции:

GetEnvelopeDescriptorsEnvelopeDescriptorId

Возвращает сведения о заданном дескрипторе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор дескриптора конверта	envelope-descriptor-id	True	string	Идентификатор дескриптора конверта

Возвращаемое значение

Дескриптор

Descriptor

Получение дескриптора по умолчанию

Идентификатор операции:

GetEnvelopeDescriptorsDefault

Возвращает дескриптор по умолчанию для конвертов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Фильтры	filters		string	Фильтрация запроса для выбора вложенных элементов

Возвращаемое значение

Дескриптор

Descriptor

Получение документа по идентификатору

Идентификатор операции:

GetEnvelopesEnvelopeIdDocumentsDocumentId

Возвращает сведения о заданном документе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор документа	document-id	True	string	Идентификатор документа, который в данном вопросе

Возвращаемое значение

Документ

Document

Получение компании по идентификатору

Идентификатор операции:

GetCompaniesCompanyId

Получает сведения о данной компании.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	company-id	True	string	Идентификатор компании, под вопросом

Возвращаемое значение

Компания

Company

Получение конверта по идентификатору

Идентификатор операции:

GetEnvelopesEnvelopeId

Возвращает сведения о заданном конверте.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе

Возвращаемое значение

Конверт

Envelope

Получение конкретного получателя для конверта

Идентификатор операции:

GetEnvelopesEnvelopeIdRecipientsRecipientId

Получает конкретного получателя для заданного конверта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор получателя	recipient-id	True	string	Идентификатор вопросов получателей

Возвращаемое значение

Recipient

Recipient

Получение параметров пользователя

Идентификатор операции:

GetCompaniesCompanyIdUsersUserIdSettings

Возвращает параметры заданного пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	company-id	True	string	Идентификатор компании, под вопросом
Идентификатор пользователя	user-id	True	string	Идентификатор пользователя в вопросе

Возвращаемое значение

Тело

Setting

Получение сведений о пользователе

Идентификатор операции:

GetAuthUserinfo

Возвращает сведения о пользователе, вошедшего в систему.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"

Возвращаемое значение

Тело

UserInfo

Получение состояния потока по идентификатору конверта

Идентификатор операции:

GetFlowsFlowIdJobsEnvelopeId

Возвращает текущее состояние потока заданного конверта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор потока	flow-id	True	string	Идентификатор потока в вопросе

Возвращаемое значение

Имя	Путь	Тип	Описание
Токен	token	string

Получение файла по идентификатору

Идентификатор операции:

GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileId

Возвращает сведения о заданном файле.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор документа	document-id	True	string	Идентификатор документа, который в данном вопросе
Идентификатор файла	file-id	True	string	Идентификатор файла, который в этом вопросе

Возвращаемое значение

Файл

File

Получение файлов по идентификатору документа

Идентификатор операции:

GetEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Возвращает все файлы, подключенные к заданному документу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор документа	document-id	True	string	Идентификатор документа, который в данном вопросе

Возвращаемое значение

response

array of File

Создание документа из шаблона

Идентификатор операции:

PostEnvelopesEnvelopeIdDocumentsDocumentIdTemplatesTemplateIdUserData

Создает документ из предварительно настроенного шаблона.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор документа	document-id	True	string	Идентификатор документа, который в данном вопросе
Идентификатор шаблона	template-id	True	string	Идентификатор шаблона, который следует использовать
			object

Создание конверта по умолчанию

Идентификатор операции:

PostEnvelopeDescriptorsDefaultEnvelopes

Создает новый конверт с помощью дескриптора по умолчанию.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Адрес электронной почты	email		string
Имя (Первое имя)	givenName		string
Фамилия	familyName		string
Автоматические напоминания	automaticReminders		number
Expiration	expiration		string
Hash	hash		string

Возвращаемое значение

Имя	Путь	Тип	Описание
uid	uid	string

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

Идентификатор операции:

PostEnvelopeDescriptorsEnvelopeDescriptorIdEnvelopes

Создает конверт на основе определенного дескриптора.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор дескриптора конверта	envelope-descriptor-id	True	string	Идентификатор дескриптора конверта
Адрес электронной почты	email		string
Имя (Первое имя)	givenName		string
Фамилия	familyName		string
Автоматические напоминания	automaticReminders		number
Expiration	expiration		string
Hash	hash		string

Возвращаемое значение

Имя	Путь	Тип	Описание
uid	uid	string

Создание маркера безопасности

Идентификатор операции:

PostAuthenticate

Возвращает маркер проверки подлинности из проверенного API.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Без блокировки IP-адресов	withoutIpLock	True	integer	Проверяется, активируется ли IP-блокировка (0, по умолчанию) или нет (1)

Возвращаемое значение

Имя	Путь	Тип	Описание
Токен	token	string	Маркер доступа

Создание ссылки подписи

Идентификатор операции:

PostEnvelopesEnvelopeIdJobsGetSignLink

Создает ссылку подписи. Реализация зависит от потока и может быть отсутствует для конкретного потока.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор	id		string
Перенаправление на	redirectTo		uri	Полный URL-адрес для перенаправления пользователя после входа.

Возвращаемое значение

Имя	Путь	Тип	Описание
URL	getSignLink.recipient.{recipient-id}.url	string

Удаление документа по идентификатору

Идентификатор операции:

DeleteEnvelopesEnvelopeIdDocumentsDocumentId

Удаляет указанный документ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе
Идентификатор документа	document-id	True	string	Идентификатор документа, который в данном вопросе

Удаление конверта по идентификатору

Идентификатор операции:

DeleteEnvelopesEnvelopeId

Удаляет заданный конверт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	token	True	string	Маркер, полученный из действия "Создание маркера безопасности"
Идентификатор компании	x-namespace		string	Идентификатор компании, который должен использоваться для действия. Формат /company/<company id>. По умолчанию используется идентификатор компании, если он не задан.
Идентификатор конверта	envelope-id	True	string	Идентификатор конверта в вопросе

Определения

Setting

Имя	Путь	Тип	Описание
Глобальный	global	string
Язык подписи	preferences.signatoryLanguage	string
Приветствие	preferences.greeting	string
Метод подписи	preferences.signingMethod	string
Смещение напоминания	preferences.reminderOffset	string

Информация о пользователе

Имя	Путь	Тип	Описание
Имя (Первое имя)	givenName	string
Фамилия	familyName	string
Адрес электронной почты	email	string
Language	metadata.language	string
Отсутствующий пароль	missingPassword	boolean
Включен	isEnabled	boolean
Namespace	namespace	string
Включен	enabled	boolean
ИД пользователя	uid	string
Идентификатор	id	string
Роли	roles	array of Role
Validated	validated	boolean

Компания

Имя	Путь	Тип	Описание
Имя	name	string
Reg. Число	regNumber	string
Создано	created	string
Изменено	modified	string
Address	address	string
Город	city	string
Почтовый индекс	zipCode	string
Logo	logo	string
Страна	country	string
UId	uid	string
Идентификатор	id	string

Recipient

Имя	Путь	Тип	Описание
ИД пользователя	uid	string	Идентификатор пользовательского интерфейса получателя
Namespace	namespace	string	Пространство имен получателя
Создано	created	string	Создан получатель
Role	role	RoleActionString
Фамилия	familyName	string	Фамилия получателя
Имя (Первое имя)	givenName	string	Имя получателя Frist
Language	language	string	Язык получателя
Адрес электронной почты	email	string	Электронная почта получателя
Метод подписи	signingMethod	string	Подпись получателя Метхид
Метод уведомления	notificationMethod	string
Заказ	order	integer	Порядок получателей
Идентификатор	id	string	Идентификатор получателя
Изменено	modified	string	Изменен получатель
Уведомления	notified	boolean
Завершено	completed	boolean
demandAttachment	demandAttachment	boolean
Номер социального страхования	ssn	string
Денежные средства	bank	string
Secure	secure	boolean
СМС	sms	boolean
Телефон	telephone	string
Подписи	signatures	object
Notifications	notifications	array of Notification

Role

Имя	Путь	Тип	Описание
Тип	action.type	string
методы	action.methods	array of string
Этикетка	label	string	Этикетка
Число. Max	numMax	integer	Число. Max
Число. мин	numMin	integer	Число. мин
Имя роли	roleName	string

RoleActionString

Имя	Путь	Тип	Описание
Действие	action	ActionString	Действие
Этикетка	label	string	Этикетка
Число. Max	numMax	integer	Число. Max
Число. мин	numMin	integer	Число. мин
Имя роли	roleName	string

ActionString

Действие

Действие

Действие

string

Конверт

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор конверта
ИД пользователя	uid	string	Пользовательский интерфейс конверта
Namespace	namespace	string	Пространство имен конверта
Версия	version	integer	Версия конверта
Опубликовано	published	boolean	Конверт опубликован
Завершено	completed	boolean	Конверт завершен
Прервано	aborted	boolean	Конверт воял
Разгромили	trashed	boolean	Конверт корзины
Последовательная подпись	sequentialSigning	boolean
Напоминания об autmatic	automaticReminders	integer
Создано	created	string	Конверт создан
Изменено	modified	string	Конверт изменен
Срок действия истек	expired	boolean	Срок действия конверта истек
Flow	flow	Flow
Дескриптор	descriptor	Descriptor
Персона	sender	Person
Documents	documents	array of Document
Получатели	recipients	array of Recipient
Метки	tags	array of object
Владельцы	owners	array of Person

КонвертDescriptorString

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор конверта
ИД пользователя	uid	string	Пользовательский интерфейс конверта
Namespace	namespace	string	Пространство имен конверта
Версия	version	integer	Версия конверта
Опубликовано	published	boolean	Конверт опубликован
Завершено	completed	boolean	Конверт завершен
Прервано	aborted	boolean	Конверт воял
Разгромили	trashed	boolean	Конверт корзины
Последовательная подпись	sequentialSigning	boolean
Напоминания об autmatic	automaticReminders	integer
Создано	created	string	Конверт создан
Изменено	modified	string	Конверт изменен
Срок действия истек	expired	boolean	Срок действия конверта истек
Flow	flow	Flow
Дескриптор	descriptor	string	Дескриптор конверта
Персона	sender	Person
Documents	documents	array of Document
Получатели	recipients	array of Recipient
Метки	tags	array of object
Владельцы	owners	array of Person

Файл

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор файла
URL	url	string	URL-адрес файла
Имя	name	string	Имя файла
MimeType	mimeType	string
Тип файла	fileType	string
Путь к хранилищу	storagePath	string
Отправлено по адресу	uploadedAt	string
Создано	created	string	Создан файл
Владельцы	owners	array of object
ИД пользователя	owners.uid	string	Пользовательский интерфейс владельца файла
Идентификатор	owners._id	string	Идентификатор владельца файла
Namespace	namespace	string
ИД пользователя	uid	string	Пользовательский интерфейс файла

Flow

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор потока
Имя	name	string	Имя потока

Дескриптор

Имя	Путь	Тип	Описание
Имя	name	string	Имя дескриптора
Версия	version	integer	Версия дескриптора
ИД пользователя	uid	string	Дескриптор UID
Удалено	deleted	boolean	Дескриптор Deletd
Публика	public	boolean	Общедоступный дескриптор
Срок действия истек	expired	boolean	Срок действия дескриптора истек
Идентификатор	id	string	Идентификатор дескриптора
Mandatory	mandatory	boolean	Обязательный дескриптор
Этикетка	label	string	Метка дескриптора
Тип	type	string	Тип дескриптора
Роли	roles	array of Role
Владельцы	owners	array of Person
Flow	flow	Flow
Значения defaultValues	defaultValues	DefaultValues	Значения defaultValues
Случаи	instances	array of object

Персона

Имя	Путь	Тип	Описание
ИД пользователя	uid	string	Пользовательский интерфейс пользователя
Имя (Первое имя)	givenName	string	Имя пользователя
Фамилия	familyName	string	Фамилия пользователя
Адрес электронной почты	email	string	Электронная почта пользователя
Language	language	string	Язык пользователя
Заказ	order	integer	Заказ пользователя

Документ

Имя	Путь	Тип	Описание
Этикетка	label	string	Метка документа
Тип	type	string	Тип документа
Hash	hash	integer	Хэш документов
Число. Max	numMax	integer	Число документа. Max
Число. мин	numMin	integer	Число документа. мин
ИД пользователя	uid	string	Идентификатор пользовательского интерфейса документа
Namespace	namespace	string	Пространство имен документа
Исходный материал	source	string	Источник документа
Создано	created	string	Документ создан
Имя	name	string	Имя документа
Идентификатор	id	string	Идентификатор документа
Изменено	modified	string	Изменен документ
Отклонено	rejected	boolean	Отклоненный документ
Подписанный	signed	boolean	Подписанный документ
Разгромили	trashed	boolean	Документ с корзиной
Прервано	aborted	boolean	Документ прерван
Версия	version	integer	Версия документа
attachments	attachments	array of Attachment
Flow	flow	Flow
roles	roles	array of Role
Template	template	Template
Дескриптор	descriptor	Descriptor
Подписи	signatures	array of Signature

Вложение

Имя	Путь	Тип	Описание
Этикетка	label	string	Метка вложения
Число. Max	numMax	integer	Число вложений. Max
Число. мин	numMin	integer	Вложения Num.Min
Hash	hash	integer	Хэш вложений

Template

Имя	Путь	Тип	Описание
Тип	type	string	Тип шаблона
HTML	html	string
PDFHTML	pdfHtml	string
Идентификатор	id	string
ИД пользователя	uid	string
Namespace	namespace	string
Версия	version	integer
Создано	created	string
Изменено	modified	string
Изменено	published	boolean
Завершено	completed	boolean
Прервано	aborted	boolean

Signature

Имя	Путь	Тип	Описание
Идентификатор	id	string
Происхождение	origin	string
Имя (Первое имя)	givenName	string	Имя (Первое имя)
Фамилия	familyName	string	Фамилия
Адрес электронной почты	email	string	Адрес электронной почты
IP	ip	string
Date	date	string
Состояние	status	string
Комментарий	comment	string

Значения по умолчанию

Значения defaultValues

Имя	Путь	Тип	Описание
Персона	signer	Person
Персона	reviewer	Person

Notification

Имя	Путь	Тип	Описание
Идентификатор	id	string
ИД пользователя	uid	string
Namespace	namespace	string
Состояние	status	string
Заказ	order	integer
Сведения	details	object
Date	date	string