Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 2.85 KB

SubFormFieldsPerDocumentBase.md

File metadata and controls

37 lines (28 loc) · 2.85 KB

SubFormFieldsPerDocumentBase

The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: Using Form Fields per Document.)

NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types.

  • Text Field use SubFormFieldsPerDocumentText
  • Dropdown Field use SubFormFieldsPerDocumentDropdown
  • Hyperlink Field use SubFormFieldsPerDocumentHyperlink
  • Checkbox Field use SubFormFieldsPerDocumentCheckbox
  • Radio Field use SubFormFieldsPerDocumentRadio
  • Signature Field use SubFormFieldsPerDocumentSignature
  • Date Signed Field use SubFormFieldsPerDocumentDateSigned
  • Initials Field use SubFormFieldsPerDocumentInitials
  • Text Merge Field use SubFormFieldsPerDocumentTextMerge
  • Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge

Properties

Name Type Description Notes
document_index*required int Represents the integer index of the file or file_url document the field should be attached to.
api_id*required str An identifier for the field that is unique across all documents in the request.
height*required int Size of the field in pixels.
required*required bool Whether this field is required.
signer*required str Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

NOTE: If type is text-merge or checkbox-merge, you must set this to sender in order to use pre-filled data.
type*required str
width*required int Size of the field in pixels.
x*required int Location coordinates of the field in pixels.
y*required int Location coordinates of the field in pixels.
name str Display name for the field.
page int, none_type Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both coordinate systems and how to use them.

[Back to Model list] [Back to API list] [Back to README]