Entran contratos, salen firmados.

Cómo encaja todo

Plantillas

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

Sobres

Una sola llamada a POST /v1/envelopes genera una plantilla con sus variables y empieza a dirigirla a los destinatarios según su rol y su orden. Las simulaciones, las claves de idempotencia y la eliminación de duplicados por externalId vienen de serie.

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 que genera su backend.

Pruebas 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 añade a un árbol de Merkle cuyas raíces firma Bona Fide con Ed25519. Cualquiera puede verificar una copia sin necesidad de tener una cuenta.

El ciclo de vida, de un vistazo

1. Diseñe una plantilla en el panel o a través de la API y, después, publique una versión.
2. Envíe un sobre: POST /v1/envelopes con el ID de la plantilla, sus variables y un destinatario por rol.
3. Firme: los destinatarios reciben un enlace por correo electrónico, o bien usted genera una sesión de firma y la integra (delivery: "embedded").
4. Complete: cuando firma el último destinatario, recibe un webhook envelope.completed con todos los valores introducidos.
5. Selle: el PDF sellado (con su certificado de finalización) está listo cuando llega envelope.sealed.
6. Verifique: cualquiera puede arrastrar el PDF a la página de verificación o llamar a la API pública de verificación.

Por qué resulta cómodo trabajar con la API

• Errores que le dicen qué hacer. Todos los errores son 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 peticiones POST y un reintento devolverá de nuevo 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 conforme a 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.

Siguientes 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 usted mismo.

La API se encuentra en https://api.bonafidesign.com. Todas las rutas de esta documentación son relativas a esa dirección.