Documenso
Create Documenso v2 envelopes with multipart PDF uploads and typed SignatureKit errors.
Documenso creates a v2 envelope, uploads PDFs as multipart files, and can distribute the envelope when send is enabled.
Installation
npm install @signature-kit/http @signature-kit/documensoWhen to use
Use Documenso when envelope ownership, routing, and recipient actions live in Documenso. Use local signing for in-process PDF/PAdES bytes.
Keep credentials Redacted
Provider tokens enter as Redacted.make(...) and are unwrapped only inside the package HTTP boundary. Never pass remote tokens to React components or logs.
Minimal request
import * as Alchemy from "alchemy"
import { DocumensoSignatureRequest, providers as documensoProviders } from "@signature-kit/documenso"
import { signatureHttpClientLive } from "@signature-kit/http"
import { Effect, Layer, Redacted } from "effect"
export default class Contracts extends Alchemy.Stack<Contracts>()(
"Contracts",
{
providers: Layer.merge(
documensoProviders({
apiKey: Redacted.make(process.env.DOCUMENSO_API_KEY ?? ""),
baseUrl: "https://app.documenso.com/api/v2",
}),
signatureHttpClientLive,
),
state: Alchemy.inMemoryState(),
},
Effect.gen(function* () {
return yield* DocumensoSignatureRequest("service-agreement", {
title: "Service agreement",
message: "Review and sign this document.",
documents: [{ fileName: "contract.pdf", mimeType: "application/pdf", contentBase64: pdfBase64 }],
recipients: [{ name: "Ada Lovelace", email: "ada@example.com", role: "signer" }],
send: true,
})
}),
) {}Provider facts
- Uses the v2 envelope API with multipart file uploads.
send: falsestops after creation and returns a draft request.- Recipient roles and signing order map to Documenso envelope fields.
Errors
Invalid input, remote HTTP failures, and invalid response shapes fail as SignatureKitError. The provider, operation, and HTTP status fields are preserved when the upstream response exposes them.
Related
Clicksign
Assinafy
Remote requests
Wait for a final state
waitForDocumensoSignatureRequest(options, id, pollInterval) reads immediately and polls while the request is draft or sent. It returns the provider's final state, including cancellation, rejection, deletion, or expiry; inspect state before downloading. The interval must be positive and finite. Read failures propagate immediately without automatic retry. Interruption cancels the active read and stops future polls. The caller owns the deadline:
import { waitForDocumensoSignatureRequest } from "@signature-kit/documenso";
import { signatureHttpClientLive } from "@signature-kit/http";
import { Duration, Effect } from "effect";
import type { DocumensoProviderOptions } from "@signature-kit/documenso";
declare const options: DocumensoProviderOptions;
declare const requestId: string;
const program = waitForDocumensoSignatureRequest(options, requestId, Duration.seconds(2)).pipe(
Effect.timeout(Duration.minutes(5)),
Effect.provide(signatureHttpClientLive),
);How is this guide?