Objects

The Document object

Returned by Create a document, Retrieve a document.

Attributes

id string required
object enum required
One of document
status enum required
One of queued, generating, rendering, succeeded, failed, expired
template string · nullable required
e.g. tpl_…@v14; null for a custom form.
session string · nullable
The session it was made from.
jurisdiction string · nullable required
mode enum required
One of basic, advanced
formats array of enums required
One of pdf, docx, html
files Files object
Present when status is succeeded. One entry per requested format.
error Error object · nullable
livemode boolean required
metadata Metadata object
Up to 20 keys of your own, echoed back and shown in logs. Don't put personal data here.
created_at timestamp required
completed_at timestamp · nullable
expires_at timestamp required