Get the List of Signing Providers sign.b2e.provider.tail
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.tail returns the list of external signing providers connected to Bitrix24.
The method works only in the context of the application authorization.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
limit |
Number of records per page. The parameter accepts values from 1 to 1000. If the value is out of range, the method uses the default value. Defaults to 20 |
|
offset |
Number of records to skip from the beginning of the list. Used for pagination together with Defaults to 0 |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"limit":10,"offset":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.provider.tail
// 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
type ProviderItem = {
id: number
title: string
description: string
iconUri: string
companyRegUri: string
documentSignUri: string
publicKeyUri: string
}
// On a sign service failure result holds error and error_description instead of the list
type ProviderTailResult = ProviderItem[] | { error: number, error_description: string }
try {
// The method pages with limit and offset, not with start,
// so the SDK list helpers do not apply: request the next page with a new offset
const response = await $b24.actions.v2.call.make<ProviderTailResult>({
method: 'sign.b2e.provider.tail',
params: {
limit: 10,
offset: 0,
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
if (Array.isArray(result)) {
result.forEach(provider => console.info(provider.id, provider.title))
} 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 fetchSignProviders() {
try {
const $b24 = await B24Js.initializeB24Frame()
// The method pages with limit and offset, not with start,
// so the SDK list helpers do not apply: request the next page with a new offset
const response = await $b24.actions.v2.call.make({
method: 'sign.b2e.provider.tail',
params: {
limit: 10,
offset: 0
},
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 list
const result = response.getData().result
if (Array.isArray(result)) {
result.forEach(provider => console.info(provider.id, provider.title))
} else {
console.error(result.error_description)
}
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchSignProviders)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.call(
"sign.b2e.provider.tail",
{
"limit": 10,
"offset": 0,
},
).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:
for provider in result:
print(provider["id"], provider["title"])
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.tail',
[
'limit' => 10,
'offset' => 0
]
);
$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.tail',
{
limit: 10,
offset: 0
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sign.b2e.provider.tail',
[
'limit' => 10,
'offset' => 0
]
);
if (isset($result['error'])) {
echo 'Error: ' . $result['error_description'];
} elseif (isset($result['result']['error_description'])) {
echo 'Sign service error: ' . $result['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.provider.tail", b24.Params{
"limit": 10,
"offset": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sign.b2e.provider.tail: %w", err)
}
var items []struct {
ID int `json:"id"`
Title string `json:"title"`
Description string `json:"description"`
IconURI string `json:"iconUri"`
CompanyRegURI string `json:"companyRegUri"`
DocumentSignURI string `json:"documentSignUri"`
PublicKeyURI string `json:"publicKeyUri"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
// on a sign service failure result holds error and error_description
return fmt.Errorf("sign service response: %s", res.Result)
}
for _, it := range items {
fmt.Println(it.ID, it.Title)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"id": 41,
"title": "Docs check provider",
"description": "Provider for documentation check",
"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"
},
{
"id": 43,
"title": "Docs check provider",
"description": "Provider for documentation check",
"iconUri": "https://provider.sign.com/bitrix/icon.png",
"companyRegUri": "",
"documentSignUri": "https://provider.sign.com/bitrix/sign/",
"publicKeyUri": "https://provider.sign.com/bitrix/public.key"
}
],
"time": {
"start": 1792738605,
"finish": 1792738605.693056,
"duration": 0.6930561065673828,
"processing": 0,
"date_start": "2026-10-23T09:56:45+03:00",
"date_finish": "2026-10-23T09:56:45+03:00",
"operating_reset_at": 1792739160,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
List of external signing providers (detailed description). Deleted providers are not included in the list. If there are no providers, an empty array is returned |
|
time |
Information about the request execution time |
Element of the result array
|
Name |
Description |
|
id |
Provider identifier |
|
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. If the address is not set, an empty string is returned |
|
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 |
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 |
If the Bitrix24 sign service returns an error without its own code, the method responds with HTTP status 200, and result contains an object with the error and error_description fields instead of an array. Make sure result is an array before iterating over the providers.
{
"result": {
"error": 0,
"error_description": "Cannot perform action. Please try again later (error code: SIGN_CLIENT_CONNECTION_ERROR)."
},
"time": {
"start": 1792738605,
"finish": 1792738605.693056,
"duration": 0.6930561065673828,
"processing": 0,
"date_start": "2026-10-23T09:56:45+03:00",
"date_finish": "2026-10-23T09:56:45+03:00",
"operating_reset_at": 1792739160,
"operating": 0
}
}
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 |
|
|
Sign service code |
Sign service error text |
The sign service did not retrieve the list and returned its own error code |
|
|
|
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 |