# Получить документ КЭДО HCM Link

`GET /v1/sign-b2e/hcmlink/documents/:id`

Возвращает сведения о подписанном документе по идентификатору участника. Нужен OAuth администратора; на стороне Битрикс24 должна быть доступна интеграция HCM Link.

**Скоупы:** `sign.b2e`.

Доступен только ключу OAuth-приложения с пользовательской сессией. Для входящего вебхука возвращается `422 BITRIX_ERROR` с нативным кодом `WRONG_AUTH_TYPE` в `error.b24Code`.

## Параметры пути

| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| `id` | string | да | Числовой идентификатор участника подписанного документа HCM Link; это не UID документа. |

## Примеры

### curl — OAuth-приложение

```bash
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/hcmlink/documents/7' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN'
```

### JavaScript — OAuth-приложение

```javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/hcmlink/documents/7', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN"
  }
});
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.company` | string | Код компании HCM Link. |
| `data.employee` | string | Код сотрудника HCM Link. |
| `data.document` | object | Данные подписанного документа и файла. |
| `data.document.date` | string | Дата создания документа в ATOM. |
| `data.document.name` | string | Название документа. |
| `data.document.fileUrl` | string | URL файла; ссылки с учётными данными скрываются. |
| `data.document.fileName` | string | Имя подписанного файла. |
| `data.document.uid` | string \| null | UID документа HCM Link или null. |
| `data.document.documentUid` | string \| null | UID документа подписи или null. |
| `meta.redacted` | array<string> | Присутствует при скрытии учётных данных; содержит пути изменённых значений. |

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

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

```json
{
  "success": true,
  "data": {
    "company": "DUMMY_COMPANY_CODE",
    "employee": "DUMMY_EMPLOYEE_CODE",
    "document": {
      "date": "2026-11-13T12:00:00+00:00",
      "name": "VIBE-PROBE",
      "fileUrl": "[REDACTED]",
      "fileName": "VIBE-PROBE.pdf",
      "uid": "DUMMY_MEMBER_UID",
      "documentUid": "DUMMY_DOCUMENT_UID"
    }
  },
  "meta": {
    "redacted": [
      "/data/document/fileUrl"
    ]
  }
}
```

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

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. |
| 422 | `BITRIX_ERROR` | Входящий вебхук вместо OAuth. Нативный код `WRONG_AUTH_TYPE` передаётся в `error.b24Code`. |

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

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

Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Текст ответа кодируется в JSON; ссылки с учётными данными скрываются.

Нативный метод требует только `sign.b2e`: отдельной проверки `humanresources.hcmlink` нет. OAuth-контекст, права администратора и доступность КЭДО проверяет Битрикс24 (`sign/lib/Rest/B2e/HcmLink/SignedFile.php:25–38,98–115`). Дополнительный HCM-скоуп в этом семействе нужен только для HCM-параметров отправки документа и списка провайдеров компании.

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

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