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

Entran contratos, salen firmados.

Bona Fide es la firma electrónica como API. Convierta una plantilla y sus datos en un sobre listo para firmar, permita que las personas firmen dentro de su producto o en una página alojada y reciba un PDF sellado que cualquiera puede verificar.

Inicio rápido Referencia de la API

Cómo encaja todo

Plantillas

Suba un PDF (o un archivo de Word) y coloque campos, o redacte el contrato en el modo Documento. Las variables son un JSON Schema, así que la API valida sus datos antes de enviar nada. Las versiones son inmutables una vez publicadas.

Sobres

Un solo POST /v1/envelopes genera una plantilla con sus variables y comienza a enviarla a los destinatarios según su rol y orden. Las simulaciones, las claves de idempotencia y la deduplicación por externalId vienen incluidas.

La firma, a su manera

Enlaces por correo electrónico, una página alojada o el componente web <bf-signing> (con wrappers para React y Vue) dentro de su propia aplicación, con sesiones de corta duración y de un solo uso generadas por su backend.

Evidencia que cualquiera puede comprobar

Cada documento completado recibe un sello de tiempo de documento PAdES de una autoridad de sellado de tiempo pública, y su huella digital se agrega a un árbol de Merkle cuyas raíces Bona Fide firma con Ed25519. Cualquiera puede verificar una copia, sin necesidad de una cuenta.

El ciclo de vida en una imagen

Diseñe una plantilla en el panel o mediante la API y, luego, publique una versión.
Envíe un sobre: POST /v1/envelopes con el ID de la plantilla, sus variables y un destinatario por rol.
Firme: los destinatarios reciben un enlace por correo electrónico, o usted genera una sesión de firma y la integra (delivery: "embedded").
Complete: cuando firma el último destinatario, usted recibe un webhook envelope.completed con cada valor ingresado.
Selle: el PDF sellado (con su certificado de finalización) está listo cuando llega envelope.sealed.
Verifique: cualquiera puede soltar el PDF en la página de verificación o llamar a la API pública de verificación.

Lo que hace agradable a la API

Errores con los que puede actuar. Cada error es RFC 9457 problem+json; los errores de validación incluyen un JSON Pointer por problema, como /variables/client/email.
Reintentos seguros. Envíe una Idempotency-Key en las solicitudes POST y un reintento reproduce la primera respuesta.
Modo de prueba gratuito e ilimitado. Las claves bf_test_ crean sobres con marca de agua que nunca se facturan. Consulte Autenticación.
Webhooks que siguen un estándar. Las entregas se firman según Standard Webhooks, se reintentan durante tres días y se pueden volver a enviar.
OpenAPI 3.1, generado a partir del código. La referencia y los archivos descargables openapi.json / openapi.yaml se generan a partir de los mismos contratos de zod con los que valida la API.

Próximos pasos

Inicio rápidoClave de API, sobre a partir de una plantilla, firma y webhook de finalización en diez minutos.

ConceptosPlantillas, roles, campos, sobres, destinatarios, sesiones y organizaciones.

Firma integradaIntegre la experiencia de firma en su producto con .

VerificaciónCómo funcionan el sellado y el anclaje, y cómo comprobar un documento por su cuenta.

La API está disponible en https://api.bonafidesign.com. Todas las rutas de esta documentación son relativas a esa URL.