For AI agents: markdown of this page — /docs-content-en/sign-b2e.md documentation index — /llms.txt

Employee signatures

Work with Bitrix24 HR e-signature templates, legal profiles, documents and providers.

Scope: sign.b2e | Base URL: https://vibecode.bitrix24.com/v1 | Authentication: X-Api-Key

Before you start

Company keys are not supported. Use a personal key or an application key.

A scope does not replace user permissions. crm is additionally required for templates and bundles, sign.b2e.document.get, sign.b2e.document.send and sign.b2e.company.provider.list. Updating a legal profile requires user.

humanresources.hcmlink is required only for the HCM parameters of sign.b2e.document.send and sign.b2e.company.provider.list. Reading an HCM document requires sign.b2e and an administrator OAuth context, with no additional HCM scope.

External signature providers, personal signed documents, the company safe and HCM Link documents require OAuth. For an incoming webhook, these seven operations return 422 BITRIX_ERROR with the native WRONG_AUTH_TYPE code in error.b24Code.

GET /v1/sign-b2e/company-providers requires a READWRITE key: Bitrix24 can register the company with a provider. A READONLY key is rejected before Bitrix24 is called.

A document UID, a template UID, a company provider UID and a numeric external provider ID are different identifiers. Sending has legal consequences; there are no automatic retries. Responses with credential-bearing links are redacted, and the paths of the replaced values are listed in meta.redacted. Do not use such responses as the source configuration for writing back.

Endpoint reference

Method Path Description Bitrix24 method
MethodGET Path/v1/sign-b2e/legal-fields DescriptionList legal fields Bitrix24 methodsign.b2e.legal.field.list
MethodPATCH Path/v1/sign-b2e/legal-profiles/:userId DescriptionUpdate a legal profile Bitrix24 methodsign.b2e.legal.profile.update
MethodGET Path/v1/sign-b2e/templates DescriptionList templates Bitrix24 methodsign.b2e.template.list
MethodPOST Path/v1/sign-b2e/templates/send DescriptionSend a document from a template Bitrix24 methodsign.b2e.template.send
MethodPOST Path/v1/sign-b2e/template-folders/tail DescriptionList template bundles Bitrix24 methodsign.b2e.template.folder.tail
MethodGET Path/v1/sign-b2e/template-folders/:id DescriptionGet a template bundle Bitrix24 methodsign.b2e.template.folder.get
MethodGET Path/v1/sign-b2e/documents/:uid DescriptionGet a document Bitrix24 methodsign.b2e.document.get
MethodPOST Path/v1/sign-b2e/documents/send DescriptionSend a file for signature Bitrix24 methodsign.b2e.document.send
MethodGET Path/v1/sign-b2e/company-providers DescriptionList company providers Bitrix24 methodsign.b2e.company.provider.list
MethodGET Path/v1/sign-b2e/hcmlink/documents/:id DescriptionGet an HCM Link HR document Bitrix24 methodsign.b2e.hcmlink.document.get
MethodGET Path/v1/sign-b2e/personal-documents DescriptionPersonal signed documents Bitrix24 methodsign.b2e.personal.tail
MethodGET Path/v1/sign-b2e/company-safe-documents DescriptionCompany safe documents Bitrix24 methodsign.b2e.mysafe.tail
MethodGET Path/v1/sign-b2e/providers DescriptionList external providers Bitrix24 methodsign.b2e.provider.tail
MethodPOST Path/v1/sign-b2e/providers DescriptionAdd an external provider Bitrix24 methodsign.b2e.provider.add
MethodPATCH Path/v1/sign-b2e/providers/:id DescriptionUpdate an external provider Bitrix24 methodsign.b2e.provider.update
MethodDELETE Path/v1/sign-b2e/providers/:id DescriptionDelete an external provider Bitrix24 methodsign.b2e.provider.delete

Quick start

Get the available templates:

Terminal
curl 'https://vibecode.bitrix24.com/v1/sign-b2e/templates?limit=2' \
  -H 'X-Api-Key: YOUR_API_KEY'

Complete example

Read the first page of bundles, then the details of the first bundle found. The key needs sign.b2e and crm.

javascript
const base = 'https://vibecode.bitrix24.com/v1/sign-b2e';
const headers = { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' };
const pageResponse = await fetch(base + '/template-folders/tail', { method: 'POST', headers, body: '{}' });
const page = await pageResponse.json();
if (!pageResponse.ok || !page.success) throw new Error(page.error?.message);
if (page.data.length) {
  const response = await fetch(base + '/template-folders/' + encodeURIComponent(page.data[0].id), { headers });
  const bundle = await response.json();
  if (!response.ok || !bundle.success) throw new Error(bundle.error?.message);
  console.log(bundle.data);
}
console.log(page.meta.hasMore, page.meta.cursor);

Error codes

Code Reason
CodeSCOPE_DENIED ReasonThe key lacks a required scope.
CodeMETHOD_NOT_YET_AVAILABLE ReasonThe six template and legal profile operations require sign 26.1300.0; the release is given in error.release. The classic methods carry no such marker.
CodeSIGN_B2E_TEMPLATE_FOLDER_NOT_FOUND ReasonThe bundle is missing or unavailable for sending. The native code is preserved in error.code and error.b24Code.
CodeENTITY_NOT_FOUND ReasonBitrix24 returned a generic NOT_FOUND refusal. The native code is in error.b24Code.

Common API errors.

See also