# Отправить файл на подпись

`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 | нет | Идентификатор собственной компании из [списка компаний](/docs/entities/companies). |
| `fields.company.uuid` | string \| null | нет | UUID компании HCM Link; требует humanresources.hcmlink. |
| `fields.members` | array \| null | да | Участники: хотя бы один подписант и один представитель. Состав и роли проверяет Битрикс24. |
| `fields.members[].userId` | number \| string \| boolean \| null | нет | Идентификатор пользователя из [списка пользователей](/docs/entities/users). |
| `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 | нет | Идентификатор пользователя из [списка пользователей](/docs/entities/users). |
| `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 провайдера из [списка провайдеров компании](./list-company-providers.md). Это не числовой идентификатор внешнего провайдера. |
| `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 | нет | Идентификатор пользователя из [списка пользователей](/docs/entities/users). |
| `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 | нет | Идентификатор пользователя из [списка пользователей](/docs/entities/users). |
| `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 | нет | Идентификатор пользователя из [списка пользователей](/docs/entities/users). |
| `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 | нет | Идентификатор пользователя из [списка пользователей](/docs/entities/users). |
| `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 — личный ключ

```bash
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-приложение

```bash
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 — личный ключ

```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-приложение

```javascript
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<string> | Присутствует при скрытии учётных данных; содержит пути изменённых значений. |

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

Форма успешного ответа; данные зависят от портала и запроса.

```json
{
  "success": true,
  "data": {
    "uid": "DUMMY_DOCUMENT_UID",
    "state": {
      "code": "ready",
      "name": "Ready"
    },
    "members": []
  }
}
```

## Пример ответа при ошибке

403 — ключу не выдан обязательный скоуп:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'sign.b2e' scope"
  }
}
```

## Ошибки

| HTTP | Код | Причина |
|---|---|---|
| 400 | `INVALID_PARAMS` | Неверная форма запроса: типы, обязательные поля или неизвестный параметр строки запроса. |
| 401 | `TOKEN_MISSING` | Нет учётных данных соединения с Битрикс24. |
| 403 | `SCOPE_DENIED` | Не выдан один из обязательных скоупов. |
| 422 | `BITRIX_ERROR` | Битрикс24 отказал в операции; код в error.b24Code, текст в error.message. |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ разрешает только чтение. |

[Общие ошибки API](/docs/errors).

## Известные особенности

Поля 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 не используются для этого.

## Смотрите также

- [Подпись сотрудников](/docs/sign-b2e)
- [Ошибки API](/docs/errors)
