> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.

# FileMetadata

Comprehensive metadata information for a file in a transaction. This metadata defines how the file should be displayed,
processed, and what form fields and signing areas it contains. The metadata can be uploaded before or after the actual PDF file.

#### Properties

| Name             | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                                                                                                                                                                                                          |
| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **DisplayName**  | String  | Null                                                                                                                                                                                                                                                                                                                                                                                                                                                | <p>Human-readable display name for the file that will be shown to users in the signing interface. If not provided, the fileId will be used as the display name.</p>                                                      |
| **DisplayOrder** | Integer | Null                                                                                                                                                                                                                                                                                                                                                                                                                                                | <p>Numeric value determining the order in which files are displayed and processed when multiple files are present in a transaction. Lower numbers appear first. If not specified, a timestamp-based order is used.</p>   |
| **Description**  | String  | Null                                                                                                                                                                                                                                                                                                                                                                                                                                                | <p>Detailed description of the file's purpose and contents. This helps users understand what they are signing and may be displayed in the signing interface or audit logs.</p>                                           |
| **SetParaph**    | Boolean | Null                                                                                                                                                                                                                                                                                                                                                                                                                                                | <p>Indicates whether a paraph (initial) should be set on each page of the document in addition to the main signature. When true, signers will be required to initial every page. Defaults to false if not specified.</p> |
| **Signers**      | Object  | <p>Dictionary mapping signer identifiers to their specific configuration for this file. Each signer can have different form sets and signing requirements for the same document. The key is the signer identifier.</p>                                                                                                                                                                                                                              |                                                                                                                                                                                                                          |
| **FormSets**     | Object  | <p>Nested dictionary structure defining form fields and signing areas within the document. The outer key represents the form set name, and the inner key represents individual field identifiers within that set. Form sets allow grouping related fields together for organization and signer assignment.</p> <p>The following characters are allowed as a key / field name: <code>a-z A-Z 0-9 \_</code>.</p> <p>Map of pdf field definitions.</p> |                                                                                                                                                                                                                          |