Добавить подписанта

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

Тип

Обязательный

Описание

envelopeId

string

true

ID конверта

signerInfos

array

true

Коллекция информации о подписантах

businessId

string

false

Пользовательский идентификатор бизнес-процесса разработчика, длина 500

roleTypes

array

false

Способ действия подписанта, значение по умолчанию ["sign", "fill"]

fill - заполнение

sign - подписание

string

false

userEmail

string

false

Адрес электронной почты подписанта

documentVisibility

object

false

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

documentViewType

string

false

Стратегия видимости, по умолчанию all; all означает возможность просмотра всех документов в конверте, limited означает возможность просмотра только собственных подписанных документов и дополнительных документов с разрешенным просмотром.

viewableFileKeys

array

false

Список fileKey для дополнительного разрешения просмотра сторонним участникам; может быть передан и применяется только при documentViewType=limited.

phoneNumber

object

false

Обязательное поле при необходимости отправки SMS-уведомлений; необходимо передать countryCode и number, по умолчанию пусто.

countryCode

string

false

Международный код страны/региона, символ «+» передавать не нужно.

number

string

false

Проверка формата не выполняется, максимальная длина — 13 символов.

customizeSettings

object

false

Пользовательская настройка

notificationSettings

object

false

Пользовательская настройка уведомлений

customizeMessage

string

false

Персональное сообщение уведомления, ограничение на количество символов — 200.

notificationLanguage

string

false

Язык уведомления, по умолчанию используется значение из настройки «язык уведомлений по умолчанию».

en-US Английский (США)

zh-CN Упрощенный китайский

zh-Hant Традиционный китайский

ja-JP Японский

es-MX испанский

pt-PT португальский
th-TH тайский
id-ID индонезийский
vi-VN вьетнамский
ms-MY малайский
fil-PH филиппинский
de-DE немецкий
fr-FR французский
ru-RU русский
it-IT итальянский
ko-KR корейский

userName

string

true

Имя подписанта, отображаемое на странице подписания и в процессе для внешних пользователей.

[Внимание] Нельзя использовать следующие 9 специальных символов: / \ : * " < > | ? а также все эмодзи.

signOrder

int

true

Порядок подписания подписанта, минимальное значение — 1. Для неупорядоченного подписания можно указать одинаковые значения порядка.

signTaskSuspend

boolean

false

Установить ли узел блокировки процесса перед данной позицией подписи. По умолчанию false. true — установить узел блокировки; false — не устанавливать узел блокировки. Конфигурация блокировки внутри группы параллельных подписей с одинаковым signOrder должна быть согласована.

suspensionKey

string

false

Идентификатор узла блокировки, максимум 500 символов, должен быть уникальным в пределах одного конверта. Обязательно при signTaskSuspend=true; недопустимо передавать при signTaskSuspend=false или если параметр не указан.

suspendReason

string

false

Причина блокировки: при передаче не может быть пустой, максимум 50 символов. Допускается передача только при signTaskSuspend=true; если не передано, по умолчанию подразумевается ожидание обработки внешней системой. Недопустимо передавать при signTaskSuspend=false или если параметр не указан.

anySigner

boolean

false

Поддерживает ли подпись любым участником, по умолчанию false

true — достаточно подписания одним участником из группы с тем же signOrder

false — все участники с тем же signOrder должны подписать документ

authModes

string

false

Способ проверки подлинности, по умолчанию noAuth

Перечисляемый тип:

authConfig

object

false

Настройка способа проверки

accessCode

object

false

Настройка пароля подписи, требуется при authModes=accessCode

accessCode

string

false

Содержимое пароля, регистр не учитывается, может содержать буквы и цифры, длина до 45 символов

promptInfo

string

false

Подсказка для доступа к паролю, не должна содержать сам пароль, ограничение длины — 30 символов, требуется при authModes=accessCode

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

Проверка email OTP, требуется при authModes=emailAuth

authEmail

string

false

Адрес электронной почты для проверки личности подписанта

digitalId

array

false

Электронная аутентификация, обязательно при authModes=digitalId

authApp

string

false

Приложение, используемое для электронной аутентификации

singpass- Аутентификация с помощью Singpass

iamsmart- Аутентификация с помощью MyInfo

idNumber

string

false

Номер удостоверения личности подписанта, подлежащий проверке

Когда authApp=singpassправило ввода: заглавная буква + 7 или 8 цифр + заглавная буква

Когда authApp=iamsmartправило ввода:

1. Одна заглавная буква (A-Z) или две заглавные буквы (AA-ZZ) в качестве начала последовательности;

2. Далее идут 6 цифр;

3. В конце контрольная сумма, которая может быть числом (0-9) или буквой (A-Z). Пример: A888888(A)

whatsappAuth

object

false

Проверка OTP через WhatsApp, обязательно при authModes=whatsappAuth

countryCode

string

false

Международный код страны/региона, символ «+» не требуется

number

string

false

Форматная проверка не выполняется, ограничение только по максимальной длине — 13 символов

digitalSignature

boolean

false

Включить цифровую подпись, по умолчанию false

true- Включено

false- Не включено

tsp

string

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

freeFormSign

boolean

false

Свободное размещение печати/подписи подписантом, значение по умолчанию false

Дополнительные пояснения:

При установке freeFormSign=true остальные параметры в sealInfos передавать не требуется. Если они переданы одновременно, приоритет имеет freeFormSign, а параметры из sealInfos не будут действовать.

[Примечание] Свободное размещение означает отсутствие ограничений на количество и положение печатей/подписей, которые может перемещать подписант.

sealInfos

array

false

Информация о задаче подписания

fileKey

string

true

fileKey подписываемого документа

signConfigs

array

false

Информация о расположении элемента управления: для выполнения электронной подписи необходимо указать расположение элемента управления.

fieldType

string

false

Тип элемента управления, возможные значения:

signature- Элемент управления подписью

stamp-Элемент печати

По умолчанию signature

Обязательное поле, по умолчанию обязательно

true-Обязательное

false-Необязательное

signFieldStyle

string

false

Способ размещения подписи и печати, по умолчанию normalSeal.

normalSeal-Обычная подпись и печать

pagingSeal-Печать на стыке страниц

Только элементы подписи и элемента печати поддерживают настройку печати на стыке страниц.

pagingSealMode

string

false

Диапазон страниц для размещения печати на стыке, по умолчанию all.

all-Все страницы

assignedPages-Указанные страницы

even-Четные страницы

odd-Нечетные страницы

Поддерживается указание только при signFieldStyle=pagingSeal.

sizeRule

string

false

Способ отображения размеров зоны подписи

originalSize- Печать/подпись в соответствии с фактическими размерами

targetSize- Пользовательская ширина и высота области подписи/печати

Когда sizeRule, height и width пусты, печать/подпись выполняется в соответствии с фактическими размерами;

Когда sizeRule пусто, а height и width не пусты, печать/подпись выполняется в соответствии с указанными размерами;

Когда sizeRule не пусто, печать/подпись выполняется в соответствии с указанным способом отображения;

Для сквозной печати этот параметр указывать не нужно, печать выполняется только в соответствии с фактическими размерами.

height

int

false

Высота элемента подписи, применяется для fieldType=signature/stamp, единица измерения — пиксели (px), поддерживается передача только положительных целых чисел, по умолчанию auto (автоматический размер системы);

При fieldType=signature допустимый диапазон составляет 20–250 px;

При fieldType=stamp допустимый диапазон составляет 30–280 px;

Для сквозной печати этот параметр указывать не нужно.

width

int

false

Ширина элемента подписи, применяется для fieldType=signature/stamp, единица измерения — пиксели (px), поддерживается передача только положительных целых чисел, по умолчанию auto (автоматический размер системы);

При fieldType=signature допустимый диапазон составляет 20–250 px;

При fieldType=stamp допустимый диапазон составляет 30–280 px;

Для печати на стыке страниц этот параметр не требуется.

signatureOptions

string

false

Параметры элемента подписи. Применимо только при fieldType = signature.

Допустимые значения:

template

handDrawn

upload

aiHandDrawn

Можно выбрать несколько значений, разделяя их запятой; по умолчанию выбраны все

movable

boolean

false

Разрешить перемещение позиции во время подписания, по умолчанию false

false- Запрещено участнику подписания изменять положение своего элемента подписи

true- Разрешено участнику подписания изменять положение своего элемента подписи

allowedOptions

array

false

Параметры, разрешающие участнику подписания выполнять одобрение; применимо при fieldType = approval. По умолчанию ["approve", "decline"]

approve- Согласие

decline- Отказ

pageNo

string

false

Номера страниц для подписания; непрерывные диапазоны страниц указываются через «-», отдельные страницы — через «,», например: 1-3, 6-10

При pagingSealMode=assignedPages передайте диапазон страниц, на которые ставится печать на стыке страниц. Печать на стыке страниц может использоваться только для документов с более чем одной страницей.

posX

string

false

Координата по оси X

Дополнительные пояснения:

Если fieldType равен signature, то координаты указывают позицию области подписинижний левый угол；

Если fieldType равен stamp, координаты указывают на область печати.центральная точкапозиция

Начиная с 3 февраля 2026 года, если fieldType равен signature или stamp, его координаты указывают на центральную точку области печати.

Для сквозной печати можно передавать значение 0, но нельзя передавать null; элемент управления фиксируется по правому краю документа.

posY

string

false

координата по оси Y

Дополнительные пояснения:

Если fieldType равен signature, координаты указывают на область подписи.нижний левый угол；

Если fieldType равен stamp, координаты указывают на область печати.центральная точкапозиция

Начиная с 3 февраля 2026 года, если fieldType равен signature или stamp, его координаты указывают на центральную точку области печати.

fillConfigs

array

false

заполните информацию об элементе управления

fieldName

string

false

Имя элемента управления, ограничение на количество символов — 128

required

boolean

false

Обязательное поле, по умолчанию обязательно для заполнения

true — обязательно для заполнения

false — не обязательно для заполнения

fieldType

string

false

Тип элемента управления:

1 — однострочный текстовый ввод

15 — флажок

textField

object

false

Свойства текстового элемента

overflowType

int

false

Применимо только к типу text, по умолчанию 1

1 — автоматическое уменьшение размера шрифта

2 — ограничение ввода

minFontSize

float

false

Применимо только к типу text и только при overflowType=1, по умолчанию 8.

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

width

int

false

Ширина элемента управления, по умолчанию 160px

font

int

false

Применимо только к типу text, шрифт, по умолчанию Songti (SimSun).

1 — Songti (SimSun)

2-新宋体

4-黑体

5-楷体

6-Arial

7-Helvetica

9-Times New Roman

10-仿宋

11-Georgia

12-Monospace

fontSize

float

false

Действует только для text, размер шрифта, по умолчанию 12

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

textColor

string

false

Действует только для text, цвет в шестнадцатеричном формате, по умолчанию черный #000

bold

boolean

false

Действует только для text, жирный шрифт, по умолчанию false

true-жирный

false-не жирный

italic

boolean

false

Действует только для text, курсив, по умолчанию false

true-курсив

false-не курсив

underline

boolean

false

Действует только для text, подчеркивание, по умолчанию false

true-подчеркнутый

false-без подчеркивания

lineThrough

boolean

false

Действует только для text, добавлять ли зачёркивание, по умолчанию false

true — добавить зачёркивание

false — не добавлять зачёркивание

horizontalAlignment

string

false

Действует только для text, формат горизонтального центрирования, по умолчанию left

LEFT — выравнивание по левому краю

CENTER — по центру

RIGHT — выравнивание по правому краю

tickBoxField

object

false

Свойства флажка

tickOptions

array

false

Действует только для Check, по умолчанию 1

1 — галочка

2 — крестик

posX

float

false

Координата X положения элемента управления

posY

float

false

Координата Y положения элемента управления

pageNo

string

false

Номер страницы, на которой находится элемент управления

signDateConfigs

array

false

Информация о позиции даты подписи

movable

boolean

false

Разрешить перемещение позиции при подписании, по умолчанию false

false- Подписанту запрещено изменять положение своих элементов подписи

true- Подписанту разрешено изменять положение своих элементов подписи

pageNo

string

false

Номера страниц для подписания; непрерывные номера страниц соединяются символом "-", отдельные номера страниц разделяются символом ",", например: 1-3, 6-10

Если страницы не являются непрерывными, используйте символ "," для разделения

posX

float

false

Смещение по оси X, началом координат является левый нижний угол страницы

posY

float

false

Смещение по оси Y, началом координат является левый нижний угол страницы

signDateFormat

string

false

Формат даты подписания, формат по умолчанию — yyyy-MM-dd

Поддерживаемые форматы:

yyyy год MM месяц dd день

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy