Retrieve Signed HCM Link Document sign.b2e.hcmlink.document.get
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
sign.b2eWho can execute the method: administrator
The sign.b2e.hcmlink.document.get method returns data of a signed e-Signature for HR document linked to HCM Link.
The method works only in the context of application authorization. The method is available if the HCM Link integration is available in Bitrix24.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Signing participant identifier. You can retrieve the identifier from the |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":3942,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.hcmlink.document.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type HcmLinkDocument = {
company: string
employee: string
document: {
date: ISODate
name: string
fileUrl: string
fileName: string
uid: string | null
documentUid: string | null
}
}
try {
const response = await $b24.actions.v2.call.make<HcmLinkDocument>({
method: 'sign.b2e.hcmlink.document.get',
params: {
id: 3942,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.company, result.employee, result.document.fileName)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getHcmLinkDocument() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sign.b2e.hcmlink.document.get',
params: {
id: 3942,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.company, result.employee, result.document.fileName)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getHcmLinkDocument)
</script>
try {
$response = $b24Service
->core
->call(
'sign.b2e.hcmlink.document.get',
[
'id' => 3942
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'sign.b2e.hcmlink.document.get',
{
id: 3942
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sign.b2e.hcmlink.document.get',
[
'id' => 3942
]
);
if (isset($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo '<PRE>';
print_r($result['result']);
echo '</PRE>';
}
// client and ctx are already created. See the Go SDK section.
res, err := client.Core().Call(ctx, "sign.b2e.hcmlink.document.get", b24.Params{
"id": 3942,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sign.b2e.hcmlink.document.get: %w", err)
}
var item struct {
Company string `json:"company"`
Employee string `json:"employee"`
Document struct {
FileName string `json:"fileName"`
} `json:"document"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("response parsing: %w", err)
}
fmt.Println(item.Company, item.Employee, item.Document.FileName)
Response Handling
HTTP status: 200
{
"result": {
"company": "acme-hr",
"employee": "EMP-001",
"document": {
"date": "2026-08-07T10:15:30+02:00",
"name": "Employment Contract",
"fileUrl": "https://test.bitrix24.com/rest/download.json?auth=***&token=sign.b2e...",
"fileName": "Employment Contract.pdf",
"uid": "TD-2026-001",
"documentUid": "R-LK-50JI-3AAK-WS1A"
}
},
"time": {
"start": 1786086930.123,
"finish": 1786086930.456,
"duration": 0.333,
"processing": 0.111,
"date_start": "2026-08-07T10:15:30+02:00",
"date_finish": "2026-08-07T10:15:30+02:00",
"operating_reset_at": 1786087530,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Signed document information (detailed description) |
|
time |
Request execution time information |
Object result
|
Name |
Description |
|
company |
HCM Link company code |
|
employee |
HCM Link employee code |
|
document |
Signed document data (detailed description) |
Object document
|
Name |
Description |
|
date |
Document creation date in ISO 8601 format |
|
name |
Document name |
|
fileUrl |
Link for downloading the signed file |
|
fileName |
Signed file name |
|
uid |
Document identifier from HCM Link. Can return |
|
documentUid |
Unique e-Signature for HR document identifier. Can return |
Error Handling
HTTP status: 200, 403
{
"error": "SIGN_HCMLINK_DOCUMENT_NOT_FOUND",
"error_description": "Document not found"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
When It Occurs |
|
|
|
Access denied |
Insufficient permissions |
|
|
|
Current authorization type is denied for this method |
The method was not called in the application context |
|
|
Empty value |
Module humanresources is not available |
The |
|
|
|
Document not found |
The document was not found or is not linked to HCM Link |
|
|
|
No employee or company linked to the document |
No employee or HCM Link company is linked to the document |
|
|
|
Signed file for this document does not exist |
The signed document file was not found |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |