Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 2.86 KB

SubFormFieldsPerDocumentBase.md

File metadata and controls

34 lines (28 loc) · 2.86 KB
Raw

# SubFormFieldsPerDocumentBase

The fields that should appear on the document, expressed as an array of objects. (For more details 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 string 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 string Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

NOTE: To set the value of the field as the preparer you must set this to me_now

NOTE: If type is text-merge or checkbox-merge, you must set this to sender in order to use pre-filled data.
type*required string
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 string Display name for the field.
page int 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]