Overview

• Real sends. contracts.create sends the sign request to every signer by email or SMS. Pass save_as_draft: 'yes' to create the contract without sending, then contracts.sendDraft when it is ready.
• Demo contracts. Pass test: 'yes' to mark a contract as a demo; demo contracts are not charged sending credits.
• metadata is a string. It is echoed in the contract payload and in webhook events, so a single string is what you get back, not a JSON object.
• PDF URLs expire. contract_pdf_url on a signed contract is kept for 3 days after each request that returns it; request the contract again for a fresh URL.
• Withdrawing. contracts.withdraw stops a sent contract from being signed. Signed contracts cannot be withdrawn, and a withdrawn contract stays withdrawn.
• Signers. contracts.addSigner joins a signer to a contract but sends nothing; contracts.resendToSigner sends the sign request. Both need the signer’s id from the contract’s signers (add returns no signer object, so re-read the contract).
• Rate limits. eSignatures applies adaptive rate limits and warns that frequent polling of contracts.get can lead to blocked requests. The plugin backs off and retries a 429 up to three times, honoring Retry-After when present. Prefer webhooks for status changes.
• Webhooks. The plugin does not receive webhooks; eSignatures sends them to the HTTPS endpoint configured on the same API panel.

• 12 typed API operations

​

Setup

npm install corsair @corsair-dev/esignatures

yarn add corsair @corsair-dev/esignatures

pnpm install corsair @corsair-dev/esignatures

bun add corsair @corsair-dev/esignatures

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { esignatures } from '@corsair-dev/esignatures';

export const corsair = createCorsair({
	plugins: [
		esignatures(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

esignatures()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'esignatures',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.esignatures.api.contracts.get({ contract_id: '1contr11-2222' });

const tenant = corsair.withTenant('acme');
await tenant.esignatures.api.contracts.create({
	template_id: '4templ44-8888',
	signers: [{ name: 'Sam Signer', email: 'sam@tenants.com' }],
	placeholder_fields: [{ placeholder_key: 'tenant_name', replace_with_text: 'Sam Signer' }],
});

​

What’s next