Skip to content

Fields and coordinates ​

A field is a box on one page of one document, owned by one recipient.

Types ​

TypeValue
signatureA PNG image, at most 512 KB.
initialsA PNG image, at most 512 KB.
date_signedAn ISO date. Filled in automatically when left empty.
nameText. Filled with the recipient's name when left empty.
textText, at most 1000 characters.
checkbox'true' or 'false'.

Fields are required by default. Only signers and approvers can own fields.

Coordinates ​

Positions are in PDF points (1/72 inch) with the origin at the top-left of the page:

ts
{
  page: 0,          // zero-based page index
  rect: { x: 72, y: 640, width: 180, height: 48 },
}
  • x is measured from the left edge, y from the top edge.
  • An A4 page is about 595 × 842 points; US Letter is 612 × 792.
  • When the document has pageSizes, every field is checked to sit fully inside its page.

The top-left origin matches screen coordinates, so a placement UI can store what the sender drags without flipping the axis. Conversion to the PDF's own bottom-left origin happens only when values are drawn.

Submitted values ​

When a recipient submits, each value is checked against its field type. Signature and initials images may be raw base64 or a data:image/png;base64, URL, and are re-encoded before they are drawn. A recipient can only fill their own fields (FIELD_NOT_YOURS), and every required field must be filled (REQUIRED_FIELDS_MISSING).

Libraries under Apache-2.0, server and apps under AGPL-3.0. "Codevibe", "Codevibe Sign" and "Hrvibe" are trademarks of Codevibe Technology and are not covered by the licences.