Documents API Reference — ZiaSign Developer Docs

Base URL

https://api.ziasign.com/api/v1

All endpoints require authentication.

List Documents

GET /documents

Query parameters:

Parameter	Type	Description
`status`	string	Filter by status: `draft`, `sent`, `completed`, `voided`, `expired`
`page`	integer	Page number (default: 1)
`pageSize`	integer	Results per page (default: 20, max: 100)
`search`	string	Search by document name or signer email
`sortBy`	string	Sort field: `createdAt`, `updatedAt`, `name`
`sortOrder`	string	`asc` or `desc` (default: `desc`)

Response

json

{
  "items": [
    {
      "id": "doc_abc123",
      "name": "Service Agreement.pdf",
      "status": "sent",
      "createdAt": "2026-04-15T10:00:00Z",
      "updatedAt": "2026-04-15T10:05:00Z",
      "signers": [
        {
          "name": "Jane Doe",
          "email": "[email protected]",
          "status": "pending",
          "order": 1
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "totalItems": 142,
    "totalPages": 8
  }
}

Create & Send Document

text

POST /documents
Content-Type: multipart/form-data

Field	Type	Required	Description
`file`	binary	Yes	The document file (PDF, PNG, JPG, JPEG)
`name`	string	No	Document name (defaults to filename)
`signers`	JSON	Yes	Array of signer objects
`fields`	JSON	No	Array of field placement objects
`send`	boolean	No	Send immediately (default: false — creates as draft)
`subject`	string	No	Custom email subject
`message`	string	No	Custom email body message
`expirationDays`	integer	No	Days until expiration (default: 30)

cURL Example

bash

curl -X POST "https://api.ziasign.com/api/v1/documents" \
  -H "X-Api-Key: $API_KEY" \
  -H "X-Timestamp: $TIMESTAMP" \
  -H "X-Signature: $SIGNATURE" \
  -F "[email protected]" \
  -F 'signers=[{"name":"Jane Doe","email":"[email protected]","order":1}]' \
  -F 'fields=[{"type":"signature","page":1,"x":350,"y":680,"width":200,"height":50,"signerIndex":0}]' \
  -F "send=true" \
  -F "subject=Please sign: Service Agreement" \
  -F "expirationDays=14"

JavaScript Example

typescript

const formData = new FormData();
formData.append("file", fs.createReadStream("contract.pdf"));
formData.append("signers", JSON.stringify([
  { name: "Jane Doe", email: "[email protected]", order: 1 },
  { name: "John Smith", email: "[email protected]", order: 2 },
]));
formData.append("fields", JSON.stringify([
  { type: "signature", page: 1, x: 350, y: 680, width: 200, height: 50, signerIndex: 0 },
  { type: "signature", page: 1, x: 350, y: 750, width: 200, height: 50, signerIndex: 1 },
  { type: "date", page: 1, x: 560, y: 690, width: 100, height: 30, signerIndex: 0 },
]));
formData.append("send", "true");

// Note: For file uploads, adapt the ziasignFetch helper to skip
// JSON.stringify and the Content-Type header (FormData sets it automatically)
const doc = await ziasignFetch("POST", "/documents", formData);
console.log("Document sent:", doc.id);

Get Document

GET /documents/{id}

Returns the full document details including status, signers, fields, and audit trail.

Download Document

GET /documents/{id}/download

Returns the document PDF. For completed documents, this includes all signatures and the Certificate of Completion.

Query parameters:

Parameter	Type	Description
`certificate`	boolean	Include Certificate of Completion (default: true)
`auditTrail`	boolean	Include audit trail pages (default: true)

Void Document

POST /documents/{id}/void

json

{
  "reason": "Contract terms changed, sending updated version."
}

Cancels a sent document. All signers are notified that the document has been voided.

Resend Notification

POST /documents/{id}/resend

json

{
  "signerEmail": "[email protected]",
  "message": "Friendly reminder to please sign the agreement."
}

Document Statuses

Status	Description
`draft`	Created but not yet sent
`sent`	Sent to signers, awaiting signatures
`viewed`	At least one signer has opened the document
`partially_signed`	At least one signer has signed (multi-signer docs)
`completed`	All signers have signed
`voided`	Cancelled by the sender
`expired`	Signing period elapsed without completion

Frequently asked questions

Can I upload a document and send it in a single API call?

Yes. The POST /documents endpoint accepts the file, signers, and fields in a single multipart request. Set the 'send' parameter to true to send immediately.

What is the maximum file size for API uploads?

25 MB per file via the API, same as the web interface. For larger files, contact support for Enterprise accommodations.

How do I check the status of a sent document?

Use GET /documents/{id} to retrieve the document details, including the current status (draft, sent, viewed, partially_signed, completed, voided, expired).

Documents API

Base URL

List Documents

Response

Create & Send Document

cURL Example

JavaScript Example

Get Document

Download Document

Void Document

Resend Notification

Document Statuses

Frequently asked questions

Related documentation