v1
documents

Create Draft

Upload one or more PDFs as a Draft, or stamp a saved template.

files (repeatable) creates a multi-document envelope; file is the single-document form and is still accepted; when both are given the order is file first, then files. document_names is an optional JSON array of display names aligned with that order. Exactly one of file/files or template_id. role_mapping (template only) is a JSON object {source_role: destination_role}; unmapped roles stay literal.

Tags are detected best-effort (an untagged PDF is a valid starting point). Pass fields to place them now, or leave them for a human in the dashboard editor. Recipients are stored for later send / Approve.

post/api/v1/documents/drafts

Request

  • Base URL: https://zsign.io (the document declares no server; this is the origin it was published from)
  • URL: https://zsign.io/api/v1/documents/drafts
  • Auth: HTTP bearer

Response

Successful Response

document_idstring uuid required
status'draft' | 'ready_to_send' required
namestring required
filenamestring required
parsed_fieldsobject[] required
partiesstring[] required
metadataobject nullable
credits_chargedinteger
sentboolean
revisioninteger
package_file_countinteger

Changes

No recorded changes to this operation across all 1 revision of this API.