PKIsigning (предварительная версия)

Автоматизация подписывания документов с помощью соединителя платформы PKIsigning. Отправка документов на платформу PKIsigning; отправьте приглашения и получите подписанные документы.

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

Услуга	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)

Контакт
Имя	Поддержка PKIsigning
URL	https://pkisigning.nl/support
Адрес электронной почты	support@pkisigning.nl

Метаданные соединителя
Publisher	SBRS B.V.
Website	https://pkisigning.nl
Политика конфиденциальности	https://pkisigning.nl/privacy
Категории	Сотрудничество; Продуктивность

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

Предпосылки

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

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

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

Начало работы с соединителем

Поток по умолчанию для начала подписывания документов выглядит следующим образом:

Создание dossier
Добавление документов
Добавление субъектов
Запуск рабочего процесса
Использование триггера для получения уведомления об изменениях состояния
Скачивание dossier

Досье

PKIsigning ожидает, что вы всегда создадите досье. Dossier выступает в качестве контейнера для документов и субъектов. С помощью действия Dossiers_Create можно создать досье. После создания досье используйте возвращенный PkisId в качестве ссылки для будущих действий.

Documents

После создания досье можно добавить документы с помощью действия Documents_Add с помощью правильного dossierId. Действие не требует других параметров, так как они отвлекаются от самих файлов документов. Количество документов в досье не ограничено. Все документы будут доступны для просмотра и скачивания для всех добавленных субъектов.

Важно: документу требуется один или несколько уникальных текстовых заполнителей в зависимости от количества подписей, чтобы указать, где должна размещаться подпись и какой субъект. Это может быть любой текст в любом месте документа. При добавлении субъектов можно определить заполнитель с параметром заполнителя. Например: signature1, signature2 и т. д.

Actors

Третий шаг состоит в добавлении субъектов в документы. Это делается с помощью действия Actor_Create с помощью правильного dossierId и documentId.

Запуск рабочего процесса

Чтобы запустить рабочий процесс и эффективно отправить приглашения всем субъектам, чтобы подписать или скачать документы в указанном порядке, используйте действие Dossiers_StartWorkflow с правильным dossierId.

Использование триггера для получения уведомления об изменениях состояния

Чтобы получить документ после подписания, подпишитесь на уведомления с помощью триггера. Чтобы получить уведомление о состоянии, укажите "состояние" в поле "События".

Скачивание dossier

Когда триггер уведомляется об обновлении состояния, проверьте, является ли состояние документа завершенным. По состоянию на этот момент можно скачать все документы в досье в одном ZIP-файле. Если он указан в параметрах платформы PKIsigning, которую должен быть создан аудит, он также будет включен.

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

В момент публикации не известно никаких проблем.

Распространенные ошибки и средства устранения неполадок

Без обновлений состояния с помощью триггера

Если триггер не отвечает на обновления состояния, проверьте, было ли задано значение "состояние" в поле "События".

Требуется ошибка HTTP 402

Платформа PKIsigning требует кредиты для выполнения действий. При добавлении субъектов кредиты зарезервированы, чтобы гарантировать, что действие может происходить, и приглашенные не сталкиваются с проблемами, связанными с недостаточным количеством доступных кредитов. Если много приглашений отправляются субъектам, это может произойти, что кредитный пакет больше не имеет кредитов, которые осталось зарезервировано. В этот момент будет возвращена ошибка HTTP 402.

Чтобы устранить проблему, поддержка PKIsigning для верхней суммы кредита или очистка любых неотступных доссиеров с субъектами в корзине на платформе. Неиспользуемые кредиты снова становятся доступными.

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

Ознакомьтесь с нашей базой знаний или обратитесь к нам по адресу support@pkisigning.nl

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

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

Действия

Запрос на обновление	Изменяет данные для конкретного запроса.
Запрос на скачивание	Загружает запросы и его содержимое в виде файла .zip.
Обновление документа	Изменяет данные для определенного документа.
Обновление субъекта	Изменяет данные для определенного субъекта.
Отмена приглашения	Отменяет приглашение для текущего субъекта в строке конкретного запроса.
Отправка запроса	Запускает рабочий процесс и отправляет приглашение первому субъекту в строке для конкретного запроса.
Повторное приглашение	Повторно отправляет приглашение для текущего субъекта в строке конкретного запроса.
Получение данных документа	Возвращает все (мета)данные для определенного документа.
Получение данных запроса	Возвращает все (мета)данные для определенного запроса.
Получение данных субъекта	Возвращает все данные для определенного субъекта.
Получение данных субъекта по документу	Возвращает все данные всех субъектов для определенного документа.
Получение данных субъекта по запросу	Возвращает все данные всех субъектов для конкретного запроса.
Получение рабочих групп для организации	Возвращает список всех рабочих групп для конкретной организации.
Получение рабочих групп для пользователя	Возвращает список всех рабочих групп для конкретного пользователя определенной организации.
Создание документа	Создает новый документ и добавляет его в конкретный запрос.
Создание субъекта	Создает новый субъект и добавляет его в документ.
Создать запрос	Создайте новый запрос.
Удаление документа	Окончательно удаляет определенный документ.
Удаление запроса	Окончательно удаляет определенный запрос.
Удаление субъекта	Окончательно удаляет определенный субъект.

Запрос на обновление

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

Изменяет данные для конкретного запроса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Имя запроса	name	True	string	Имя конкретного запроса.
Идентификатор рабочей группы	workgroupId		guid	Уникальный идентификатор рабочей группы.
Уровень разрешения безопасности	clearancelevel	True	integer	Уровень разрешения безопасности для конкретного запроса.
Владелец запроса	owner		email	Пользователь, являющийся владельцем определенного запроса.

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

Тело: RequestModel

Запрос на скачивание

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

Загружает запросы и его содержимое в виде файла .zip.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.

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

response: file

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

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

Изменяет данные для определенного документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Идентификатор документа	documentId	True	guid	Уникальный идентификатор документа.
Имя документа	name		string	Имя конкретного документа
Имя файла документа	filename		string	Имя файла для определенного документа
Тип документа	documentType	True	string	Тип для определенного документа. (Например, обычный PDF-файл, финансовый отчет, отчет аудиторов и т. д.).

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

Общие метаданные документа

Тело: DocumentMetaDataModel

Обновление субъекта

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

Изменяет данные для определенного субъекта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Идентификатор документа	documentId	True	guid	Уникальный идентификатор документа.
Идентификатор субъекта	actorId	True	guid	Уникальный идентификатор субъекта.
Действие	action	True	string	Действие, которое должен выполнить субъект.
Имя (первое имя)	firstname	True	string	Имя субъекта.
Приставка	prefix		string	Префикс субъекта.
Фамилия	lastname	True	string	Фамилия субъекта.
Адрес электронной почты	email	True	string	Адрес электронной почты субъекта.
Номер мобильного телефона	mobile	True	string	Номер мобильного телефона субъекта.
Deadline	deadline	True	date-time	Дата и время выполнения действия субъектом.
Language	language	True	string	Язык приглашения.
Использование строгой проверки	validateRealIdentity	True	boolean	Используйте более строгий метод идентификации для этого субъекта.
dossierPersonId	dossierPersonId		integer
сообщение	message		string

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

Тело: ExtendedSignerModel

Отмена приглашения

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.

Отправка запроса

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

Запускает рабочий процесс и отправляет приглашение первому субъекту в строке для конкретного запроса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.

Повторное приглашение

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

Повторно отправляет приглашение для текущего субъекта в строке конкретного запроса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.

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

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

Возвращает все (мета)данные для определенного документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Идентификатор документа	documentId	True	guid	Уникальный идентификатор документа.

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

Общие метаданные документа

Тело: DocumentMetaDataModel

Получение данных запроса

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Ключ проверки подлинности	callbackAuthenticationKey		string	Ключ проверки подлинности, предоставленный триггером.

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

Тело: RequestModel

Получение данных субъекта

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

Возвращает все данные для определенного субъекта.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Идентификатор документа	documentId	True	guid	Уникальный идентификатор документа.
Идентификатор субъекта	actorId	True	guid	Уникальный идентификатор субъекта.

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

Тело: ExtendedSignerModel

Получение данных субъекта по документу

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

Возвращает все данные всех субъектов для определенного документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Идентификатор документа	documentId	True	guid	Уникальный идентификатор документа.
Действие завершено	hasActed		boolean	Возвращает только актеров, которые не выполнили свое действие, оставьте пустым, чтобы вернуть всех субъектов.

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

response: array of ExtendedSignerModel

Получение данных субъекта по запросу

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

Возвращает все данные всех субъектов для конкретного запроса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Субъект действовал по запросу	hasActed		boolean	Значение только для чтения, чтобы проверить, действует ли субъект в документе.

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

response: array of ExtendedSignerModel

Получение рабочих групп для организации

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор организации	organisationId	True	guid	Уникальный идентификатор организации.

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

response: array of OrganisationWorkgroup

Получение рабочих групп для пользователя

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор организации	organisationId	True	guid	Уникальный идентификатор организации.
Имя пользователя	username	True	email	Emailaddress пользователя

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

response: array of OrganisationWorkgroup

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса, к которому относится этот документ.
Файл	file	True	file	Обрабатываемый файл (только определенные типы файлов).

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

Общие метаданные документа

Тело: DocumentMetaDataModel

Создание субъекта

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

Создает новый субъект и добавляет его в документ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Идентификатор документа	documentId	True	guid	Уникальный идентификатор документа.
Действие	action	True	string	Действие, которое должен выполнить субъект.
Имя (первое имя)	firstname	True	string	Имя субъекта.
Приставка	prefix		string	Префикс субъекта.
Фамилия	lastname	True	string	Фамилия субъекта.
Адрес электронной почты	email	True	string	Адрес электронной почты субъекта.
Номер мобильного телефона	mobile	True	string	Номер мобильного телефона субъекта.
Deadline	deadline	True	date-time	Дата и время выполнения действия субъектом.
Language	language	True	string	Язык приглашения.
Использование строгой проверки	validateRealIdentity	True	boolean	Используйте более строгий метод идентификации для этого субъекта.
dossierPersonId	dossierPersonId		integer
сообщение	message		string
Поле подписывания	fieldName		string	Имя существующего поля подписи в документе для подписывания этого субъекта.
Placeholder	placeholder		string	Текст определенного заполнителя в документе, в котором субъект должен поместить подпись.

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

Тело: ExtendedSignerModel

Создать запрос

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

Создайте новый запрос.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя запроса	name	True	string	Имя конкретного запроса.
Идентификатор рабочей группы	workgroupId		guid	Уникальный идентификатор рабочей группы.
Уровень разрешения безопасности	clearancelevel	True	integer	Уровень разрешения безопасности для конкретного запроса.
Владелец запроса	owner		email	Пользователь, являющийся владельцем определенного запроса.

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

Тело: RequestModel

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

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

Окончательно удаляет определенный документ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Идентификатор документа	documentId	True	guid	Уникальный идентификатор документа.

Удаление запроса

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

Окончательно удаляет определенный запрос.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.

Удаление субъекта

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

Окончательно удаляет определенный субъект.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	requestId	True	guid	Уникальный идентификатор запроса.
Идентификатор документа	documentId	True	guid	Уникальный идентификатор документа.
Идентификатор субъекта	actorId	True	guid	Уникальный идентификатор субъекта.

Триггеры

При возникновении события в запросе

Зарегистрируйте URL-адрес обратного вызова при изменении состояния. Платформа PKIsigning будет сообщать о любых состояниях dossiers в этой организации по этому URL-адресу.

При возникновении события в запросе

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Типы событий	Events	True	array of string	Список типов событий, происходящих по запросу, в котором будет уведомлен этот триггер.
Идентификатор организации	organisationId	True	guid	Уникальный идентификатор организации.

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

Имя	Путь	Тип	Описание
Идентификатор запроса	PkisId	guid	Уникальный идентификатор запроса.
Статус запроса	DossierStatus	string	Состояние досье.
Причина	Reason	string	Причина изменения.
Ключ проверки подлинности	AuthenticationKey	string	Заголовок для получения метаданных в запросе.

Определения

ExtendedSignerModel

Имя	Путь	Тип	Описание
Поле подписывания	fieldName	string	Имя существующего поля подписи в документе для подписывания этого субъекта.
Placeholder	placeholder	string	Текст определенного заполнителя в документе, в котором субъект должен поместить подпись.
Действие	action	string	Действие, которое должен выполнить субъект.
Имя (первое имя)	firstname	string	Имя субъекта.
Приставка	prefix	string	Префикс субъекта.
Фамилия	lastname	string	Фамилия субъекта.
Адрес электронной почты	email	string	Адрес электронной почты субъекта.
Номер мобильного телефона	mobile	string	Номер мобильного телефона субъекта.
Deadline	deadline	date-time	Дата и время выполнения действия субъектом.
Language	language	string	Язык приглашения.
Использование строгой проверки	validateRealIdentity	boolean	Используйте более строгий метод идентификации для этого субъекта.
dossierPersonId	dossierPersonId	integer
сообщение	message	string
Идентификатор субъекта	id	guid	Уникальный идентификатор определенного субъекта.
Дата завершения	signingDate	date-time	Дата и время выполнения действия субъекта.
Действие завершено	hasSigned	boolean
ФИО	fullName	string	Объединенное имя, префикс и фамилия субъекта.
Сведения о состоянии	emailActivity	array of EmailActivity	Сведения о состоянии процесса выполнения действия субъектом.
documentId	documentId	guid

EmailActivity

Метаданные сообщения электронной почты, отправляемые субъекту

Имя	Путь	Тип	Описание
Действия с почтой	event	string	Действие электронной почты для определенного запроса и субъекта.
Сведения о SMTP	reason	string	СВЕДЕНИЯ SMTP для сообщения электронной почты, отправляемого конкретному субъекту в рамках запроса.
Дата электронной почты	timestamp	date-time	Дата отправки сообщения электронной почты конкретному субъекту в рамках запроса.
Тип электронной почты	pkisMessageType	string	Введите сообщение электронной почты, отправленное конкретному субъекту в рамках запроса (например, приглашение, напоминание и т. д.).
Идентификатор запроса электронной почты	pkisInviteId	string	Уникальный идентификатор для сообщения электронной почты, отправленного конкретному субъекту в рамках запроса.
Адрес электронной почты	email	string	Адрес электронной почты, отправленный конкретному субъекту в рамках запроса.

SignerModel

Особый тип субъекта

Имя	Путь	Тип	Описание
Действие	action	string	Действие, которое должен выполнить субъект.
Имя (первое имя)	firstname	string	Имя субъекта.
Приставка	prefix	string	Префикс субъекта.
Фамилия	lastname	string	Фамилия субъекта.
Адрес электронной почты	email	string	Адрес электронной почты субъекта.
Номер мобильного телефона	mobile	string	Номер мобильного телефона субъекта.
Deadline	deadline	date-time	Дата и время выполнения действия субъектом.
Language	language	string	Язык приглашения.
Использование строгой проверки	validateRealIdentity	boolean	Используйте более строгий метод идентификации для этого субъекта.
dossierPersonId	dossierPersonId	integer
сообщение	message	string
Поле подписывания	fieldName	string	Имя существующего поля подписи в документе для подписывания этого субъекта.
Placeholder	placeholder	string	Текст определенного заполнителя в документе, в котором субъект должен поместить подпись.

DocumentMetaDataModel

Общие метаданные документа

Имя	Путь	Тип	Описание
Имя документа	name	string	Имя определенного документа.
Последнее обновление документа	lastUpdate	date-time	Дата последнего обновления для определенного документа.
Количество страниц документов	pages	integer	Количество страниц для определенного документа.
Дата создания документа	created	date-time	Дата создания для определенного документа.
Идентификатор документа	id	guid	Уникальный идентификатор документа.
Состояние документа	status	string	Состояние определенного документа. (Например, новые, завершенные и т. д.).
Документ содержит подпись	signed	boolean	Указывает, содержит ли определенный документ одну или несколько подписей.
Подписи документов	signatures	array of SignatureData	Список всех подписей для определенного документа.
Документирование пустых полей подписи	emptySignatureFields	array of SignatureField	Список всех пустых полей подписи для определенного документа.
Пустые поля подписи	containsBlankSignatureFields	boolean	Указывает, содержит ли определенный документ пустые поля подписи.
Субъекты документов	actors	array of ExtendedSignerModel	Список всех субъектов для определенного документа.
Идентификатор запроса	requestId	guid	Уникальный идентификатор запроса.
Индекс запроса	dossierIndex	integer	Индекс всех документов, принадлежащих конкретному запросу.
documentSize	documentSize	integer	Размер документа, относящегося к конкретному запросу.
documentType	documentType	string	Тип документа, относящегося к конкретному запросу.

SignatureData

Имя	Путь	Тип	Описание
Поля субъекта сертификата	subject	array of KeyValuePairOfStringAndString	Поля из строки темы сертификата, используемого для определенной подписи.
Поля издателя сертификатов	issuer	array of KeyValuePairOfStringAndString	Поля из строки издателя сертификата, используемого для определенной подписи.
Дата подписи	date	date-time	Дата и время размещения определенной подписи.
Расположение подписывания	location	string	Географическое расположение определенного субъекта во время подписания.
Причина подписывания	reason	string	Причина подписывания, предоставленной конкретным субъектом во время подписания.
Квалифицированная электронная подпись	euQualified	boolean	Указывает, соответствует ли определенная подпись (QeS) нормативным требованиям eIDAS.
Расширенная электронная подпись	advanced	boolean	Указывает, соответствует ли определенная сигнатура (AeS) нормативным требованиям eIDAS.
Квалифицированный eSeal	eSeal	boolean	Указывает, является ли определенный сертификат, используемый для подписи или печати, соответствующим правилам eSeal eIDAS.
IP-адрес субъекта	ipAddress	string	IP-адрес для определенного субъекта
Поле подписи	signatureField	string	Поле, подписанное
Изображение подписи	signatureImage	string	Файл изображения, используемый для определенной подписи, выбранной субъектом.

KeyValuePairOfStringAndString

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

SignatureField

Имя	Путь	Тип	Описание
Имя поля подписи	name	string	Имя определенного поля подписи
Страница поля подписи	page	integer	Страница, на которой помещается определенное поле подписи для определенного документа.
Координата ширины поля подписи	x	double	Значение ширины позиции для определенного поля подписи относительно страницы, вложенной в определенный документ.
Высокая координата поля подписи	y	double	Высокое значение позиции для определенного поля подписи относительно страницы, вложенной в определенный документ.
Поле сигнатуры hight	height	double	Высокое значение для определенного поля подписи.
Ширина поля подписи	width	double	Значение ширины для определенного поля подписи.

OrganizationWorkgroup

Рабочая группа, используемая в досье

Имя	Путь	Тип	Описание
Идентификатор рабочей группы	id	guid	Уникальный идентификатор рабочей группы
Имя рабочей группы	name	string	Имя конкретной рабочей группы

RequestModel

Имя	Путь	Тип	Описание
Идентификатор запроса	id	guid	Уникальный идентификатор запроса
Имя запроса	dossierName	string	Имя конкретного запроса.
Запрос документов	documents	array of DocumentModel	Список документов, включенных в этот запрос.
Статус запроса	status	string	Состояние конкретного запроса. (Например, новые, завершенные и т. д.).
Субъекты запросов	actors	array of ExtendedSignerModel	Список всех субъектов для определенного запроса.
Подписи документов	signatures	array of SignatureData	Список всех подписей для конкретного запроса.
Тип запроса	dossierType	string	Тип для конкретного запроса. (E.g. PDF, SBR Assurance и т. д.).
Причина отмены	reasons	string	Причина отмены конкретного запроса пользователем или субъектом.
Заметка о подписывшем	signerNote	string	Обратите внимание на одно или несколько субъектов, которые не имеют других действий, кроме знака.
Примечание получателя	recipientNote	string	Обратите внимание на один или несколько субъектов, которые не имеют других действий, кроме скачивания.
Примечание утверждающего	accorderNote	string	Обратите внимание на один или несколько субъектов, которые не имеют других действий, кроме утверждения запроса.
Дата истечения срока действия запроса	expires	date-time	Дата и время истечения срока действия для конкретного запроса.
Сведения о состоянии	emailActivity	array of EmailActivity	Сведения о состоянии процесса выполнения действия субъектом.
Мой запрос	myDossier	boolean	Указывает, является ли вы владельцем определенного запроса.
Идентификатор рабочей группы	workgroup	guid	Уникальный идентификатор рабочей группы.
Уровень разрешения безопасности	clearancelevel	integer	Уровень разрешения безопасности для конкретного запроса.

DocumentModel

Имя	Путь	Тип	Описание
Идентификатор документа	id	guid	Уникальный идентификатор документа
Имя документа	name	string	Имя определенного документа
Тип документа	documentType	string	Введите конкретный документ.
Индекс запроса	dossierIndex	integer	Индекс всех документов, принадлежащих конкретному запросу.
Состояние документа	documentstatus	string	Состояние определенного документа. (Например, новые, завершенные и т. д.).
Субъекты документов	actors	array of SignerModel	Список всех субъектов для определенного документа.

file

Это базовый тип данных file.