eoGetFormFieldProperties

Action Parameter eoGetFormFieldProperties
Purpose Retrieves the detailed properties of form fields and signatures within a document
Description Returns all of the detailed properties that correspond to the form fields in a document. The user can choose whether or not to retrieve the sig string. If a multimedia signature is stored, it will always be verified and returned.
Type Granular
Preconditions None
Implementation Notes The eoGetFormFieldProperties API call allows you to retrieve the existing PDF form field configuration (i.e. X,Y coordinates, type of form field, role mapping, display order, etc.).
This API call is often used to troubleshoot the behavior of how the eOriginal SmartSign Web application interprets and present existing PDF form field.

Parameters

Required Parameter Value Description
required dpSid The unique identifier that corresponds to the document profile.
required includeMultiMediaSignature
required includeSignatureInfo

Response

We recommend using the most recent version of FireFox while testing API calls via your web browser. Microsoft Edge and Google Chrome require 3rd party XML extensions to display the XML response natively in your browser.