[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-sign-b2e\u002Fget-hcm-document":3,"docs-tabs-sign-b2e\u002Fget-hcm-document":6},{"content":4,"lastmod":5},"# Get an HCM Link HR document\n\n`GET \u002Fv1\u002Fsign-b2e\u002Fhcmlink\u002Fdocuments\u002F:id`\n\nReturns details of a signed document by its member ID. Requires administrator OAuth; the HCM Link integration must be available on the Bitrix24 side.\n\n**Scopes:** `sign.b2e`.\n\nAvailable only to an OAuth application key with a user session. An incoming webhook receives `422 BITRIX_ERROR` with the native `WRONG_AUTH_TYPE` code in `error.b24Code`.\n\n## Path parameters\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| `id` | string | yes | Numeric member ID of the signed HCM Link document; this is not the document UID. |\n\n## Examples\n\n### curl — OAuth application\n\n```bash\ncurl -X GET 'https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsign-b2e\u002Fhcmlink\u002Fdocuments\u002F7' \\\n  -H 'X-Api-Key: YOUR_APP_KEY' \\\n  -H 'Authorization: Bearer USER_SESSION_TOKEN'\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst response = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsign-b2e\u002Fhcmlink\u002Fdocuments\u002F7', {\n  \"method\": \"GET\",\n  \"headers\": {\n    \"X-Api-Key\": \"YOUR_APP_KEY\",\n    \"Authorization\": \"Bearer USER_SESSION_TOKEN\"\n  }\n});\nconst result = await response.json();\nif (!response.ok || !result.success) throw new Error(result.error?.message);\nconsole.log(result.data);\n```\n\n## Response fields\n\n| Field | Type | Description |\n|---|---|---|\n| `success` | boolean | Whether the request succeeded. |\n| `data` | object | Operation data. |\n| `data.company` | string | HCM Link company code. |\n| `data.employee` | string | HCM Link employee code. |\n| `data.document` | object | Signed document and file details. |\n| `data.document.date` | string | Document creation date in ATOM format. |\n| `data.document.name` | string | Document title. |\n| `data.document.fileUrl` | string | File URL; credential-bearing links are hidden. |\n| `data.document.fileName` | string | Signed file name. |\n| `data.document.uid` | string \\| null | HCM Link document UID, or null. |\n| `data.document.documentUid` | string \\| null | Signing document UID, or null. |\n| `meta.redacted` | array\u003Cstring> | Present when credentials are hidden; contains the paths of the replaced values. |\n\n## Response example\n\nShape of a successful response; the data depends on the Bitrix24 account and the request.\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"company\": \"DUMMY_COMPANY_CODE\",\n    \"employee\": \"DUMMY_EMPLOYEE_CODE\",\n    \"document\": {\n      \"date\": \"2026-11-13T12:00:00+00:00\",\n      \"name\": \"VIBE-PROBE\",\n      \"fileUrl\": \"[REDACTED]\",\n      \"fileName\": \"VIBE-PROBE.pdf\",\n      \"uid\": \"DUMMY_MEMBER_UID\",\n      \"documentUid\": \"DUMMY_DOCUMENT_UID\"\n    }\n  },\n  \"meta\": {\n    \"redacted\": [\n      \"\u002Fdata\u002Fdocument\u002FfileUrl\"\n    ]\n  }\n}\n```\n\n## Error response example\n\n403 — the key lacks a required scope:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"SCOPE_DENIED\",\n    \"message\": \"This endpoint requires 'sign.b2e' scope\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Reason |\n|---|---|---|\n| 400 | `INVALID_PARAMS` | Invalid request shape: types, required fields or an unknown query string parameter. |\n| 401 | `TOKEN_MISSING` | No credentials for the Bitrix24 connection. |\n| 403 | `SCOPE_DENIED` | One of the required scopes is not granted. |\n| 422 | `BITRIX_ERROR` | Bitrix24 rejected the operation; the code is in error.b24Code, the text in error.message. |\n| 422 | `BITRIX_ERROR` | An incoming webhook was used instead of OAuth. The native `WRONG_AUTH_TYPE` code is in `error.b24Code`. |\n\n[Common API errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\nBitrix24 checks user permissions, HR e-signature availability, business rules, page sizes and field contents. Values are passed through without local correction. Response text is JSON-encoded; credential-bearing links are hidden.\n\nThe native method requires only `sign.b2e`: there is no separate `humanresources.hcmlink` check. Bitrix24 checks the OAuth context, administrator permissions and HR e-signature availability (`sign\u002Flib\u002FRest\u002FB2e\u002FHcmLink\u002FSignedFile.php:25–38,98–115`). In this method family, the additional HCM scope is required only for the HCM parameters when sending a document and for listing company providers.\n\n## See also\n\n- [Employee signatures](\u002Fdocs\u002Fsign-b2e)\n- [API errors](\u002Fdocs\u002Ferrors)\n","2026-11-18",{},1795344084226]