v1
documents

Prepare Document

Infer signing fields and return either a preview or the tagged PDF.

document_base64 is the PDF (max 10MB). signers is an optional hint list (name, email, role, order). Until the calling user has approved a preview, every call returns status: preview with prepare_id and no PDF. After that, a call returns status: ready and pdf_base64 when confidence is at least 0.85, and a preview otherwise. prepare_id plus approve: true returns the stored PDF. No envelope is created and no credit is charged.

Rate limit: 100 requests per hour per API key.

post/api/v1/documents/prepare

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/prepare
  • Auth: HTTP bearer

Request body

document_base64string nullable
prepare_idstring uuid nullable
approveboolean

Response

Successful Response

statusstring required
confidencenumber required
reasonsstring[]
prepare_idstring nullable
pdf_base64string nullable

Changes

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