Inspakt API

The Inspakt API lets you programmatically manage the full document signing lifecycle — from creating envelopes and uploading documents, to assigning recipients, placing fields, and collecting signatures.

All API endpoints are scoped to your workspace and secured with an API key.

---

Base URL

https://next.inspakt.com

---

Authentication

Every request must include your API key in the X-Inspakt-Api-Key header.

X-Inspakt-Api-Key: <your-api-key>

Getting your API key

API keys are managed in the Inspakt customer panel under Settings → Integrations → API Keys.

caution

Keep your API key secret. Do not expose it in client-side code or public repositories.

---

Response format

All endpoints return a consistent JSON envelope:

{
  "version": "1.X.X",
  "success": true,
  "payload": { ... }
}

On error, success is false and the payload is replaced by an error object:

{
  "version": "1.X.X",
  "success": false,
  "error": {
    "name": "Envelope.NotFound",
    "description": "The requested envelope does not exist.",
    "context": {}
  }
}

Error name values follow the Resource.ErrorType pattern (e.g. Envelope.NotDeletable, Recipient.NotFound) and are stable across versions — safe to use for programmatic error handling.

---

Envelope lifecycle

An envelope moves through the following statuses:

Status	Description
draft	Created but not yet sent. Documents, recipients and fields can still be modified.
sent	Dispatched to recipients. Awaiting signatures.
finalized	All required recipients have completed their actions.
voided	Manually cancelled. No further actions possible.
expired	The signing deadline passed before finalization.

---

Core concepts

Concept	Description
Envelope	A signing session containing one or more documents.
Template	A reusable blueprint for envelopes, with pre-configured documents, recipients, and fields.
Recipient	A participant role in an envelope (signer, host, viewer, etc.).
Agent	The actual person assigned to a recipient role — identified by name, email, and/or phone.
Document	A PDF uploaded to an envelope or template.
Field	An interactive element placed on a document page (signature, text input, checkbox, etc.).
Contact	A reusable person record. Can be assigned to recipient roles across multiple envelopes.

---

Integration guides

Guide	Description
Start with custom documents	Build and send an envelope from scratch — upload your own PDFs each time.
Start from a template	Use a pre-configured template to send envelopes with minimal code.