eoInsertFormFieldsSignReturnECopy

Action Parameter eoInsertFormFieldsSignReturnECopy
Purpose By using this interface, the client application can reduce the number of calls required to insert the signature blocks, sign the document, and return an eCopy document.
Description Inserts signature blocks into a PDF file, signs the PDF file, and stores the signed document as a new document version in the identified document profile. An eCopy document is returned in the response.
Type Coarse
Preconditions Document profile has been created in the eCore® service, and the client application has the dpSid.
Document profile does not contain another Electronic Original document.

Parameters

Required Parameter Value Description
required dpSid Unique identifier to an existing document in the eCore® service.
required formFieldDataXML The data to be merged.
Note 1
formFieldsXML - An XML file that: a) defines the information used to insert the signature and text blocks into the PDF file, b) complies with the transformation-instruction-set.xsd schema, and c) includes at least one signature block.

formFieldTemplateName - The name of a template stored in the global eCore template library.
Note 2
watermarkProperties - XML instructions file describing the watermark to be applied to the requested document.
The XML file must conform to the transformation-instruction-set.xsd schema (sample).

watermarkName - Pre-Configured Watermark stored with CommandCenter.

Note 1: Either applyStoredFormFieldsTemplate, a formFieldsXML or a formFieldTemplateName is required.

Note 2: Either a watermarkProperties or a watermarkName may be passed in. A watermarkProperties will be applied before a watemarkName and a watemarkName will be applied before preconfigured rules defined with CommandCenter. If none of these are found, a default vault watermark will be applied.

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.