Skip to main content

Node.js client

npm install @16it/autosignly

Versions: the supported line is 1.0.*. The newest release of each package is listed among the tags in the repository.

Node 20 or newer, TypeScript types included, zero runtime dependencies.

Example​

import { AutosignlyClient } from "@16it/autosignly";
import { readFile } from "node:fs/promises";

const client = new AutosignlyClient(process.env.AUTOSIGNLY_API_KEY!, process.env.AUTOSIGNLY_API_SECRET!);

const documentId = await client.uploadAndSign({
  pdf: await readFile("contract.pdf"),
  documentName: "Consulting document",
  signers: [{ firstName: "Anna", lastName: "Nowak", email: "[email protected]", country: "PL" }],
});

What it covers​

Everything the API exposes: credentials, listing and filtering documents (by status and by tag), reading one document, uploading a PDF with or without sending it, attachments, sending for signature, downloading the file, tags, parties — plus webhook signature verification and an async iterator that walks large listings page by page.

Failures arrive as typed errors (NotFoundError, RateLimitError, ConnectionError, …), and reads are retried with backoff, so a hiccup on the network does not become an outage in your code.

How it is tested​

The repository carries two suites, and npm test runs both:

  • Unit tests against a stubbed fetch — headers, multipart framing, retries, error mapping
  • Contract tests that check every field name the client reads or sends against the published OpenAPI specification, so a client that drifts from the API fails on its own

Separately, an internal end-to-end suite walks the whole journey against a live environment: it creates a company, uploads a PDF, attaches files, sends the document for signature, signs it as the recipient and verifies the sealed document that comes back.