Envelopes: create

Creates and sends an envelope or creates a draft envelope. Envelopes are fundamental resources in the DocuSign platform and are used in a variety of ways.

With this method you can:

  • Create and send an envelope with documents, recipients, and tabs.
  • Create and send an envelope from a template.
  • Create and send an envelope from a combination of documents and templates.
  • Create a draft envelope.

There are many ways to use envelopes. You can create and send an envelope with a single API request, or you can use several API requests to create, populate, and send envelopes.

When you use this method to create and send an envelope in a single request, the following parameters are required:

Parameter Description
status Set to sent to send the envelope to recipients.
Set to created (or don't set at all) to save the envelope as a draft.
emailSubject The subject of the email used to send the envelope.
documents The documents to be signed.
recipients The email addresses of the envelope recipients.

If you are creating an envelope to be sent later, save it as a draft by either setting status to created or leaving it unset. For instance, you can create a draft envelope with documents only. Using additional API requests, you can add the recipients and send the envelope in subsequent API requests.

Feature Availability

Not all DocuSign features are available to all accounts. Use DocuSign Admin to check and enable feature availability. You can also check feature availability via the web application. For example, if the web application allows you to send an envelope with SMS authentication, then you can use the same feature through the API.

Sending Envelopes

Documents can be included with the Envelopes:create method, or a template can include documents. Documents can be added by using a multipart/form request or by using the documentBase64 property of the document object.

Adding Documents to Requests

There are two ways to add documents to your envelopes:

  1. Use the documents property of the envelope definition.
  2. Send this request as a multipart/form-data POST with documents added through additional request parts.

Using the documents property is the simpler option, but the request may be quite large due to the base64 encoding. This example shows how to add a document using this method.

{
"status": "sent",
"emailSubject": "Example of one recipient, type signer",
"documents": [{
"documentId": "1",
"name": "contract.pdf",
"documentBase64": "base64 document bytes...",
}],
"recipients": {
"signers": [{
"name": "Lisa Simpson",
"email": "lisa@email.com",
"recipientId": "1",
"routingOrder": "1",
"tabs": {
"signHereTabs": [{
"xPosition": "150",
"yPosition": "200",
"documentId": "1",
"pageNumber": "1"
}],
}
}]
}
}

If you are using a multipart/form-data POST request, you do not have to base64 encode your documents. You place the envelope definition in one part and the document bytes in another:

--AAA
Content-Type: application/json
Content-Disposition: form-data
<ENVELOPE DEFINITION GOES HERE>
--AAA
Content-Type:application/pdf
Content-Disposition: file; filename="contract.pdf"; documentid=1
<DOCUMENT BYTES GO HERE>
--AAA--

Using Supplemental Documents

Supplemental documents are supporting materials such as disclosures and other informational documents that need to accompany a document sent for signature. These supplemental documents are available to the signer to view and acknowledge, without making the envelope too large or confusing for signers.

Supplemental documents use the following properties in the document object.

Name Type Description
includeInDownload Boolean When set to true, the document is included in the combined document download. The default value is true.
display String This string sets the display and behavior properties of the document during signing. The possible values are:
`
  • modal
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents.

  • download
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window.

  • inline
    This value is not used with supplemental documents, but is the default value for all other documents. The document is shown in the normal signing window.

signerMustAcknowledge String Sets how the signer interacts with the supplemental document. The possible values are:
  • no_interaction
    No recipient action is required.

  • view
    The recipient is required to view the document.

  • accept
    The recipient is required to accept the document by selecting accept during signing, but is not required to view the document.

  • view_accept
    The recipient is required to view and accept the document.

The View and Approve tabs are used to set the interactions for individual recipients. The View tab includes a required property that requires the recipient to view the supplemental document. If the View tab required property is not set, the recipient can, but is not required to, view the supplemental document.

To use the View and Approve tabs for supplemental documents, the document display property must be set to modal or download.

The actions that the recipient must take depend on the value of the signerMustAcknowledge document property and whether the signer is assigned View or Approve tabs on the document.

To set the interactions for individual recipients, set the signerMustAcknowledge property to no_interaction, then add View and Approve tabs on the appropriate document for the recipient.

The action that a signer must take depends on the value of the signerMustAcknowledge document property, whether the signer has an Approve tab, and the value of the required property of the View tab. The following table shows the actions a recipient must take for different combinations of these tabs and properties.

Document signerMustAcknowledgeproperty Approve Tab View Tab required property Recipient is required to ...
no_interaction No -- Take no action
no_interaction No false Take no action
no_interaction No true View
no_interaction Yes false Accept
no_interaction Yes true View and Accept
view No -- View
view Yes -- View and Accept
accept -- false Accept
accept -- true View and Accept
view_accept -- -- View and Accept

Recipient Types

An envelopeDefinition object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The envelopeDefinition object's recipients property is an EnvelopeRecipients resource object. It includes arrays of the seven types of recipients defined by DocuSign:

Recipient type Description
Agents An agent recipient can add name and email information for recipients that appear after the agent in routing order.
Carbon Copies Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. This type of recipient can be used in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed.
Certified Deliveries Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.
Editors Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.
In-Person Signers An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer.
Intermediaries An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.
Signers A signer is a recipient who must sign, initial, date, or add data to form fields on the documents in the envelope.

Additional information about the different types of recipients is available from the EnvelopeRecipients resource page and from the Developer Center Recipients topic.

Tabs

Tabs (also referred to as tags and fields in the web application), can be defined in the envelopeDefinition, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below).

The inPersonSigner, and signer recipient objects include a tabs property. It is an EnvelopeRecipientTabs resource object that includes arrays of the different tab types available. See the EnvelopeRecipientTabs resource for more information.

Using Templates

Envelopes use specific people or groups as recipients. Templates can specify a role, eg account_manager. When a template is used in an envelope, the roles must be replaced with specific people or groups.

When you create an envelope using a templateId, the different recipient type objects within the EnvelopeRecipients property are used to assign recipients to the template's roles via the roleName property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template.

Message Lock

When a template is added or applied to an envelope, and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The messageLock property is used to lock the email subject and message.

If an email subject or message is entered before adding or applying a template with messageLock set to true, the email subject and message is overwritten with the locked email subject and message from the template.

Envelope Status

The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. See API Rules and Limits for more information and examples.

When a webhook is used, DocuSign calls your application via the URL you provide, with a notification XML message.

See the Webhook recipe for examples and live demos of using webhooks.

Webhook Options

The two webhook options, eventNotification and Connect, use the same notification mechanism and message formats. Use eventNotification to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. The Connect guide discusses the webhook notification message format.

eventNotification Webhooks

The Envelopes:create method includes an optional eventNotification object property that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access.

Connect Webhooks

Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or through other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc.

You can create and manage Connect configurations with the ConnectConfigurations resource. Configurations can also be created and managed from DocuSign Admin accessed by selecting Go to Admin from the menu next to your picture on the DocuSign web app. See the Connect topic in the Integrations section of DocuSign Admin. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs.

Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information.

Composite Templates

The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more.

Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents.

  • The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multipart HTTP message. If used, the document content-disposition must include the compositeTemplateId to which the document should be added. If compositeTemplateId is not specified in the content-disposition, the document is applied based on the documentId only. If no document object is specified, the composite template inherits the first document.

  • Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value.

  • Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value.

  • Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value.

PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set transformPdfFields to true for the document.

See PDF Form Field Transformation for more information about process.

  • PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value.

Compositing the Definitions

Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied:

  • Templates are overlaid in the order of their Sequence value.
  • If Document is not passed into the Composite Template's document field, the first template's document (based on the template's Sequence value) is used.
  • Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing.

For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) than where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template than where that role recipient is specified.

  • Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order.

  • If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput.

  • Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents.

For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations.

  • roleName and tabLabel matching is case sensitive.

  • The defaultRecipient property enables you to specify which recipient the tabs generated from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the default recipient by specifying the mapping of the tab label that is created to one of the template recipients.

  • You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "*" and then the system matches tabs that start with the label.

  • If no defaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.)

Including the Document Content for Composite Templates

Document content can be supplied inline, using the documentBase64 or can be included in a multipart HTTP message. If a multipart message is used and there are multiple Composite Templates, the document content-disposition can include the compositeTemplateId to which the document should be added. Using the compositeTemplateId sets which documents are associated with particular composite templates. An example of this usage is:

--5cd3320a-5aac-4453-b3a4-cbb52a4cba5d
Content-Type: application/pdf
Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1"
Content-Transfer-Encoding: base64

PDF Form Field Transformation

Only the following PDF Form FieldTypes are transformed to DocuSign tabs:

  • CheckBox
  • DateTime
  • ListBox
  • Numeric
  • Password
  • Radio
  • Signature,
  • Text

Field Properties that are transformed:

  • Read Only
  • Required
  • Max Length
  • Positions
  • Initial Data

When transforming a PDF Form Digital Signature Field, the following rules apply. Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab

If the PDF Field Name contains Then the DocuSign tab will be
DocuSignSignHere or
eSignSignHere
Signature
DocuSignSignHereOptional or
eSignSignHereOptional
Optional Signature
DocuSignInitialHere or
eSignInitialHere
Initials
DocuSignInitialHereOptional or
eSignInitialHereOptional
Optional Initials

When transforming PDF Form Text Fields, the following rules apply. Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab.

If the PDF Field Name contains Then the DocuSign tab will be
DocuSignSignHere or
eSignSignHere
Signature
DocuSignSignHereOptional or
eSignSignHereOptional
Optional Signature
DocuSignInitialHere or
eSignInitialHere
Initials
DocuSignInitialHereOptional or
eSignInitialHereOptional
Optional Initials
DocuSignEnvelopeID or
eSignEnvelopeID
EnvelopeID
DocuSignCompany or
eSignCompany
Company
DocuSignDateSigned or
eSignDateSigned
Date Signed
DocuSignTitle or
eSignTitle
Title
DocuSignFullName or
eSignFullName
Full Name
DocuSignSignerAttachmentOptional or
eSignSignerAttachmentOptional
Optional Signer Attachment

PDF Form Field Names that include DocuSignIgnoreTransform or eSignIgnoreTransform will not be transformed.

PDF Form Date fields that include DocuSignDateSigned or eSignDateSigned will be transformed to Date Signed fields.

Template Email Subject Merge Fields

This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template.

The merge fields, based on the recipient's roleName, are added to the emailSubject when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line.

Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient.

If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject.

  • To add a recipient's name in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template:

    [[<roleName>_UserName]]

    Example:

    "emailSubject":"[[Signer 1_UserName]], Please sign this NDA"

  • To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template:

    [[<roleName>_Email]]

    Example:

    "emailSubject":"[[Signer 1_Email]], Please sign this NDA"

In both cases <roleName> is the recipient's roleName in the template.

For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject.

Branding an Envelope

The following rules are used to determine the brandId used in an envelope:

  • If a brandId is specified in the envelope or template and that brandId is available to the account, that brand is used in the envelope.
  • If more than one template is used in an envelope, and more than one brandId is specified, the first brandId specified is used throughout the envelope.
  • In cases where no brand is specified, and the sender belongs to a group:
    • If there is only one brand associated with the group, then that brand is used in the envelope.
    • Otherwise, the account's default signing brand is used.
  • For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope.

BCC Email Address Feature

The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options.

Do not use this feature to send a copy of the envelope to a recipient who does not need to sign. Use a Carbon Copy or Certified Delivery Recipient type instead.

Merge Recipient Roles for Draft Envelopes

When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could leave duplicate recipients in the envelope.

To prevent this, the query parameter merge_roles_on_draft should be added when posting a draft envelope (status is created) with multiple templates. Doing this will merge template roles and remove empty recipients.

DocuSign recommends that the merge_roles_on_draft query parameter be used any time you are creating an envelope with multiple templates and keeping it in draft (status is created) status.

Request

HTTP request

POST /v2/accounts/{accountId}/envelopes

Parameters

Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

Optional query parameters
cdse_mode string

Reserved for DocuSign.

change_routing_order string
completed_documents_only string

Reserved for DocuSign.

merge_roles_on_draft string

When set to true, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the status field is set to created.)

Note: DocuSign recommends that this parameter should be set to true whenever you create a draft envelope with multiple templates.

Request Body

Responses

Code Description Reference
201 Created Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::createEnvelope

Definitions Expand All | Collapse All

AccountCustomFields

Custom Fields

listCustomFields
[listCustomField]

An array of list custom fields.

textCustomFields
[textCustomField]

An array of text custom fields.

EnvelopeEmailSettings

Envelope email settings

bccEmailAddresses
[bccEmailAddress]

A list of email addresses that receive a copy of all email communications for an envelope. You can use this for archiving purposes.

replyEmailAddressOverride string
replyEmailNameOverride string

EnvelopeLocks

Envelope locks

errorDetails errorDetails
lockDurationInSeconds string

Sets the time, in seconds, until the lock expires when there is no activity on the envelope.

If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.

The lock duration can be extended.

lockedByApp string

Specifies the friendly name of the application that is locking the envelope.

lockedByUser userInfo

A complex type containing information about the user that has the Envelope or Template locked.

lockedUntilDateTime string

The datetime until the envelope lock expires.

lockToken string

A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.

lockType string

The type of envelope lock. Currently "edit" is the only supported type.

useScratchPad string

Reserved for future use.

Indicates whether a scratchpad is used for editing information.

EnvelopeRecipientTabs

All of the tabs associated with a recipient. Each property is a list of a type of tab.

approveTabs
[approve]

A list of Approve tabs.

This tab allows the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history.

checkboxTabs
[checkbox]

A list of Checkbox tabs.

This tab allows the recipient to select a yes/no (on/off) option.

companyTabs
[company]

A list of Company tabs.

This tab displays the recipient's company name.

dateSignedTabs
[dateSigned]

A list of Date Signed tabs

This tab displays the date that the recipient signed the document.

dateTabs
[date]

A list of Date tabs.

This tab allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format.

declineTabs
[decline]

A list of Decline tabs.

This tab allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided.

emailAddressTabs
[emailAddress]

A list of Email Address tabs.

This tab displays the recipient's email as entered in the recipient information.

emailTabs
[email]

A list of Email tabs.

This tab allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information.

When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

envelopeIdTabs
[envelopeId]

A list of Envelope ID tabs.

This tab displays the envelope ID. Recipients cannot enter or change the information in this tab.

firstNameTabs
[firstName]

A list of First Name tabs.

This tab displays the recipient's first name. It takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name.

formulaTabs
[formulaTab]

A list of Formula tabs.

The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result.

The formula property of the tab contains the references to the underlying tabs. See Calculated Fields in the DocuSign Support Center to learn more about formulas.

If a formula tab contains a paymentDetails property, the tab is considered a payment item. See Requesting Payments Along with Signatures in the DocuSign Support Center to learn more about payments.

fullNameTabs
[fullName]

A list of Full Name tabs.

This tab displays the recipient's full name.

initialHereTabs
[initialHere]

A list of Initial Here tabs.

This tab allows the recipient to initial the document. May be optional.

lastNameTabs
[lastName]

A list of Last Name tabs.

This tab displays the recipient's last name. It takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name.

listTabs
[list]

A list of list tabs.

This tab offers a list of options to choose from. The listItems property is used to specify the selectable options.

noteTabs
[note]

A list of Note tabs.

This tab displays additional information, in the form of a note, for the recipient.

numberTabs
[number]

A list of Number tabs.

This tab allows the recipient to enter numbers and decimal (.) points.

radioGroupTabs
[radioGroup]

A list of Radio Group tabs.

This tab This group tab is used to place radio buttons on a document. The radios property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group.

signerAttachmentTabs
[signerAttachment]

A list of Signer Attachment tabs.

This tab allows the recipient to attach supporting documents to an envelope.

signHereTabs
[signHere]

A list of Sign Here tabs.

This tab allows the recipient to sign a document. May be optional.

ssnTabs
[ssn]

A list of SSN tabs.

This tab is a one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.

textTabs
[text]

A list of Text tabs.

This tab A tab that allows the recipient to enter any type of text.

titleTabs
[title]

A list of Title tabs.

This tab displays the recipient's title.

viewTabs
[view]

A list of View tabs.

This tab This tab is used with the Approve tab to handle supplemental documents.

zipTabs
[zip]

A list of Zip tabs.

This tab allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.

EnvelopeRecipients

Envelope recipients

agents
[agent]

A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.

carbonCopies
[carbonCopy]

A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.

certifiedDeliveries
[certifiedDelivery]

A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.

currentRoutingOrder string
editors
[editor]

A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.

errorDetails errorDetails
inPersonSigners
[inPersonSigner]

Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.

intermediaries
[intermediary]

Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).

recipientCount string

The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:

  • recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.
  • includeDocuments - When set to true, the envelope time zone information is included in the message.
signers
[signer]

A complex type containing information about the Signer recipient.

Envelopes

Envelope creation, management

allowMarkup string

When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this

allowReassign string

When set to true, the recipient can redirect an envelope to a more appropriate recipient.

asynchronous string

When set to true, the envelope is queued for processing and the value of the status property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.

attachmentsUri string
authoritativeCopy string

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.

autoNavigation string

Specifies whether auto navigation is set for the recipient.

brandId string

The unique identifier of a brand.

brandLock string
certificateUri string

Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.

completedDateTime string

Specifies the date and time this item was completed.

createdDateTime string

Indicates the date and time the item was created.

customFields AccountCustomFields

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

customFieldsUri string

Contains a URI for an endpoint that you can use to retrieve the custom fields.

declinedDateTime string

The date and time the recipient declined the document.

deletedDateTime string

Specifies the data and time the item was deleted.

deliveredDateTime string

Reserved: For DocuSign use only.

documentsCombinedUri string
documentsUri string

Contains a URI for an endpoint that you can use to retrieve the documents.

emailBlurb string

This is the same as the email body. If specified it is included in email body for all envelope recipients.

emailSettings EnvelopeEmailSettings

A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent.

When the emailSettings information is used for an envelope, it only applies to that envelope.

IMPORTANT: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings.

EmailSettings consists of:

  • replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters.
  • replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters.
  • bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. Example: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.
emailSubject string

Specifies the subject of the email that is sent to all recipients.

See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

enableWetSign string

When set to true, the signer is allowed to print the document and sign it on paper.

enforceSignerVisibility string

When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

Your account must have Document Visibility enabled to use this.

envelopeId string

The envelope ID of the envelope status that failed to post.

envelopeIdStamping string

When set to true, Envelope ID Stamping is enabled.

envelopeUri string

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

initialSentDateTime string
is21CFRPart11 string

When set to true, indicates that this module is enabled on the account.

isSignatureProviderEnvelope string
lastModifiedDateTime string

The date and time the item was last modified.

lockInformation EnvelopeLocks
messageLock string

When set to true, prevents senders from changing the contents of emailBlurb and emailSubject properties for the envelope.

Additionally, this prevents users from making changes to the contents of emailBlurb and emailSubject properties when correcting envelopes.

However, if the messageLock node is set to true** and the emailSubject property is empty, senders and correctors are able to add a subject to the envelope.

notification notification

A complex element that specifies the notification options for the envelope. It consists of:

  • useAccountDefaults - When set to true, the account default notification settings are used for the envelope.
  • reminders - A complex element that specifies reminder settings for the envelope. It consists of:

    • reminderEnabled - When set to true, a reminder message is sent to the recipient.
    • reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.
    • reminderFrequency - An interger that sets the interval, in days, between reminder emails.
  • expirations - A complex element that specifies the expiration settings for the envelope. It consists of:

    • expireEnabled - When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.
    • expireAfter - An integer that sets the number of days the envelope is active.
    • expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.
notificationUri string

Contains a URI for an endpoint that you can use to retrieve the notifications.

purgeState string
recipients EnvelopeRecipients
recipientsLock string

When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.

recipientsUri string

Contains a URI for an endpoint that you can use to retrieve the recipients.

sentDateTime string

The date and time the envelope was sent.

signerCanSignOnMobile string
signingLocation string

Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.

status string

Indicates the envelope status. Valid values are:

  • created - The envelope is created as a draft. It can be modified and sent later.
  • sent - The envelope is sent to the recipients.
statusChangedDateTime string

The data and time the status changed.

templatesUri string

Contains a URI for an endpoint which you can use to retrieve the templates.

transactionId string

Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The transactionId property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.

useDisclosure string

When set to true, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to false, the Electronic Record and Signature Disclosure is not shown to any envelope recipients.

If the useDisclosure property is not set, then the account's normal disclosure setting is used and the value of the useDisclosure property is not returned in responses when getting envelope information.

voidedDateTime string

The date and time the envelope or template was voided.

voidedReason string

The reason the envelope or template was voided.

addressInformation

Contains address information.

city string

The city associated with the address.

country string

Specifies the country associated with the address.

fax string

A Fax number associated with the address if one is available.

phone string

A phone number associated with the address.

state string

The state or province associated with the address.

street1 string

The first line of the address.

street2 string

The second line of the address (optional).

zip string

The zip or postal code associated with the address.

addressInformationInput

Contains address input information.

addressInformation addressInformation

A complex type that contains the following information for the new account (all string content): address1, address2, city, country, fax, phone, postalCode and state.

Note: If country is US (United States) then State codes are validated for US States.

Otherwise, State is treated as a non-validated string and serves the purpose of entering a state/province/region. The maximum characters for the strings are:

  • address1, address2, city, country and state: 100 characters
  • postalCode, phone, and fax: 20 characters
displayLevelCode string

Specifies the display level for the recipient. Valid values are:

  • ReadOnly
  • Editable
  • DoNotDisplay
receiveInResponse string

When set to true, the information needs to be returned in the response.

agent

Contains information about agent recipients.

accessCode string

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmail string

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.

clientUserId string

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

customFields
[string]

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTime string

The date and time the recipient declined the document.

declinedReason string

The reason the recipient declined the document.

deliveredDateTime string

Reserved: For DocuSign use only.

deliveryMethod string

Reserved: For DocuSign use only.

documentVisibility
[documentVisibility]
email string

Email id of the recipient. Notification of the document to sign is sent to this email id.

Maximum length: 100 characters.

emailNotification recipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

emailRecipientPostSigningURL string
embeddedRecipientStartURL string

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetails errorDetails
excludedDocuments
[string]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

faxNumber string

Reserved:

idCheckConfigurationName string

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the smsAuthentication node.

idCheckInformationInput idCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
inheritEmailNotificationConfiguration string

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

name string
note string

A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen.

Maximum Length: 1000 characters.

phoneAuthentication recipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.
recipientAttachments
[recipientAttachment]

Reserved:

recipientAuthenticationStatus authenticationStatus
recipientId string

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuid string
requireIdLookup string

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

roleName string

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrder string

Specifies the routing order of the recipient in the envelope.

samlAuthentication recipientSAMLAuthentication

Contains the name/value pair information for the SAML assertion attributes:

  • name - The name of the SAML assertion attribute.
  • value - The value associated with the named SAML assertion attribute.

Your account must be set up to use SSO to use this.

sentDateTime string

The date and time the envelope was sent.

signedDateTime string

Reserved: For DocuSign use only.

signingGroupId string
signingGroupName string

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers
[userInfo]

A complex type that contains information about users in the signing group.

smsAuthentication recipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications
[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

status string

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.
templateLocked string

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequired string

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCount string
userId string

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

approve

A tab that allows the recipient to approve documents without placing a signature or initials on the document.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffset string

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffset string

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

bold string

When set to true, the information in the tab is bold.

buttonText string

Specifies the approval text displayed in the tab.

conditionalParentLabel string

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValue string

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabId string

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentId string

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.

fontColor string

The font color used for the information in the tab.

Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.

fontSize string

The font size used for the information in the tab.

Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.

height integer (int32)

Height of the tab in pixels.

italic string

When set to true, the information in the tab is italic.

mergeField mergeField
pageNumber string

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientId string

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

status string

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.
tabId string

The unique identifier for the tab.

tabLabel string

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrder string
templateLocked string

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequired string

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underline string

When set to true, the information in the tab is underlined.

width integer (int32)

Width of the tab in pixels.

xPosition string

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPosition string

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

attachment

Contains information about an attachment.

accessControl string
attachmentId string
attachmentType string

Specifies the type of the attachment for the recipient.

data string
label string
name string
remoteUrl string

authenticationStatus

Contains information about the authentication status.

accessCodeResult eventResult
ageVerifyResult eventResult
anySocialIDResult eventResult
facebookResult eventResult
googleResult eventResult
idLookupResult eventResult
idQuestionsResult eventResult
linkedinResult eventResult
liveIDResult eventResult
ofacResult eventResult
openIDResult eventResult
phoneAuthResult eventResult
salesforceResult eventResult
signatureProviderResult eventResult
smsAuthResult eventResult
sTANPinResult eventResult
twitterResult eventResult
yahooResult eventResult

bccEmailAddress

Contains information about the BCC email address.

bccEmailAddressId string

Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email.

Example: If your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.

email string

Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope.

Maximum of length: 100 characters.

carbonCopy

accessCode string

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmail string

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.

clientUserId string

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

customFields
[string]

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTime string

The date and time the recipient declined the document.

declinedReason string

The reason the recipient declined the document.

deliveredDateTime string

Reserved: For DocuSign use only.

deliveryMethod string

Reserved: For DocuSign use only.

documentVisibility
[documentVisibility]
email string

Email id of the recipient. Notification of the document to sign is sent to this email id.

Maximum length: 100 characters.

emailNotification recipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

emailRecipientPostSigningURL string
embeddedRecipientStartURL string

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetails errorDetails
excludedDocuments
[string]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

faxNumber string

Reserved:

idCheckConfigurationName string

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the smsAuthentication node.

idCheckInformationInput idCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
inheritEmailNotificationConfiguration string

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

name string

legal name of the recipient.

Maximum Length: 100 characters.

note string

A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen.

Maximum Length: 1000 characters.

phoneAuthentication recipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.
recipientAttachments
[recipientAttachment]

Reserved:

recipientAuthenticationStatus authenticationStatus
recipientId string

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuid string
requireIdLookup string

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

roleName string

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrder string

Specifies the routing order of the recipient in the envelope.

samlAuthentication recipientSAMLAuthentication
sentDateTime string

The date and time the envelope was sent.

signedDateTime string

Reserved: For DocuSign use only.

signingGroupId string
signingGroupName string

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers
[userInfo]

A complex type that contains information about users in the signing group.

smsAuthentication recipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications
[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

status string

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.
templateLocked string

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequired string

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCount string
userId string

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

certifiedDelivery

accessCode string

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.

Maximum Length: 50 characters and it must conform to the account's access code format setting.

If blank, but the signer accessCode property is set in the envelope, then that value is used.

If blank and the signer accessCode property is not set, then the access code is not required.

addAccessCodeToEmail string

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.

clientUserId string

Specifies whether the recipient is embedded or remote.

If the clientUserId property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.

Note: if the clientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.

Maximum length: 100 characters.

customFields
[string]

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

declinedDateTime string

The date and time the recipient declined the document.

declinedReason string

The reason the recipient declined the document.

deliveredDateTime string

Reserved: For DocuSign use only.

deliveryMethod string

Reserved: For DocuSign use only.

documentVisibility
[documentVisibility]
email string
emailNotification recipientEmailNotification

An optional complex type that sets a specific email subject and body for this recipient's notification email.

Note: If you use this field to set a specific email notification for one recipient, you must also set the email notification for the other recipients. Using this field for one or more recipients negates the Envelope Subject and EmailBlurb property settings.

emailRecipientPostSigningURL string
embeddedRecipientStartURL string

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.

If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.

It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.

If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

Example:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

errorDetails errorDetails
excludedDocuments
[string]

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.

When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

faxNumber string

Reserved:

idCheckConfigurationName string

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.

Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the smsAuthentication node.

idCheckInformationInput idCheckInformationInput

A complex element that contains input information related to a recipient ID check. It can include the following information.

addressInformationInput: Used to set recipient address information and consists of:

  • addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of:

  • dateOfBirth: Specifies the recipient's date, month and year of birth.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:

  • ssn4: Specifies the last four digits of the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
  • receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:

  • ssn9: Specifies the recipient's SSN.
  • displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
inheritEmailNotificationConfiguration string

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

name string
note string

A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen.

Maximum Length: 1000 characters.

phoneAuthentication recipientPhoneAuthentication

A complex type that Contains the elements:

  • recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose.
  • senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use.
  • recordVoicePrint - Reserved.
  • validateRecipProvidedNumber - Reserved.
recipientAttachments
[recipientAttachment]

Reserved:

recipientAuthenticationStatus authenticationStatus
recipientId string

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

recipientIdGuid string
requireIdLookup string

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

roleName string

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

routingOrder string

Specifies the routing order of the recipient in the envelope.

samlAuthentication recipientSAMLAuthentication
sentDateTime string

The date and time the envelope was sent.

signedDateTime string

Reserved: For DocuSign use only.

signingGroupId string
signingGroupName string

The display name for the signing group.

Maximum Length: 100 characters.

signingGroupUsers
[userInfo]

A complex type that contains information about users in the signing group.

smsAuthentication recipientSMSAuthentication

Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.

socialAuthentications
[socialAuthentication]

Lists the social ID type that can be used for recipient authentication.

status string

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.
templateLocked string

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequired string

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

totalTabCount string
userId string

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

checkbox

A tab that allows the recipient to select a yes/no (on/off) option.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffset string

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffset string

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

conditionalParentLabel string

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValue string

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabId string

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

documentId string

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetails errorDetails
locked string

When set to true, the signer cannot change the data of the custom tab.

mergeField mergeField
name string

Specifies the tool tip text for the tab.

pageNumber string

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientId string

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

required string

This property does not apply to checkbox tabs. Check boxes are always optional.

requireInitialOnSharedChange string

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

selected string

When set to true, the checkbox is selected.

shared string

When set to true, this custom tab is shared.

status string

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.
tabId string

The unique identifier for the tab.

tabLabel string

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrder string
templateLocked string

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequired string

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

xPosition string

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPosition string

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

company

A tab that displays the recipient's company name.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffset string

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffset string

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

bold string

When set to true, the information in the tab is bold.

concealValueOnDocument string

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabel string

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValue string

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabId string

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSize string

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentId string

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.

fontColor string

The font color used for the information in the tab.

Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.

fontSize string

The font size used for the information in the tab.

Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.

italic string

When set to true, the information in the tab is italic.

locked string

When set to true, the signer cannot change the data of the custom tab.

maxLength integer (int32)

An optional value that describes the maximum length of the property when the property is a string.

mergeField mergeField
name string

Specifies the tool tip text for the tab.

originalValue string

The initial value of the tab when it was sent to the recipient.

pageNumber string

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientId string

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

required string

When set to true, the signer is required to fill out this tab

status string

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.
tabId string

The unique identifier for the tab.

tabLabel string

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrder string
templateLocked string

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequired string

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underline string

When set to true, the information in the tab is underlined.

value string

Specifies the value of the tab.

width integer (int32)

Width of the tab in pixels.

xPosition string

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.

yPosition string

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

compositeTemplate

compositeTemplateId string

The identify of this composite template. It is used as a reference when adding document object information. If used, the document's content-disposition must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the documentId property only. If no document object is specified, the composite template inherits the first document.

document document
inlineTemplates
[inlineTemplate]

Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.

pdfMetaDataTemplateSequence string
serverTemplates
[serverTemplate]

0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value

date

A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format.

anchorCaseSensitive string

Reserved for DocuSign.

anchorHorizontalAlignment string

Reserved for DocuSign.

anchorIgnoreIfNotPresent string

When set to true, this tab is ignored if anchorString is not found in the document.

anchorMatchWholeWord string

Reserved for DocuSign.

anchorString string

Anchor text information for a radio button.

anchorUnits string

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

anchorXOffset string

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

anchorYOffset string

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

bold string

When set to true, the information in the tab is bold.

concealValueOnDocument string

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

conditionalParentLabel string

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

conditionalParentValue string

For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

customTabId string

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

disableAutoSize string

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

documentId string

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

errorDetails errorDetails
font string

The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.

fontColor string

The font color used for the information in the tab.

Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.

fontSize string

The font size used for the information in the tab.

Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.

italic string

When set to true, the information in the tab is italic.

locked string

When set to true, the signer cannot change the data of the custom tab.

maxLength integer (int32)

An optional value that describes the maximum length of the property when the property is a string.

mergeField mergeField
name string
originalValue string

The initial value of the tab when it was sent to the recipient.

pageNumber string

Specifies the page number on which the tab is located. Must be 1 for supplemental documents.

recipientId string

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

requireAll string

When set to true and shared is true, information must be entered in this field to complete the envelope.

required string

When set to true, the signer is required to fill out this tab

requireInitialOnSharedChange string

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

senderRequired string

When set to true, the sender must populate the tab before an envelope can be sent using the template.

This value tab can only be changed by modifying (PUT) the template.

Tabs with a senderRequired value of true cannot be deleted from an envelope.

shared string

When set to true, this custom tab is shared.

status string

Indicates the envelope status. Valid values are:

  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.
tabId string

The unique identifier for the tab.

tabLabel string

The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value.

Maximum of 500 characters.

tabOrder string
templateLocked string

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

templateRequired string

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

underline string

When set to true, the information in the tab is underlined.

validationMessage string

The message displayed if the custom tab fails input validation (either custom of embedded).

validationPattern string

A regular expressionn used to validate input for the tab.

value string

Specifies the value of the tab.

width integer (int32)

Width of the tab in pixels.

xPosition