Для AI-агентов: markdown этой страницы — /docs-content/sign-b2e/send-document.md индекс документации — /llms.txt
Отправить файл на подпись
POST /v1/sign-b2e/documents/send
Создаёт документ из одного файла и отправляет сотрудникам на подпись. Владельцу ключа нужны права создания документов. Отправка имеет юридические последствия.
Скоупы: sign.b2e, crm.
Поля запроса (body)
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрfields |
Типobject | Обяз.да | ОписаниеОбъект полей. Неизвестные поля и правила заполнения проверяет Битрикс24. |
Параметрfields.company |
Типobject | null | Обяз.да | ОписаниеСобственная компания: crmId или uuid. |
Параметрfields.company.crmId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеИдентификатор собственной компании из списка компаний. |
Параметрfields.company.uuid |
Типstring | null | Обяз.нет | ОписаниеUUID компании HCM Link; требует humanresources.hcmlink. |
Параметрfields.members |
Типarray | null | Обяз.да | ОписаниеУчастники: хотя бы один подписант и один представитель. Состав и роли проверяет Битрикс24. |
Параметрfields.members[].userId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеИдентификатор пользователя из списка пользователей. |
Параметрfields.members[].employeeId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеЧисловой ID сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.members[].employeeCode |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеКод сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.members[].role |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеРоль: signer, assignee, reviewer или editor. |
Параметрfields.responsible |
Типobject | null | Обяз.да | ОписаниеОтветственный; роль по умолчанию assignee. |
Параметрfields.responsible.userId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеИдентификатор пользователя из списка пользователей. |
Параметрfields.responsible.employeeId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеЧисловой ID сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.responsible.employeeCode |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеКод сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.responsible.role |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеРоль: signer, assignee, reviewer или editor. |
Параметрfields.companyProviderUid |
Типnumber | string | boolean | null | Обяз.да | ОписаниеUID провайдера из списка провайдеров компании. Это не числовой идентификатор внешнего провайдера. |
Параметрfields.files |
Типarray | null | Обяз.да | ОписаниеМассив ровно из одного файла. Допустимы PDF, DOCX, DOC, RTF, ODT, JPG, JPEG, PNG; файл проверяет Битрикс24. |
Параметрfields.files[].fileName |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеИмя файла с расширением. |
Параметрfields.files[].fileType |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеMIME-тип, соответствующий расширению. |
Параметрfields.files[].fileContent |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеБайты файла в Base64. |
Параметрfields.regionDocumentType |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеРегиональный тип документа. Допустимость зависит от региона лицензии. |
Параметрfields.externalSettings |
Типobject | null | Обяз.да | ОписаниеНастройки внешней системы; для отправки по шаблону допустим null. |
Параметрfields.externalSettings.externalId |
Типnumber | string | boolean | null | Обяз.да | ОписаниеИдентификатор документа во внешней системе, до 255 символов. |
Параметрfields.externalSettings.externalDateCreate |
Типnumber | string | boolean | null | Обяз.да | ОписаниеДата создания во внешней системе в ISO 8601. Отправка по шаблону требует ATOM с числовым смещением часового пояса. |
Параметрfields.language |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеЯзык названий состояний, по умолчанию en; неизвестный язык заменяется en. Внутри fields принят, но не влияет на документ. |
Параметрfields.message |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеТекст приглашения сотруднику. Ограничения проверяет Битрикс24. |
Параметрfields.signers |
Типarray | null | Обяз.нет | ОписаниеПринимается, но не используется для участников; используйте members. |
Параметрfields.signers[].userId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеИдентификатор пользователя из списка пользователей. |
Параметрfields.signers[].employeeId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеЧисловой ID сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.signers[].employeeCode |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеКод сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.signers[].role |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеРоль: signer, assignee, reviewer или editor. |
Параметрfields.representatives |
Типarray | null | Обяз.нет | ОписаниеПринимается, но не используется для участников; используйте members. |
Параметрfields.representatives[].userId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеИдентификатор пользователя из списка пользователей. |
Параметрfields.representatives[].employeeId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеЧисловой ID сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.representatives[].employeeCode |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеКод сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.representatives[].role |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеРоль: signer, assignee, reviewer или editor. |
Параметрfields.reviewer |
Типobject | null | Обяз.нет | ОписаниеПринимается, но не используется для участников; используйте members. |
Параметрfields.reviewer.userId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеИдентификатор пользователя из списка пользователей. |
Параметрfields.reviewer.employeeId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеЧисловой ID сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.reviewer.employeeCode |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеКод сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.reviewer.role |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеРоль: signer, assignee, reviewer или editor. |
Параметрfields.editor |
Типobject | null | Обяз.нет | ОписаниеПринимается, но не используется для участников; используйте members. |
Параметрfields.editor.userId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеИдентификатор пользователя из списка пользователей. |
Параметрfields.editor.employeeId |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеЧисловой ID сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.editor.employeeCode |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеКод сотрудника HCM Link; null для обычного пользователя. |
Параметрfields.editor.role |
Типnumber | string | boolean | null | Обяз.нет | ОписаниеРоль: signer, assignee, reviewer или editor. |
Параметрlanguage |
Типstring | Обяз.нет | ОписаниеЯзык названий состояний, по умолчанию en; неизвестный язык заменяется en. Внутри fields принят, но не влияет на документ. |
Примеры
curl — личный ключ
curl -X POST 'https://vibecode.bitrix24.tech/v1/sign-b2e/documents/send' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"fields": {"company": {"crmId": 7}, "companyProviderUid": "DUMMY_PROVIDER_UID", "members": [{"userId": 7, "role": "signer"}, {"userId": 8, "role": "assignee"}], "responsible": {"userId": 8, "role": "assignee"}, "files": [{"fileName": "VIBE-PROBE.pdf", "fileType": "application/pdf", "fileContent": "BASE64_FILE_BYTES"}], "externalSettings": {"externalId": "VIBE-PROBE-document-001", "externalDateCreate": "2026-11-13T12:00:00+00:00"}}}'
curl — OAuth-приложение
curl -X POST 'https://vibecode.bitrix24.tech/v1/sign-b2e/documents/send' \
-H 'X-Api-Key: YOUR_APP_KEY' \
-H 'Authorization: Bearer USER_SESSION_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"fields": {"company": {"crmId": 7}, "companyProviderUid": "DUMMY_PROVIDER_UID", "members": [{"userId": 7, "role": "signer"}, {"userId": 8, "role": "assignee"}], "responsible": {"userId": 8, "role": "assignee"}, "files": [{"fileName": "VIBE-PROBE.pdf", "fileType": "application/pdf", "fileContent": "BASE64_FILE_BYTES"}], "externalSettings": {"externalId": "VIBE-PROBE-document-001", "externalDateCreate": "2026-11-13T12:00:00+00:00"}}}'
JavaScript — личный ключ
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/documents/send', {
"method": "POST",
"headers": {
"X-Api-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({"fields": {"company": {"crmId": 7}, "companyProviderUid": "DUMMY_PROVIDER_UID", "members": [{"userId": 7, "role": "signer"}, {"userId": 8, "role": "assignee"}], "responsible": {"userId": 8, "role": "assignee"}, "files": [{"fileName": "VIBE-PROBE.pdf", "fileType": "application/pdf", "fileContent": "BASE64_FILE_BYTES"}], "externalSettings": {"externalId": "VIBE-PROBE-document-001", "externalDateCreate": "2026-11-13T12:00:00+00:00"}}})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);
JavaScript — OAuth-приложение
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/documents/send', {
"method": "POST",
"headers": {
"X-Api-Key": "YOUR_APP_KEY",
"Authorization": "Bearer USER_SESSION_TOKEN",
"Content-Type": "application/json"
},
body: JSON.stringify({"fields": {"company": {"crmId": 7}, "companyProviderUid": "DUMMY_PROVIDER_UID", "members": [{"userId": 7, "role": "signer"}, {"userId": 8, "role": "assignee"}], "responsible": {"userId": 8, "role": "assignee"}, "files": [{"fileName": "VIBE-PROBE.pdf", "fileType": "application/pdf", "fileContent": "BASE64_FILE_BYTES"}], "externalSettings": {"externalId": "VIBE-PROBE-document-001", "externalDateCreate": "2026-11-13T12:00:00+00:00"}}})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеУспешность запроса. |
Полеdata |
Типobject | ОписаниеДанные операции. |
Полеdata.uid |
Типstring | null | ОписаниеUID документа. |
Полеdata.state |
Типobject | null | ОписаниеСостояние объекта. |
Полеdata.state.code |
Типstring | null | ОписаниеМашинный код. |
Полеdata.state.name |
Типstring | null | ОписаниеЛокализованное название состояния подписи. |
Полеdata.members |
Типarray | ОписаниеУчастники документа. |
Полеdata.members[].uid |
Типstring | null | ОписаниеUID участника подписи. |
Полеdata.members[].role |
Типstring | null | ОписаниеРоль участника. |
Полеdata.members[].state |
Типobject | null | ОписаниеСостояние объекта. |
Полеdata.members[].state.code |
Типstring | null | ОписаниеМашинный код. |
Полеdata.members[].state.name |
Типstring | null | ОписаниеЛокализованное название состояния подписи. |
Полеdata.members[].user |
Типobject | null | ОписаниеПользователь участника. |
Полеdata.members[].party |
Типinteger | null | ОписаниеНомер стороны подписания участника. |
Полеdata.members[].user.employeeCode |
Типstring | null | ОписаниеКод сотрудника HCM Link; null для обычного пользователя. |
Полеdata.members[].user.employeeId |
Типinteger | null | ОписаниеЧисловой ID сотрудника HCM Link; null для обычного пользователя. |
Полеdata.members[].user.userId |
Типinteger | null | ОписаниеИдентификатор пользователя. |
Полеmeta.redacted |
Типarray | ОписаниеПрисутствует при скрытии учётных данных; содержит пути изменённых значений. |
Пример ответа
Форма успешного ответа; данные зависят от портала и запроса.
{
"success": true,
"data": {
"uid": "DUMMY_DOCUMENT_UID",
"state": {
"code": "ready",
"name": "Ready"
},
"members": []
}
}
Пример ответа при ошибке
403 — ключу не выдан обязательный скоуп:
{
"success": false,
"error": {
"code": "SCOPE_DENIED",
"message": "This endpoint requires 'sign.b2e' scope"
}
}
Ошибки
| HTTP | Код | Причина |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ПричинаНеверная форма запроса: типы, обязательные поля или неизвестный параметр строки запроса. |
| HTTP401 | КодTOKEN_MISSING |
ПричинаНет учётных данных соединения с Битрикс24. |
| HTTP403 | КодSCOPE_DENIED |
ПричинаНе выдан один из обязательных скоупов. |
| HTTP422 | КодBITRIX_ERROR |
ПричинаБитрикс24 отказал в операции; код в error.b24Code, текст в error.message. |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ПричинаКлюч разрешает только чтение. |
Известные особенности
Поля signers, representatives, reviewer и editor разбираются DTO, но операция отправки их не использует. HCM Link проверяется только для company.uuid, members и responsible; legacy-поля не выбирают сотрудников HCM и не требуют дополнительного скоупа. Участников задавайте через members с нужной ролью.
Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Поля, отмеченные обязательными, проверяет Битрикс24; отсутствие бизнес-поля остаётся его отказом. Числовые и логические значения скалярных полей и null принимаются согласно преобразованиям Битрикс24. Текст ответа кодируется в JSON; ссылки с учётными данными скрываются.
Операция автоматически не повторяется. При неизвестном результате сначала выясните состояние на портале; повтор отправки может создать ещё один документ.
Тело запроса ограничено 40 МиБ вместе с Base64. Предварительный допуск большого тела может вернуть 413 или 429. Участники берутся из members; signers, representatives, reviewer и editor не используются для этого.