Add a Signing Provider sign.b2e.provider.add
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 method sign.b2e.provider.add connects an external signing provider to Bitrix24.
The method works only in the context of the application authorization.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object with the fields of the new provider. Field description |
Parameter fields
Pass full addresses with the http or https scheme. Required fields cannot be empty strings.
|
Name |
Description |
|
title* |
Provider name |
|
description* |
Short description of the provider |
|
iconUri* |
Address of the provider icon for the Bitrix24 interface |
|
companyRegUri |
Address of the page where a company registers with the provider |
|
documentSignUri* |
Address of the provider's document signing page |
|
publicKeyUri* |
Address of the provider's public key. The key is used to verify document signatures |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"Test provider name","description":"Brief text about provider","iconUri":"https://provider.sign.com/bitrix/icon.png","companyRegUri":"https://provider.sign.com/bitrix/register/","documentSignUri":"https://provider.sign.com/bitrix/sign/","publicKeyUri":"https://provider.sign.com/bitrix/public.key"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.provider.add
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// On a sign service failure result holds error and error_description instead of the id
type ProviderAddResult = number | { error: number, error_description: string }
try {
const response = await $b24.actions.v2.call.make<ProviderAddResult>({
method: 'sign.b2e.provider.add',
params: {
fields: {
title: 'Test provider name',
description: 'Brief text about provider',
iconUri: 'https://provider.sign.com/bitrix/icon.png',
companyRegUri: 'https://provider.sign.com/bitrix/register/',
documentSignUri: 'https://provider.sign.com/bitrix/sign/',
publicKeyUri: 'https://provider.sign.com/bitrix/public.key',
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
if (typeof result === 'number') {
console.info('Provider id:', result)
} else {
console.error(result.error_description)
}
}
} 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 addSignProvider() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sign.b2e.provider.add',
params: {
fields: {
title: 'Test provider name',
description: 'Brief text about provider',
iconUri: 'https://provider.sign.com/bitrix/icon.png',
companyRegUri: 'https://provider.sign.com/bitrix/register/',
documentSignUri: 'https://provider.sign.com/bitrix/sign/',
publicKeyUri: 'https://provider.sign.com/bitrix/public.key'
}
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
// On a sign service failure result holds error and error_description instead of the id
const result = response.getData().result
if (typeof result === 'number') {
console.info('Provider id:', result)
} else {
console.error(result.error_description)
}
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addSignProvider)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.call(
"sign.b2e.provider.add",
{
"fields": {
"title": "Test provider name",
"description": "Brief text about provider",
"iconUri": "https://provider.sign.com/bitrix/icon.png",
"companyRegUri": "https://provider.sign.com/bitrix/register/",
"documentSignUri": "https://provider.sign.com/bitrix/sign/",
"publicKeyUri": "https://provider.sign.com/bitrix/public.key",
},
},
).response
result = bitrix_response.result
# On a sign service failure result holds error and error_description
if isinstance(result, dict):
print(f"Sign service error: {result['error_description']}")
else:
print(f"Provider ID: {result}")
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'sign.b2e.provider.add',
[
'fields' => [
'title' => 'Test provider name',
'description' => 'Brief text about provider',
'iconUri' => 'https://provider.sign.com/bitrix/icon.png',
'companyRegUri' => 'https://provider.sign.com/bitrix/register/',
'documentSignUri' => 'https://provider.sign.com/bitrix/sign/',
'publicKeyUri' => 'https://provider.sign.com/bitrix/public.key'
]
]
);
$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.provider.add',
{
fields: {
title: 'Test provider name',
description: 'Brief text about provider',
iconUri: 'https://provider.sign.com/bitrix/icon.png',
companyRegUri: 'https://provider.sign.com/bitrix/register/',
documentSignUri: 'https://provider.sign.com/bitrix/sign/',
publicKeyUri: 'https://provider.sign.com/bitrix/public.key'
}
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sign.b2e.provider.add',
[
'fields' => [
'title' => 'Test provider name',
'description' => 'Brief text about provider',
'iconUri' => 'https://provider.sign.com/bitrix/icon.png',
'companyRegUri' => 'https://provider.sign.com/bitrix/register/',
'documentSignUri' => 'https://provider.sign.com/bitrix/sign/',
'publicKeyUri' => 'https://provider.sign.com/bitrix/public.key'
]
]
);
if (isset($result['error'])) {
echo 'Error: ' . $result['error_description'];
} elseif (is_array($result['result'])) {
echo 'Sign service error: ' . $result['result']['error_description'];
} else {
echo 'Provider ID: ' . $result['result'];
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sign.b2e.provider.add", b24.Params{
"fields": b24.Params{
"title": "Test provider name",
"description": "Brief text about provider",
"iconUri": "https://provider.sign.com/bitrix/icon.png",
"companyRegUri": "https://provider.sign.com/bitrix/register/",
"documentSignUri": "https://provider.sign.com/bitrix/sign/",
"publicKeyUri": "https://provider.sign.com/bitrix/public.key",
},
})
if err != nil {
return fmt.Errorf("sign.b2e.provider.add: %w", err)
}
var id int
if err := json.Unmarshal(res.Result, &id); err != nil {
// on a sign service failure result holds error and error_description
return fmt.Errorf("sign service response: %s", res.Result)
}
fmt.Println("provider ID:", id)
Response Handling
HTTP Status: 200
{
"result": 41,
"time": {
"start": 1792738603,
"finish": 1792738603.104434,
"duration": 0.10443401336669922,
"processing": 0,
"date_start": "2026-10-23T09:56:43+03:00",
"date_finish": "2026-10-23T09:56:43+03:00",
"operating_reset_at": 1792739160,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the added provider. Required for the sign.b2e.provider.update and sign.b2e.provider.delete methods |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 403
{
"error": "WRONG_AUTH_TYPE",
"error_description": "Current authorization type is denied for this method Application context required"
}
|
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 |
Errors of the Bitrix24 sign service are returned with HTTP status 200 in one of two forms.
If an error has a code, the response contains error and error_description at the top level, like a regular method error. Validation errors for the name and addresses are returned this way:
{
"error": 100,
"error_description": "PublicKeyUri must be valid",
"ex": {
"status": 200,
"ex": 100
}
}
If an error has no code, result contains an object with the error and error_description fields instead of the identifier. Check the type of result before using the value as an identifier:
{
"result": {
"error": 0,
"error_description": "The field Description is required."
},
"time": {
"start": 1792738603,
"finish": 1792738603.104434,
"duration": 0.10443401336669922,
"processing": 0,
"date_start": "2026-10-23T09:56:43+03:00",
"date_finish": "2026-10-23T09:56:43+03:00",
"operating_reset_at": 1792739160,
"operating": 0
}
}
If the error text contains the code SIGN_CLIENT_CONNECTION_ERROR, INCORRECT_JSON, INCORRECT_HTTP_STATUS, INCORRECT_DATA, or INCORRECT_REGISTER_RESPONSE, Bitrix24 did not receive a response from the service. The provider may have been added anyway. Before calling the method again, check the list of providers with the sign.b2e.provider.tail method.
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Current authorization type is denied for this method Application context required |
The method was called outside an application with OAuth authorization, for example, through a webhook |
|
|
|
Access denied! Access denied |
The user is not an administrator, or e-Signature for HR is not available on Bitrix24 |
|
|
|
Access denied! User authorization required |
The request was made without user authorization |
|
|
|
Title must be provided |
The |
|
|
|
IconUri must be valid |
The |
|
|
|
CompanyRegUri must be empty be valid |
The |
|
|
|
DocumentSignUri must be valid |
The |
|
|
|
PublicKeyUri must be valid |
The |
|
|
|
Cannot perform action. Please try again later (error code: 100). |
A required field is missing: |
|
|
|
The field Description is required. |
The |
|
|
|
Cannot perform action. Please try again later (error code: #CODE#). |
The sign service returned an error, or Bitrix24 did not receive its response. |
|
|
|
This action is not available yet, please try again later. |
The sign service version does not support this action yet |
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 |