Skip to main content

Generated documents

When a warrant is signed, the application is rendered into a court-ready document: the template's layout, the values from form_data, the signing judge's signature, and the signing time.

Getting the document​

A signed application carries pdf_url:

curl -s "$BASE/warrants/$WARRANT_ID" -H "x-api-key: $API_KEY" | jq -r .pdf_url

The URL is short-lived and signed. Fetch it promptly, and re-read the application to get a fresh one rather than storing it. Fetching a document is recorded in the audit trail as a download, which is how an agency can answer who obtained a copy of a warrant.

An unsigned application has pdf_url: null. There is no document until there is a signature.

The HTML form of the document​

document_html carries the rendered document as HTML, which is what a client displays in-app without downloading anything. document_updated_at tells you when it was last rendered.

allow_document_editing reflects whether the template permits the document body to be edited on this application before signing (allow_editing_per_warrant).

Document styles​

A template renders with a document style: page size, margins, and typography.

curl -s "$BASE/document-styles" -H "x-api-key: $API_KEY"
[
  {
    "id": "…",
    "slug": "letter-portrait",
    "name": "Letter, portrait",
    "is_system": true,
    "is_active": true
  }
]

Set a template's style_preset to the slug you want. System styles are maintained by eCourtDate; an agency can carry its own.

Regenerating​

Signing renders the document once. If that rendering failed, the warrant is still validly signed but has no file. Rebuild it:

curl -s -X POST "$BASE/warrants/$WARRANT_ID/regenerate-pdf" \
  -H "x-api-key: $API_KEY" \
  -H "X-On-Behalf-Of: admin.reyes@example.gov"

Nothing is re-signed. The stored signature, the signer, and the signing time are replayed exactly as they were recorded; only the rendered file is rebuilt. The signature on the regenerated document is the same signature, applied at the same recorded moment.

Regeneration only applies to SIGNED applications, and it is audited like any other action.

Branding​

Documents and public pages carry the agency's identity: name, court name, and logo, from agency settings. The logo is served through GET /v1/public/branding/{fileId}, which takes no key so that a document renders for a recipient who has no account.