Objects
The template object
A template is a document with glyphs that you upload once and send many times. Its fields come from the glyphs in the document.
Single-template responses include fields; lists do not. The same field object appears on pacts, where each field also has an id and, once its signer has signed, a value.
Attributes
uidstringThe template's id: 8 letters and digits.
namestringYour name for it (150 characters at most). Defaults to the file name.
source_namestringThe uploaded file's name.
source_typestringWhat was uploaded. Word documents are converted to PDF on upload.
One of
pdf docxpage_countintegerPages in the document.
signer_countintegerSigners the glyphs call for: the highest glyph number.
field_countintegerFields found in the document.
date_createdstring (date-time)When it was uploaded.
date_updatedstring (date-time)When it last changed.
fieldsarray of objectsEvery field, from its glyphs or placed by hand, in page order.
Single-template responses only.
ShowHide field attributes
idinteger | nullThe field's id on a pact.
null on a template.recipientintegerThe signer the field belongs to: the number in its glyph (
\s2\ → 2), or the signer it was given to in the website's field editor.typestringWhat the signer provides.
One of
signature initials name date text checkboxpageintegerThe page it is on, starting at 1.
xnumberDistance from the page's left edge, in PDF points (1/72 inch).
ynumberDistance from the top of the page to the box's bottom edge, in points: the glyph's text baseline. Signatures stand on that line.
widthnumberThe box's width in points: set by the field type for a glyph, as drawn for a field placed by hand on the website.
heightnumberThe box's height in points: set by the field type for a glyph, as drawn for a field placed by hand on the website.
labelstring | nullThe label from the glyph, such as
Company in \t1:Company\, or the one typed in the field editor.requiredbooleanfalse when the glyph ends in ! (\t1:Phone!\, \c1!\), or when the field was made optional in the field editor.valuestring | nullWhat was filled in, once that signer has signed: text as typed,
"1" or "0" for a checkbox, the typed name for name, and the signing date (MM/dd/yyyy, UTC) for date. Signatures and initials are images on the PDF, so they stay null.The field object
idinteger | nullThe field's id on a pact.
null on a template.recipientintegerThe signer the field belongs to: the number in its glyph (
\s2\ → 2), or the signer it was given to in the website's field editor.typestringWhat the signer provides.
One of
signature initials name date text checkboxpageintegerThe page it is on, starting at 1.
xnumberDistance from the page's left edge, in PDF points (1/72 inch).
ynumberDistance from the top of the page to the box's bottom edge, in points: the glyph's text baseline. Signatures stand on that line.
widthnumberThe box's width in points: set by the field type for a glyph, as drawn for a field placed by hand on the website.
heightnumberThe box's height in points: set by the field type for a glyph, as drawn for a field placed by hand on the website.
labelstring | nullThe label from the glyph, such as
Company in \t1:Company\, or the one typed in the field editor.requiredbooleanfalse when the glyph ends in ! (\t1:Phone!\, \c1!\), or when the field was made optional in the field editor.valuestring | nullWhat was filled in, once that signer has signed: text as typed,
"1" or "0" for a checkbox, the typed name for name, and the signing date (MM/dd/yyyy, UTC) for date. Signatures and initials are images on the PDF, so they stay null.