Document options

options configures document-wide behavior. Options can be stored on a template version and overridden per request: a request's section replaces the stored section wholesale (section by section, not key by key), so a request that sends watermark replaces the whole stored watermark but leaves stored metadata untouched.

{
  "options": {
    "metadata": { "title": "Notice of Hearing", "author": "Adams County Court", "language": "en-US" },
    "viewer": { "print_scaling": "none" },
    "watermark": { "text": "COPY" },
    "page_numbers": { "position": "bottom_center" }
  }
}

options are accepted on template versions, generate requests, one-off /v1/documents requests, and batch jobs.

Metadata

PDF document properties: what viewers show in the document's info panel and what document-management systems index.

Key	Purpose
title, author, subject, keywords	Standard document properties
language	The document language (e.g. en-US, es), embedded for accessibility (assistive technology uses it to choose the right voice)

Viewer preferences

Key	Values	Why
print_scaling	none, app_default	none asks viewers to print at true size: court forms with fixed field positions and barcodes must not be shrunk to fit
duplex	simplex, duplex_flip_long_edge, duplex_flip_short_edge	Default the print dialog for double-sided filings

Watermarks

A diagonal text stamp on every page (DRAFT, COPY, VOID):

Key	Range	Default
text (required)	≤ 100 characters	(none)
opacity	0.05–0.5	0.15
angle	degrees	45
color	hex color	#999999

Previews apply their own PREVIEW watermark automatically.

Page numbers

Key	Values	Default
format	{page} and {pages} placeholders	Page {page} of {pages}
position	bottom_left, bottom_center, bottom_right	bottom_center
size	6–14	9
start_at	first page number	1
color	hex color	#555555

Stacking order

Watermarks and page numbers draw above field content. Interactive form widgets, however, always paint above everything, so to place a watermark visually over form fields too, also set flatten, which converts the widgets to static content first.