POST /v1/envelopes

{
  "template": "tpl_mutual_nda",
  "variables": {
    "client": { "name": "Acme Robotics" }
  },
  "recipients": [
    { "role": "client", "name": "Jane Doe",
      "email": "jane@acme.dev" }
  ],
  "delivery": "embedded"
}

201 env_8Gm2kQ4rT1 · sent → completed · sealed

На входе договоры, на выходе — подписанные.

Bona Fide — электронная подпись в виде API. Превратите шаблон и свои данные в готовый к подписанию конверт, дайте людям подписывать прямо в вашем продукте или на размещённой у нас странице и получите запечатанный PDF, который может проверить кто угодно.

Быстрый старт Справочник API

Как всё устроено

Шаблоны

Загрузите PDF (или файл Word) и расставьте поля либо напишите договор в режиме Document. Переменные описываются JSON Schema, поэтому API проверяет ваши данные до того, как что-либо будет отправлено. Опубликованные версии неизменяемы.

Конверты

Один вызов POST /v1/envelopes формирует документ из шаблона с вашими переменными и запускает маршрутизацию получателям по ролям и порядку. Пробные прогоны, ключи идемпотентности и дедупликация по externalId встроены.

Подписание по-вашему

Ссылки в письмах, размещённая у нас страница или веб-компонент <bf-signing> (с обёртками для React и Vue) прямо в вашем приложении — с короткоживущими одноразовыми сессиями, которые создаёт ваш бэкенд.

Доказательства, которые может проверить любой

Каждый завершённый документ получает метку времени документа PAdES от публичной службы меток времени, а его отпечаток попадает в дерево Merkle, корни которого Bona Fide подписывает ключом Ed25519. Проверить копию может кто угодно, учётная запись не нужна.

Жизненный цикл в одной схеме

Создайте шаблон в панели управления или через API, затем опубликуйте версию.
Отправьте конверт: POST /v1/envelopes с идентификатором шаблона, вашими переменными и одним получателем на каждую роль.
Подпишите: получатели получают ссылку по электронной почте, или вы создаёте сессию подписания и встраиваете её (delivery: "embedded").
Завершите: когда подписывает последний получатель, вы получаете вебхук envelope.completed со всеми введёнными значениями.
Запечатайте: запечатанный PDF (с сертификатом о завершении) готов, когда приходит envelope.sealed.
Проверьте: любой может перетащить PDF на страницу проверки или вызвать публичный API проверки.

Почему с API приятно работать

Ошибки, с которыми можно что-то сделать. Каждая ошибка возвращается в формате RFC 9457 problem+json; ошибки валидации содержат JSON Pointer для каждой проблемы, например /variables/client/email.
Безопасные повторы. Передавайте Idempotency-Key в POST-запросах, и повторный запрос вернёт первый ответ.
Бесплатный безлимитный тестовый режим. Ключи bf_test_ создают конверты с водяным знаком, за которые никогда не взимается плата. См. Аутентификация.
Вебхуки по стандарту. Доставки подписываются по спецификации Standard Webhooks, повторяются в течение трёх дней, и их можно отправить повторно.
OpenAPI 3.1, сгенерированный из кода. Справочник и загружаемые openapi.json / openapi.yaml строятся из тех же контрактов zod, по которым API проверяет запросы.

Что дальше

Быстрый стартКлюч API, конверт из шаблона, подписание и вебхук о завершении за десять минут.

Основные понятияШаблоны, роли, поля, конверты, получатели, сессии и организации.

Встроенное подписаниеВстройте подписание в свой продукт с помощью .

ПроверкаКак работают запечатывание и привязка к якорям и как проверить документ самостоятельно.

API доступен по адресу https://api.bonafidesign.com. Все пути в этой документации указаны относительно него.