Quick Start

Zined is a document signing and workflow automation platform built for teams. It lets you upload PDFs, assign recipients with signature and form fields, track signing progress in real time, and archive completed documents — all through a clean UI or programmatically via a REST API.

Whether you're embedding signing flows directly into your own product, automating contract generation at scale, or building internal tooling on top of your document data, Zined's API gives you full control of the platform.

Key capabilities

Capability	Description
Document signing	Upload PDFs, place fields, collect signatures from one or more recipients
Templates	Define reusable document templates with pre-placed fields and recipient roles
Bulk send	Send the same document to hundreds of recipients from a single batch operation
Self-signing	Create and sign your own documents without requiring external recipients
Workspaces	Organize documents and teams into isolated workspaces within your organization
Contacts	Search and reuse previously seen recipient contact details
Integrations	Source documents directly from Google Drive, OneDrive, or Dropbox
Audit log	Automatically appended audit trail PDF on every completed document

---

API Overview

The Zined API is a RESTful HTTP API that returns JSON. All endpoints live under the versioned base path:

https://api.zined.app/api/v1

Note: The API is currently at version v1. The version is part of every endpoint path — there is no unversioned alias.

Request format

• Content-Type: application/json for JSON bodies
• multipart/form-data for file upload endpoints
• All timestamps are ISO 8601 strings (e.g. 2024-12-31T23:59:59.000Z)
• All IDs are UUIDs

Response format

Successful responses return the resource object (or an array) directly at the root of the JSON body. There is no top-level data wrapper.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Service Agreement.pdf",
  "status": "draft",
  "createdAt": "2024-01-15T10:30:00.000Z"
}

---

Required headers

Most authenticated endpoints require two headers on every request:

Header	Required	Description
Authorization	Yes	Auth credential — see Authentication
x-org-id	Yes (Bearer)	Your organization's UUID. Not required when using a PAT (it is encoded in the token).
x-workspace-id	Conditional	Required by document, template, and bulk-send endpoints to scope the operation to a workspace

---

Versioning & stability

The API follows semantic versioning. Breaking changes will be rolled out under a new version prefix (e.g. /api/v2) with advance notice. Additive changes (new fields, new optional parameters) may be made within a version without notice.

---

API reference

Full interactive API reference with request/response schemas and live try-it-out is available at /docs/api. The pages in this section cover concepts, guides, and integration patterns.