Skip to content

API reference ​

Codevibe Sign is split into small packages with one job each. Use the whole service, or only the parts you need.

PackageWhat it doesStatus
@codevibe_technology/sign-coreDomain rules: envelopes, routing, reminders, expiry, the audit chain, tokens, OTPs.Ready to try
@codevibe_technology/sign-pdfDraws field values, appends the certificate page, seals and verifies PDFs.Ready to try
@codevibe_technology/sign-serverHTTP API and runtime, with adapters for storage, files, mail and OTP.Ready to try
@codevibe_technology/sign-reactSignature pad, signing view and field placement components.Ready to try
@codevibe_technology/sign-aadhaarAadhaar eSign through a licensed eSign provider, with your own account.Ready to try

For the HTTP API itself, with every route, schema and error code, see the HTTP API reference, which you can try against your own server.

All packages are pre-release (0.0.0) and their APIs may change before 0.1.

Conventions ​

  • TypeScript, strict, ESM first, with CommonJS builds and type declarations. Node 20 or later.
  • Each package's public API is exported only from its entry point.
  • Errors are SignError instances with a stable code, never bare strings. See the error codes.

Dependencies ​

PackageDepends on
sign-corenothing at runtime
sign-pdfpdf-lib, @signpdf/*, node-forge
sign-servercore, pdf, hono, nodemailer, postgres
sign-reactcore; react, react-dom and pdfjs-dist as peers
sign-aadhaarcore

Libraries under Apache-2.0, server and apps under AGPL-3.0. "Codevibe", "Codevibe Sign" and "Hrvibe" are trademarks of Codevibe Technology and are not covered by the licences.