[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-sign-b2e\u002Fcreate-provider":3,"docs-tabs-sign-b2e\u002Fcreate-provider":6},{"content":4,"lastmod":5},"# Add an external provider\n\n`POST \u002Fv1\u002Fsign-b2e\u002Fproviders`\n\nRegisters an external signature provider. Can be called by an administrator via OAuth.\n\n**Scopes:** `sign.b2e`.\n\nAvailable only to an OAuth application key with a user session. An incoming webhook receives `422 BITRIX_ERROR` with the native `WRONG_AUTH_TYPE` code in `error.b24Code`.\n\n## Request body fields\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| `fields` | object | yes | External provider fields; values are passed to Bitrix24. |\n| `fields.title` | string \\| null | no | Provider name. The field accepts null; on update, passing null or omitting the field keeps the previous value. |\n| `fields.description` | string \\| null | no | Provider description. The field accepts null; on update, passing null or omitting the field keeps the previous value. |\n| `fields.iconUri` | string \\| null | no | Provider icon URL. The field accepts null; on update, passing null or omitting the field keeps the previous value. |\n| `fields.companyRegUri` | string \\| null | no | Company registration URL; optional on create. The field accepts null; on update, passing null or omitting the field keeps the previous value. |\n| `fields.documentSignUri` | string \\| null | no | Document signing URL. The field accepts null; on update, passing null or omitting the field keeps the previous value. |\n| `fields.publicKeyUri` | string \\| null | no | Provider public key URL. The field accepts null; on update, passing null or omitting the field keeps the previous value. |\n\n## Examples\n\n### curl — OAuth application\n\n```bash\ncurl -X POST 'https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsign-b2e\u002Fproviders' \\\n  -H 'X-Api-Key: YOUR_APP_KEY' \\\n  -H 'Authorization: Bearer USER_SESSION_TOKEN' \\\n  -H 'Content-Type: application\u002Fjson' \\\n  -d '{\"fields\": {\"title\": \"VIBE-PROBE\", \"description\": \"VIBE-PROBE test provider\", \"iconUri\": \"https:\u002F\u002Fexample.com\u002Ficon.png\", \"documentSignUri\": \"https:\u002F\u002Fexample.com\u002Fsign\", \"publicKeyUri\": \"https:\u002F\u002Fexample.com\u002Fpublic-key\"}}'\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst response = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsign-b2e\u002Fproviders', {\n  \"method\": \"POST\",\n  \"headers\": {\n    \"X-Api-Key\": \"YOUR_APP_KEY\",\n    \"Authorization\": \"Bearer USER_SESSION_TOKEN\",\n    \"Content-Type\": \"application\u002Fjson\"\n  },\n  body: JSON.stringify({\"fields\": {\"title\": \"VIBE-PROBE\", \"description\": \"VIBE-PROBE test provider\", \"iconUri\": \"https:\u002F\u002Fexample.com\u002Ficon.png\", \"documentSignUri\": \"https:\u002F\u002Fexample.com\u002Fsign\", \"publicKeyUri\": \"https:\u002F\u002Fexample.com\u002Fpublic-key\"}})\n});\nconst result = await response.json();\nif (!response.ok || !result.success) throw new Error(result.error?.message);\nconsole.log(result.data);\n```\n\n## Response fields\n\n| Field | Type | Description |\n|---|---|---|\n| `success` | boolean | Whether the request succeeded. |\n| `data` | object | Operation data. |\n| `data.id` | integer | Object ID. |\n| `meta.redacted` | array\u003Cstring> | Present when credentials are hidden; contains the paths of the replaced values. |\n\n## Response example\n\nShape of a successful response; the data depends on the Bitrix24 account and the request.\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 7\n  }\n}\n```\n\n## Error response example\n\n403 — the key lacks a required scope:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"SCOPE_DENIED\",\n    \"message\": \"This endpoint requires 'sign.b2e' scope\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Reason |\n|---|---|---|\n| 400 | `INVALID_PARAMS` | Invalid request shape: types, required fields or an unknown query string parameter. |\n| 401 | `TOKEN_MISSING` | No credentials for the Bitrix24 connection. |\n| 403 | `SCOPE_DENIED` | One of the required scopes is not granted. |\n| 422 | `BITRIX_ERROR` | Bitrix24 rejected the operation; the code is in error.b24Code, the text in error.message. |\n| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only. |\n| 422 | `BITRIX_ERROR` | An incoming webhook was used instead of OAuth. The native `WRONG_AUTH_TYPE` code is in `error.b24Code`. |\n\n[Common API errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\nBitrix24 checks user permissions, HR e-signature availability, business rules, page sizes and field contents. Values are passed through without local correction. Response text is JSON-encoded; credential-bearing links are hidden.\n\nThe operation is not retried automatically. If the outcome is unknown, check the state in the Bitrix24 account first; a repeated call can perform the operation again.\n\n## See also\n\n- [Employee signatures](\u002Fdocs\u002Fsign-b2e)\n- [API errors](\u002Fdocs\u002Ferrors)\n","2026-11-18",{},1795344083868]