This is generated by docusign, and is an existing identifier in the system. Do not use locally generated values here. Full Legal Name of a user. This is an email address. This is a password. A phone number. This is generated locally and is only valid in the document it is generated in. It's only purpose is to refer to the the element before permanent identifiers are assigned. A standard string of 100 characters This indicates an unsigned short number greater than 0. The list of allowable Envelope Status codes. The list of allowable Envelope Status codes that can be used in Envelope event integrations. The list of allowable Recipient Status codes that can be used in Envelope event integrations. The list of allowable Recipient Status codes. This is the list of allowable recipient types. This is the list of allowable delivery methods for a recipient. Default is Email. The list of allowable Tab Status codes. The list of allowable Event Status codes. This is the list of allowable tab types. This is the list of signing location code. The list of allowable Envelope Status codes. This is the list of allowable units types. This is the list of allowable Vaulting Mode codes. This is the list of allowable display levels. This is the list of advanced features at the Account level. The list of allowable Envelope AC Status codes. The list of allowable Custom Tab types. The list of allowable Locations for a Template in the CreateAndSendFromTemplates function. The list of allowable Locations for a Template in the CreateAndSendFromTemplates function. This is the list of events returned from an in session envelope send. The list of allowable Envelope Custom Field codes. The list of allowable phone number designations. A value between 0.0 and 1.0 representing the position of scaling webcontrol for a tab. Value of 1.0 is normal full size of tab. The list of allowable Folder Types. The list of allowable DocuSign Connect publish statuses. The list of allowable text data tab fonts. The list of allowable text data tab font colors. The list of allowable text data tab font sizes. The list of allowable recipient languages. The list of allowable shared access item types. The list of allowable shared access share types. The AuthenticationStatus includes information regarding the IdCheck and Access Code result. The AttachmentFilter includes information using which specific Attachment can be searched. The DateRangeFilter includes the begin and the end datetime. The AddressInformation includes information related to the Recipient Address. The DOBInformation includes information related to the Recipient DOB. The SSN4Information includes information related to the Recipient last 4 SSN digits. The SSN9Information includes information related to the Recipient SSN. The AddressInformationInput includes information related to the Recipient Address. The DOBInformation includes information related to the Recipient DOB. The SSN4Information includes information related to the Recipient last 4 SSN digits. The SSN4Information includes information related to the Recipient last 4 SSN digits. The IDCheckInformationInput includes information related to the Recipient IDCheck. The IDCheckInformation includes information related to the Recipient IDCheck. The Vaulting response includes the Vaulting mode and vaulting permissions. This attribute indicates that a reminder email will be sent. This attribute indicates the number of days the system will wait before the first reminder is sent. The delay starts for each recipient once they have been sent the envelope. This attribute indicates the number of days the system will wait before subsequent reminders are sent. This attribute indicates that an envelope is set to expire. This attribute indicates the number of days an envelope will be active for after it is sent. Once the number of days have passed, the envelope will be voided. This attribute indicates the number of days, before an envelope expires, that a warning email should be sent. Reminders and Expiration settings for an Envelope This attribute indicates that notifications will default to the settings for the sending account. Settings for reminders on this envelope. Settings for expirations on this envelope. Override settings for email attributes BCC email address information Allows end user to specify the vaulting options for an envelope A summary of the significant data about vaulting of an envelope Allows end user to specify the anchor tab string and the offsets This indicates the string used as an Anchor Tag in the document. This indicates the X-Offset for the tab location, in units of points. This indicates the Y-Offset for the tab location, in units of points. This indicates the units of the Offset(either in Mms,Cms or Inches) Ignore this tab if anchor is not found in the document. This value is false if not supplied. Match words based on the entire word. This value is false if not supplied. Allows for end user specified name-value pairs to be carried on an envelope The Name of the Name-Value pair Indicates whether the Name-Value pair will be shown to the user who is sending the envelope. Indicates whether the Value of the Name-Value pair is required to be entered before the envelope can be sent. The Value of the Name-Value pair Semi-colon separated items to be placed in a list box when the custom field type is List. An individual record of a recipients Esign with a senders account Allows for end user specified name-value pairs to be carried on an envelope The Name of the Name-Value pair Indicates whether the Name-Value pair will be shown to the user who is sending the envelope. Address book IDs that can be used when removing address book items Address book phone number Address book entries for the user and default account Folder metadata The list of recipient brands available to the sender A summary of the significant data about the tab. A summary of the significant data about a recipient of an envelope. A summary of the significant data about an envelope and its contents. A summary of the significant data about an envelope status change. DocumentFields define custom name/value pairs tied to this document. The contents of all of the documents in a single PDF file, encoded as base64. A PDF document, with contents encoded as base64. Container for DocumentPDF elements MatchBox defines an area on a template document to be used for matching. Defines a field value pair. Defines the display properties of a responsive HTML smart section Defines the display properties of a responsive HTML smart section Rules for a responsive HTML smart section. Defines the rules for responsive HTML Rules for smart sections in the responsive HTML. A PDF Document. The content of this element is the base64 encoded bytes of the document. A locally generated, non-negative integer that is unique in the scope of the Envelope. It is used by the Tab element to indicate which document the Tab is affixed to. The Name of the Document. The password for the Document. MatchBoxes defines areas in a document to be used for matching. This is only used when working with template envelopes. DocumentFields define custom name/value pairs tied to this document. A PDF Document. The content of this element is the base64 encoded bytes of the document. A locally generated, non-negative integer that is unique in the scope of the Envelope. It is used by the Tab element to indicate which document the Tab is affixed to. The Name of the Document. The password for the Document. MatchBoxes defines areas in a document to be used for matching. This is only used when working with template envelopes. DocumentFields define custom name/value pairs tied to this document. Provides settings to for returning optional fields in the response. Provides settings to for returning optional fields in the response. An Envelope that has some information, and at least one document, but will require completion through the web site. The subject line of the email that will be sent to the recipients. The (optional) email message that will be included in the body of the email message sent to the recipients. An Envelope that has some information, and at least one document, but will require completion through the web site. The subject line of the email that will be sent to the recipients. The (optional) email message that will be included in the body of the email message sent to the recipients. The results of an envelope void attempt. A Captive Recipient of an Envelope This is the Full Legal Name of the Captive Recipient - ex: John Q. Public. Do not include honorifics or titles. The email address of the Captive Recipient. This is where the notification email will be sent. A Recipient of the Envelope This is a locally generated, non-negative integer that is unique in the scope of the envelope. It is used by the Tab element to indicate which recipient is to sign the Document that the Tab is affixed to. This is the Full Legal Name of the Recipient - ex: John Q. Public. Do not include honorifics or titles. In the case of RecipientType = InPersonSigner this will be the Signing Host's name This is the Full Legal Name of the In Person Signer Recipient - ex: John Q. Public. Do not include honorifics or titles. The email address of the Recipient. This is where the notification email will be sent. This indicates the role that the Recipient will have in completing the envelope. This is controlled by an enumerator. This optional attribute is the secret access code that the recipient will have to enter to validate their identity when accessing the envelope. If this attribute is not supplied then the Recipient may still be required to verify their identity if the RequireIDLookup attribute is set to 'true'. This optional attribute indicates that the access code will be added to the email sent to the recipient, this nullifies the Security measure of Access Code on the recipient. This attribute indicates that the recipient will be required to verify their identity by completeing a questionaire before being granted access to the envelope. This optional attribute is for customized ID Check workflows. This indicates the method that is used to delivery the envelope to the recipient. The default is Email if unspecified. This is controlled by an enumerator. This indicates fax number to use when the DeliveryMethod is set to Fax. This optional attribute indicates that the recipient will use Windows Live ID service to validate their identity. Account must be enabled with AllowSocialIDRecipAuth. true or false boolean value. This optional attribute indicates that the recipient will use Facebook Social ID service to validate their identity. Account must be enabled with AllowSocialIDRecipAuth. true or false boolean value. This optional attribute indicates that the recipient will use Twitter service to validate their identity. Twitter does not provide email validation. Account must be enabled with AllowSocialIDRecipAuth. true or false string value. This optional attribute indicates that the recipient will use Salesforce Social ID service to validate their identity. Account must be enabled with AllowSocialIDRecipAuth. true or false boolean value. This optional attribute indicates that the recipient will use Google Social ID service to validate their identity. Account must be enabled with AllowSocialIDRecipAuth. true or false boolean value. This optional attribute indicates that the recipient will use Linkedin Social ID service to validate their identity. Account must be enabled with AllowSocialIDRecipAuth. true or false boolean value. This optional attribute indicates that the recipient will use Yahoo Social ID service to validate their identity. Account must be enabled with AllowSocialIDRecipAuth. true or false boolean value. This optional attribute indicates that the recipient will use OpenID Social ID service to validate their identity. Account must be enabled with AllowSocialIDRecipAuth. true or false boolean value. This optional attribute indicates that the recipient will use any of the 8 Social ID services to validate their identity. Account must be enabled with AllowSocialIDRecipAuth. true or false boolean value. Indicates if the recipient may enter a number for phone authentication. Indicates if the number provided by the recipient should be validated. Indicates if the voice print from phone authentication should be recorded. SAMLAuthentication define custom name/value pairs tied to this recipient. Optional note that will be sent to the recipient. Optional element. If true, the Agent or Editor Recipient associated with this recipient can change the recipient's pre-populated Email address. This element is only active if enabled for the account. Optional element. If true, the Agent or Editor Recipient associated with this recipient can change the recipient's pre-populated name (UserName). This element is only active if enabled for the account. Optional element. If true, and the Recipient creates an account on completion of this envelope, the Recipient's preferences for system Email Notifications will match the Sending Accounts default configuration. Optional element. If true, Signer recipients must draw their signature at each signing location. Optional element. Identifies the PKI Provider the recipient is expected to have a certificate with. Optional element. If true, this recipient requires a notary. Optional element. Specified the recipientID this recipient is hosting. Optional element. Specify a signing group to apply to this recipient. Email and UserName will be ignored if specified. Recipient signature provider. Recipient signature provider options Recipient signature provider. Signature provider sms authentication option. Signature provider one time password authentication option. Signature provider CPF number option. Signature provider signer role option. Defines a field value pair. A 'sticky tab', representing a required signature by a Recipient on a Document. This must refer to an existing Document's ID attribute. This must refer to an existing Recipients ID attribute. This indicates the absolute page number of the document that the Tab will be affixed to. This indicates the horizontal offset of the Tab on the page, in a co-ordinate space that has the bottom left corner of the document as its origin, in units of Points (1/72 inch). This indicates the vertical offset of the Tab on the page, in a co-ordinate space that has the bottom left corner of the document as its origin, in units of Points (1/72 inch). Represents a decimal value of 0.0 to 1.0 position of the webcontrol scaling slider. A value of 1.0 represents full size. This indicates the Anchor Tag in the document This indicates what is represented by the Tab - i.e. a signature, initials, etc. It is controlled by an enumerator. This is the name of the form field. Required for form field. For Radio Button type this is the value. For List Box type this is the sem-colon delimited list of values. This is the name of the form field. Required for form field. For Radio Button type this is the group name. This is the value of the form field. For Radio Button and Check Box types this can be "X" to select the field by default. This is the type of form field, only used if TabType is Custom This is the width of form field, only used if TabType is Custom This is the height of form field, only used if TabType is Custom Require entry of data in the form field, only used if TabType is Custom, default is false Lock the form field, only used if TabType is Custom, default is false Disable the form field from resizing as the user types, only used for single line text fields, default is not to disable For Form Field List Box type this is the sem-colon delimited list of values. You may also supply these in the Name node. This node takes precendence. For Form Field List Box type this is the sem-colon delimited list of values to go with the displayed list items set in CustomTabListItems or Name. These values are the hidden values of the drop down list display items. Set this to the default selected item based on the CustomTabListItems. If Value is specified that will take precedence. For Radio Button type this is the group name. You may also supply this in the TabLabel node. This node takes precendence. For all custom tab types except radio buttons, checkboxes, and list items you may supply a regular expression that will be validated when data is entered in the field. This is optional and if not provided the default DocuSign validation rules will apply. Message to be displayed to the signer if the validation rule from CustomTabValidationPattern fails. Describes the field to be quieried/written via connect for custom tabs. This indicates the input to the CorrectAndresendEnvelope method. The results of an envelope transfer attempt. This element provides the filtering criteria for the batch status requests. A summary of the significant data about an envelope and its contents. This element provides the filtering criteria for the batch status change requests. A list of the envelopes with status changes. A summary of the significant data about recipient correction of an envelope. A summary of the significant data about the correction status of an envelope. A summary of the significant data about recipient correction status of an envelope. This indicates the Account Membership Features List This indicates the Account Settings List DocuSign Connect format Container for DocumentPDF elements, includes count A DocuSign Template and the information necessary to create an Envelope instance from the Template. This Document will replace the Document in the Template, if exists Server template to be applied in sequence. Inline template envelopes to be applied in sequence. PDF embedded template to be applied in sequence. A PDF Form and DocuSign Templates to overlay to create an Envelope instance. If supplied the template will be pulled from the PDF metadata and applied, if exists This Document will replace the Document in the Template, if exists Envelope-level information that overlays the information from the Templates. The (optional) email message that will be included in the body of the email message sent to the recipients. Indicates whether the Envelope should be sent immediately or created as a Draft Envelope. Purge documents from an envelope. Purge documents, tab data, and attachments from an envelope. Purge documents, tab data, attachments and redact PII data from an envelope. Container for Envelope Template Container for Envelope Template Container for Envelope Template definitions elements Container for Envelope Template Gets a list of template information. Gets a list of template information. Container for Address Book saves Get the address book for the user. Update the users address book with the items passed. Remove the items passed from the users address book. Synchronize status of an envelope. Used to retrieve a URL with a token for in-session sending. Used to retrieve a URL with a token for in-session correcting. List of events returned to the return URL for an in-session send. Indicates whether the Envelope should be sent immediately or created as a Draft Envelope. List of envelopes in a folder for the user Folder type and name if Normal folder List of envelopes in a folder for the user List of envelopes in a folder for the user This element provides the filtering criteria for GetFolderItems requests. This element provides the filtering criteria for GetFolderList requests. This element provides the filtering criteria for requesting DocuSign Connect failures. This element provides DocuSign Connect failures. This element provides the filtering criteria for publishing DocuSign Connect failures. This element provides the filtering criteria for requesting DocuSign Connect failures.