Defining Signer Attachments in XML

Last updated 2016-08-10 17:22:27 UTC

Signer attachments may be added or modified by adding a SignerAttachments collection of SignerAttachment elements as a child of the FileDocument element (for SubmitWithFile and AsyncSubmitWithFile operations) or FileRetrievalDocument element (for SubmitWithFileRetrieval and AsyncSubmitWithFileRetrieval operations).

So, for example, to override the instructions of a signer attachment named "Photo ID" that is defined in the template, the following XML could be added to a document submission:

    <SignerAttachment Label="Photo ID" Instructions="Please upload a picture of your drivers license" />

To create an entirely new signer attachment the following could be specified:

    <SignerAttachment Label="Proof of Residence" Instructions="Please upload two different utility bills." Required="true" AllowMultiple="true" SignatoryEmail="">

In addition, the XML must be modified in the case that the document should be parsed for the presence of text tags. When using the SubmitWithFile and AsyncSubmitWithFile methods, the FileDocument element of the XML – which contains the ContextIdentifier attribute – must be modified to contain a ParseDocument attribute with value “true”; else, if this value is false or missing the document will not be checked for the existing of text tags. When using the SubmitWithFileRetrieval and AsyncSubmitWithFileRetrieval methods, the ParseDocument attribute must be added to the FileRetrievalDocument element.

Properties that may be set on dynamically created signer attachments can be found here.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Article is closed for comments.