Quickstart

This guide walks you through creating a signable document from scratch.

Prerequisites

• A ZipZign account and API key (see Authentication & API Keys)
• curl or any HTTP client

Step 1 — Create a document

curl -X POST https://zipzign.com/api/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "signable",
    "title": "NDA — Acme Corp",
    "content": "<h1>Non-Disclosure Agreement</h1><p>This agreement is between <strong>{{company}}</strong> and <strong>{{signerName}}</strong>.</p><p>Both parties agree to keep all shared information confidential.</p>",
    "variables": {
      "company": "Acme Corp"
    },
    "signers": [
      {
        "name": "Jane Smith",
        "email": "jane@example.com"
      }
    ]
  }'

Step 2 — Check the response

{
  "id": "doc_abc123",
  "type": "signable",
  "status": "awaiting_signatures",
  "title": "NDA — Acme Corp",
  "signers": [
    {
      "id": "sgn_xyz789",
      "name": "Jane Smith",
      "email": "jane@example.com",
      "status": "pending"
    }
  ],
  "docUrl": "https://zipzign.com/sign/doc_abc123",
  "pdfUrl": "https://zipzign.com/pdf/doc_abc123",
  "createdAt": "2026-04-15T12:00:00Z"
}

ZipZign automatically:

• Rendered your HTML to PDF
• Sent Jane a signing invitation email
• Created a hosted signing page at docUrl

Step 3 — Track status

curl https://zipzign.com/api/documents/doc_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Once Jane signs, the status moves to all_signed, then complete.

Step 4 — Retrieve the signed PDF

The pdfUrl in the response links to the final PDF. After signing is complete, this PDF contains embedded signature blocks.

Next steps

• Use Sandbox Mode to develop without sending real emails
• Set up Webhooks to receive real-time status updates
• Explore HTML Templates for dynamic content with Handlebars variables

Updated on: 16/04/2026