e-Signature: Overview of Methods

Bitrix24 e-Signature allows you to sign HR documents with employees using a digital signature. This signature is equivalent to a handwritten one and complies with legal requirements.

Quick navigation: all methods and events

User documentation:

• Bitrix24 e-Signature for HR: service for signing HR documents
• Configure access permissions to e-Signature for HR

The sign.b2e.* methods work with documents in e-Signature. Use them to send a document for signing, retrieve document data, retrieve a list of signing providers, and retrieve lists of signed documents.

The humanresources.hcmlink.* methods manage e-Signature integration data with HR systems through HCM Link: companies, employees, mappings, and field values.

These methods can only be executed in the context of authorization of the application.

How to Select a Method GroupHow to Select a Method Group

If You Need To	Use
Send documents for signing and retrieve signing information	sign.b2e.* methods
Track changes in document and signing participant statuses	OnSignB2e* events
Transfer data from an HR system to fill e-Signature documents	humanresources.hcmlink.* methods

Link to Other ObjectsLink to Other Objects

CRM company. The e-Signature document is sent on behalf of a company. In the sign.b2e.document.send and sign.b2e.company.provider.list methods, you can specify the company using company.crmId or companyCrmId. This is the identifier of the CRM company connected as "my company". You can retrieve it using the crm.item.list method with the entityTypeId = 4 parameter and the isMyCompany = Y filter.

Employee and user. Signing participants and the responsible person are linked to Bitrix24 users through userId. If the company is connected to HCM Link, you can pass the employee's employeeId or employeeCode from the HR system instead of userId.

HCM Link. The integration with HR systems transfers companies, employees, and field values for e-Signature documents. If a document is sent using HCM Link data, the sign.b2e.* methods are linked to the humanresources.hcmlink.* methods.

Document file. The sign.b2e.document.send method accepts a PDF file in the files[].fileContent parameter, encoded in Base64. After signing, the file can be retrieved from the user's signed document lists or from the company safe.

Signing statuses. The OnSignB2eDocumentStatusChanged and OnSignB2eMemberStatusChanged events report changes in document and participant statuses. Document details can be retrieved using the sign.b2e.document.get method by uid.

Scope FeaturesScope Features

sign.b2e — used in methods for working with e-Signature documents and signing events.

crm — used in the methods:

• sign.b2e.document.send
• sign.b2e.document.get
• sign.b2e.company.provider.list

humanresources.hcmlink — used:

• in sign.b2e.document.send and sign.b2e.company.provider.list if the application passes HCM Link data: company.uuid, members.employeeCode, members.employeeId, responsible.employeeCode, responsible.employeeId, companyUuid
• in e-Signature integration methods with HR systems. The detailed scenario is described in e-Signature Integration with HR Systems

Overview of Methods and EventsOverview of Methods and Events

e-Signature Documentse-Signature Documents

Scope: sign.b2e

Who can execute the method: depends on the method

Integration with HR SystemsIntegration with HR Systems

Scope: humanresources.hcmlink

Who can execute the method: depends on the method

Method	Description
humanresources.hcmlink.company.add	Adds a company from an HR system
humanresources.hcmlink.company.update	Updates a company from an HR system and the list of its fields
humanresources.hcmlink.company.list	Retrieves a list of companies from an HR system
humanresources.hcmlink.company.user.list	Retrieves companies from an HR system linked to the current user
humanresources.hcmlink.company.delete	Deletes a company from the HCM Link integration
humanresources.hcmlink.employee.set	Transfers a list of employees from an HR system
humanresources.hcmlink.employee.list	Retrieves a list of mapped employees from the HR system and Bitrix24
humanresources.hcmlink.field.value.set	Transfers HR system field values for employees
humanresources.hcmlink.job.update	Updates a synchronization job
humanresources.hcmlink.job.status.get	Checks whether a synchronization job is active