Skip to content

Introduction

The inSigner Cloud API lets you create, send, and manage legally-binding electronic signatures from your applications. It’s a RESTful JSON API secured with API keys.

All API requests use the following base URL:

https://app.insigner.co/api/v1

The API is versioned via the URL path (/v1). Breaking changes are only introduced in new major versions. Non-breaking additions (new fields, new endpoints) may be added to v1 at any time.

ConceptDescription
DocumentA PDF or image that requires signatures. Goes through a lifecycle: draftpendingcompleted.
SignerA person who needs to sign, approve, or view a document. Each signer receives an email with a unique link.
FieldA form element placed on a document page — signatures, text inputs, checkboxes, dates, etc.
TemplateA reusable document blueprint with pre-configured fields and signer slots.
CampaignA public signing link based on a template. Anyone with the link can submit a signed copy.
Bulk SendSend the same template to hundreds of recipients in one API call.
WebhookAn HTTP callback that notifies your server when events occur (e.g. document signed).
draft → pending → completed
declined / cancelled / expired
  1. Draft — Document is created. Add fields, signers, and upload the PDF.
  2. Pending — Document has been sent. Signers receive email notifications.
  3. Completed — All signers have signed. The signed PDF is available for download.

All successful responses return a JSON object with a data key:

{
"data": { ... }
}

List endpoints also include meta for pagination:

{
"data": [ ... ],
"meta": {
"count": 10,
"hasMore": true,
"nextCursor": "clx1abc123"
}
}

Every response includes an X-Request-Id header (e.g. req_abc123...) for debugging and support.