Integrations
- Integrations
- 1Password
- Abnormal
- Absolute
- AbuseIPDB
- Acronis
- Adaptive Shield
- Adobe Cloud
- ADP
- Agari Phishing Response
- Airlock
- Airlock Digital
- Akamai Identity Cloud Social
- Alert Logic
- AlgoSec Firewall Analyzer
- Alienvault OTX
- Alienvault USM
- Anthropic
- Anodot
- Any Run
- Ansible
- Anvilogic
- Apex One
- ArcSight ESM
- Area 1
- Asana
- Asset Panda
- Atlassian Crowd
- Atlassian User Management
- Atlassian User Provisioning
- AuditBoard
- auth0
- Authentik
- Authomize
- Automox
- AWS
- AWS IAM Identity Center
- Axonius
- Azure
- Azure Data Explorer
- Azure DevOps
- Azure Log Analytics
- Azure Storage
- BambooHR
- Big Fix
- BigPanda
- Bitbucket
- Bitdefender
- Bitsight
- Bitwarden
- Black Duck
- Black Kite
- Blink
- BMC Remedy
- Box
- Brinqa
- Cato Networks
- Censys
- Chorus
- Cisco Advanced Phishing Protection
- Cisco Domain Protection
- Cisco Meraki
- Cisco Talos
- Cisco Umbrella
- Cisco Webex
- Claroty xDome
- ClearPass
- ClickHouse
- ClickUp
- Cloud Custodian
- Cloudflare
- Cloudflare R2
- Cobalt.io
- Check Point Harmony
- Check Point Infinity Events
- Check Point Management
- Check Point XDR/XPR
- Checkmarx SAST
- Checkmarx One
- Chronicle
- Compass
- Confluence
- Confluence Data Center
- Coralogix
- Coralogix Incident Management
- Cortex XDR
- Cortex Xpanse
- CredStash
- Cribl
- CrowdStrike
- CyberArk
- Cybersixgill
- CyCognito
- Cyera
- Cylance
- Cyware CTIX
- Darktrace
- Dasera
- Databricks
- Datadog
- DataSet
- Discord
- Docusign
- Delighted
- Delinea
- Devo
- Domo
- Drata
- Dropbox
- Dropbox Business
- druva
- Duo
- Duo Auth
- Dynatrace
- EasyVista
- EchoTrail
- Egnyte
- Egnyte Secure Govern
- Elasticsearch
- Entro
- Ermetic
- Exabeam
- Exchange Online
- Expel
- F5
- Falcon LogScale
- Falcon Surface
- Flare.io
- Forcepoint DLP
- Forescout
- FortiGate
- Freshservice
- GCP
- Gemini
- Ghostwriter
- Git
- GitHub
- GitLab
- Glean
- Gmail
- Google Calendar
- Google Chat
- Google Docs
- Google Drive
- Google Forms
- Google Meet
- Google Looker
- Google Sheets
- Google Workspace
- Grafana
- Greenhouse
- GreyNoise
- Grip Security
- GYTPOL
- Have I Been Pwned
- HackerOne
- Halo Service Desk
- HiBob
- HubSpot
- Hunters
- Hybrid Analysis
- Hyperproof
- IBM CLoud
- IBM NS1 Connect
- IBM X Force
- Imperva
- Incident.io
- Infobip
- Infoblox Cloud Services Portal
- Intercom
- Intezer
- IP API
- IPinfo
- IPWHOIS
- Ivanti RiskSense
- Ironscales
- Jamf
- JetBrains
- JFrog
- Jira
- Jira Data Center
- Joe Sandbox
- JumpCloud
- Kandji
- Keeper Secrets Manager
- Kenna Security
- KnowBe4
- KnowBe4 Events
- Kubernetes
- Lacework
- LaunchDarkly
- Linear
- Litmos
- LogicMonitor
- LogRhythm
- Manage Engine ServiceDesk Plus
- Mattermost
- Maven
- Microsoft Defender For Cloud
- Microsoft Defender For Cloud Apps
- Microsoft Defender For Endpoints
- Microsoft Defender XDR
- Microsoft E-Discovery
- Microsoft Entra ID
- Microsoft Graph
- Microsoft Intune
- Microsoft Office 365 Management Activity
- Microsoft Outlook
- Microsoft Purview
- Microsoft Sentinel
- Microsoft SQL Server
- Microsoft Teams
- Mimecast
- MISP
- Monday
- MongoDB Atlas
- MxToolbox
- Neo4j
- NetBox
- Netography
- Netskope
- New Relic
- Nightfall AI
- NinjaOne
- Notion
- Nozomi Networks
- Nuclei
- Nucleus
- Nutanix Hypervisor
- Obsidian
- Okta
- OneDrive
- OneLogin
- OneTrust
- Oort
- OpenAI
- OpenCTI
- Opsgenie
- OPSWAT
- Oracle Cloud
- Oracle HCM
- Orca Security
- OWASP ZAP
- PagerDuty
- Palo Alto NGFW
- Palo Alto Firewall
- Panther
- Pentera
- Perception Point
- PhishLabs
- PhishLabs Incident Data
- PhishLabs Open Web Monitoring
- Pingdom
- PingID
- PingOne
- PlexTrac
- PortSwigger
- Power BI
- PowerShell
- Postman
- Postman SCIM
- Prisma Access
- Prisma Cloud
- Prisma Cloud CWP
- Prometheus
- Proofpoint
- Proofpoint ITM
- Proofpoint Protection Server
- Proofpoint Security Awareness Training
- Proofpoint TAP
- Proofpoint TRAP
- Pub-Sub
- QRadar
- Qualys
- Rapid7
- Rapid7 InsightIDR
- Rapid7 InsightVM Cloud
- Rapid7 Threat Command
- Reco
- Recorded Future
- Recorded Future Triage Cloud
- Red Hat IDM
- Rippling
- runZero
- SafeBase
- Sage HR
- SailPoint
- SailPoint IdentityIQ
- Salesforce
- SAP Ariba
- ScienceLogic
- Securin
- Securin VI
- SecurityScorecard
- Securonix
- Sekoia.io
- SemGrep
- SentinelOne
- ServiceNow
- SharePoint
- Shodan
- Shopify
- Silverfort
- Slack
- Smartsheet
- Snipe IT
- Snowflake
- Snyk
- SolarWinds Service Desk
- SonarQube
- Sophos
- Split
- Splunk
- Splunk Observability
- Splunk SOAR
- Spur
- StrongDM
- Sumo Logic
- Symantec EDR
- Sysdig
- Tableau
- Tanium
- TeamCity
- TeamViewer
- Telegram
- Tenable
- Tenable Security Center
- Terraform
- Terraform Cloud
- Tessian
- TheHive
- Thinkst Canary
- ThreatQuotient
- Trellix Email Security
- Trello
- Trend Vision One
- Twilio
- UKG HR
- Uptycs
- URLScan
- Vault
- Veracode
- Verkada
- Vertica
- VMware vSphere
- VMware Carbon Black
- VirusTotal
- WeChat
- WhatsApp
- WhoIs
- WildFire
- Wiz
- Workday
- Workspace ONE UEM
- YesWeHack
- Zendesk
- Zero Networks
- Zoom
- Zscaler Internet Access
- Zscaler Private Access
Actions
Get Envelopes
Get a list of envelopes that match your request.
Note: Using this action requires to use at least one of the following parameters:
From Date
Envelope IDs
Transaction IDs
External Documentation
To learn more, visit the Docusign documentation.
Basic Parameters
Parameter | Description |
---|---|
Envelope IDs | Comma separated list of envelopeId values. |
From Date | The date and time to start looking for status changes. This parameter is required unless the parameters Envelope IDs or Transaction IDs are set. |
From To Status | The status value checked for in the From Date to To Date time period.For example:* If Changed is specified, then envelopes that changed status during the period will be returned.* If Created is specified, then envelopes created during the period are found. |
To Date | The date and time to stop looking for status changes. |
Advanced Parameters
Parameter | Description |
---|---|
Authoritative Copy Status | The Authoritative Copy Status for the envelopes. |
Custom Field | An envelope custom field name and value searched for in the envelopes.Format: custom_envelope_field_name=desired_value .Example: If you have an envelope custom field named “Region” and you want to search for all envelopes where the value is “West” you would use set this parameter to Region=West . |
Get only envelopes sent by the account user with this email address.User Name must be given as well, and both Email and User Name must refer to an existing account user. | |
Status | A list of current envelope statuses to included in the response. |
Transaction IDs | A comma separated list of envelope Transaction IDs . If included, this is a list of envelope Transaction IDs . |
Username | Get only envelopes sent by the account user with this user name.Email must be given as well, and both Email and User Name must refer to an existing account user. |
Example Output
{
"continuationToken": "string",
"endPosition": "The last position in the result set. ",
"envelopeTransactionStatuses": [
{
"envelopeId": "The envelope ID of the envelope status that failed to post.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"status": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.",
"transactionId": " 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."
}
],
"envelopes": [
{
"allowMarkup": "When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this",
"allowReassign": "When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.",
"allowViewHistory": "string",
"asynchronous": "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. \n\n\n**Note**: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is 'Processing' and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.",
"attachmentsUri": "string",
"authoritativeCopy": "Specifies whether all documents in this envelope are authoritative copies.\nA document can set its own `authoritativeCopy` property to override this value. For example you can set the `authoritativeCopy` on an envelope level to true but can turn it off for a specific document. ",
"authoritativeCopyDefault": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`.",
"autoNavigation": "When set to **true**, autonavigation is set for the recipient.",
"brandId": "The unique identifier of a brand.",
"brandLock": "string",
"certificateUri": "Retrieves a URI for an endpoint allowing you to easily retrieve certificate information.",
"completedDateTime": "Specifies the date and time this item was completed.",
"copyRecipientData": "string",
"createdDateTime": "Indicates the date and time the item was created.",
"customFields": {
"listCustomFields": [
{
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"fieldId": "An ID used to specify a custom field.",
"listItems": [
"string"
],
"name": "The name of the custom field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"show": "A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. ",
"value": "The value of the custom field.\n\nMaximum Length: 100 characters."
}
],
"textCustomFields": [
{
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"fieldId": "An ID used to specify a custom field.",
"name": "The name of the custom field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"show": "A boolean indicating if the value should be displayed. If this value is set to **true**, the custom field is displayed at the top of the certificate of completion. If this value is left blank/ or set to **false**, then it does not appear in the certificate of completion. ",
"value": "The value of the custom field."
}
]
},
"customFieldsUri": "Contains a URI for an endpoint to retrieve the custom fields.",
"declinedDateTime": "The date and time the recipient declined the document. Read only.",
"deletedDateTime": "Specifies the data and time the item was deleted.",
"deliveredDateTime": "Reserved: For DocuSign use only.",
"disableResponsiveDocument": "string",
"documentsCombinedUri": "string",
"documentsUri": "Contains a URI for an endpoint that you can use to retrieve the documents.",
"emailBlurb": "string",
"emailSettings": {
"bccEmailAddresses": [
{
"bccEmailAddressId": "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. \n \nExample: 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": "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.\n\nMaximum of length: 100 characters. "
}
],
"replyEmailAddressOverride": "string",
"replyEmailNameOverride": "string"
},
"emailSubject": "Specifies the subject of the email that is sent to all recipients.\n\nSee [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.",
"enableWetSign": "When set to **true**, the signer is allowed to print the document and sign it on paper.",
"enforceSignerVisibility": "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.\n\n###### Note: Your account must have Document Visibility enabled to use this.",
"envelopeId": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ",
"envelopeIdStamping": "When set to **true**, Envelope ID Stamping is enabled.",
"envelopeUri": "Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.",
"initialSentDateTime": "string",
"is21CFRPart11": "When set to **true**, indicates that this module is enabled on the account.",
"isSignatureProviderEnvelope": "string",
"lastModifiedDateTime": "The date and time the item was last modified.",
"lockInformation": {
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"lockDurationInSeconds": "Sets the time, in seconds, until the lock expires when there is no activity on the envelope.\n\nIf no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.\n\nThe lock duration can be extended.\n",
"lockToken": "A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.",
"lockType": "The type of envelope lock. Currently \"edit\" is the only supported type.",
"lockedByApp": "Specifies the friendly name of the application that is locking the envelope.",
"lockedByUser": {
"activationAccessCode": "string",
"email": "string",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"loginStatus": "string",
"sendActivationEmail": "string",
"uri": "string",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.",
"userName": "string",
"userStatus": "Status of the user's account. One of:\n\n* ActivationRequired\n* ActivationSent\n* Active\n* Closed\n* Disabled\n",
"userType": "string"
},
"lockedUntilDateTime": "The datetime until the envelope lock expires.",
"useScratchPad": "Reserved for future use.\n\nIndicates whether a scratchpad is used for editing information.\n "
},
"messageLock": "When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, 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": {
"expirations": {
"expireAfter": "An integer that sets the number of days the envelope is active.",
"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.",
"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."
},
"reminders": {
"reminderDelay": "An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.",
"reminderEnabled": "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.",
"reminderFrequency": "An interger that sets the interval, in days, between reminder emails."
},
"useAccountDefaults": "When set to **true**, the account default notification settings are used for the envelope."
},
"notificationUri": "Contains a URI for an endpoint that you can use to retrieve the notifications.",
"purgeState": "Shows the current purge state for the envelope. The possible values are:\n\n* `unpurged`: There has been no successful request to purge documents.\n* `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n* `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n* `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n* `documents_purged`: The envelope documents have been successfully purged.\n* `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n\n",
"recipients": {
"agents": [
{
"accessCode": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.",
"addAccessCodeToEmail": "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": "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. ",
"customFields": [
"string"
],
"declinedDateTime": "The date and time the recipient declined the document. Read only.",
"declinedReason": "The reason the recipient declined the document. Read only.",
"deliveredDateTime": "Reserved: For DocuSign use only.",
"deliveryMethod": "Reserved: For DocuSign use only.",
"documentVisibility": [
{
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"rights": "string",
"visible": "string"
}
],
"email": "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ",
"emailNotification": {
"emailBody": "Not applicable",
"emailSubject": "Not applicable",
"supportedLanguage": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. "
},
"emailRecipientPostSigningURL": "string",
"embeddedRecipientStartURL": "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]\u0026[[mergeField3]]` ",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"excludedDocuments": [
"string"
],
"faxNumber": "Reserved for DocuSign.",
"firstName": "The user's first name. \nMaximum Length: 50 characters.",
"fullName": "Reserved for DocuSign.",
"idCheckConfigurationName": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.",
"idCheckInformationInput": {
"addressInformationInput": {
"addressInformation": {
"city": "The city associated with the address.",
"country": "Specifies the country associated with the address.",
"fax": "A Fax number associated with the address if one is available.",
"phone": "A phone number associated with the address.",
"state": "The state or province associated with the address.",
"street1": "The first line of the address.",
"street2": "The second line of the address (optional).",
"zip": "The zip or postal code associated with the address.",
"zipPlus4": "string"
},
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"dobInformationInput": {
"dateOfBirth": "Specifies the recipient's date, month, and year of birth.",
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"ssn4InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response.",
"ssn4": "The last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"ssn9": " The recipient's Social Security Number(SSN)."
}
},
"identityVerification": {
"inputOptions": [
{
"name": "string",
"phoneNumberList": [
{
"countryCode": "string",
"extension": "string",
"number": "string"
}
],
"valueType": "string"
}
],
"workflowId": "string"
},
"inheritEmailNotificationConfiguration": "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. ",
"lastName": "The recipient's last name.",
"name": "string",
"note": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n",
"phoneAuthentication": {
"recipMayProvideNumber": "Boolean. When set to **true**, the recipient can supply a phone number their choice.",
"recordVoicePrint": "Reserved.",
"senderProvidedNumbers": [
"string"
],
"validateRecipProvidedNumber": " Reserved."
},
"recipientAttachments": [
{
"attachmentId": "string",
"attachmentType": "string",
"data": "string",
"label": "string",
"name": "string",
"remoteUrl": "string"
}
],
"recipientAuthenticationStatus": {
"accessCodeResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ageVerifyResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"anySocialIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"facebookResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"googleResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idLookupResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idQuestionsResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"identityVerificationResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"linkedinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"liveIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ofacResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"openIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"phoneAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"sTANPinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"salesforceResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"signatureProviderResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"smsAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"twitterResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"yahooResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"recipientIdGuid": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.",
"requireIdLookup": "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": "Optional element. Specifies the role name associated with the recipient.\u003cbr/\u003e\u003cbr/\u003eThis is required when working with template recipients.",
"routingOrder": "Specifies the routing order of the recipient in the envelope. ",
"samlAuthentication": {
"samlAssertionAttributes": [
{
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"value": "The value associated with the named SAML assertion attribute"
}
]
},
"sentDateTime": "The UTC DateTime when the envelope was sent. Read only.",
"signedDateTime": "Reserved for DocuSign.",
"signingGroupId": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ",
"signingGroupName": "The display name for the signing group. \n\nMaximum Length: 100 characters. ",
"signingGroupUsers": [
{
"activationAccessCode": "string",
"email": "string",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"loginStatus": "string",
"sendActivationEmail": "string",
"uri": "string",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.",
"userName": "string",
"userStatus": "Status of the user's account. One of:\n\n* ActivationRequired\n* ActivationSent\n* Active\n* Closed\n* Disabled\n",
"userType": "string"
}
],
"smsAuthentication": {
"senderProvidedNumbers": [
"string"
]
},
"socialAuthentications": [
{
"authentication": "Reserved: TBD"
}
],
"status": "Recipient status.\n\u003c!-- todo --\u003e\n",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"totalTabCount": "The total number of tabs in the documents. Read only.",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used."
}
],
"carbonCopies": [
{
"accessCode": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.",
"addAccessCodeToEmail": "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.",
"agentCanEditEmail": "string",
"agentCanEditName": "string",
"clientUserId": "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. ",
"customFields": [
"string"
],
"declinedDateTime": "The date and time the recipient declined the document. Read only.",
"declinedReason": "The reason the recipient declined the document. Read only.",
"deliveredDateTime": "Reserved: For DocuSign use only.",
"deliveryMethod": "Reserved: For DocuSign use only.",
"documentVisibility": [
{
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"rights": "string",
"visible": "string"
}
],
"email": "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ",
"emailNotification": {
"emailBody": "Not applicable",
"emailSubject": "Not applicable",
"supportedLanguage": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. "
},
"emailRecipientPostSigningURL": "string",
"embeddedRecipientStartURL": "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]\u0026[[mergeField3]]` ",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"excludedDocuments": [
"string"
],
"faxNumber": "Reserved for DocuSign.",
"firstName": "The user's first name. \nMaximum Length: 50 characters.",
"fullName": "Reserved for DocuSign.",
"idCheckConfigurationName": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.",
"idCheckInformationInput": {
"addressInformationInput": {
"addressInformation": {
"city": "The city associated with the address.",
"country": "Specifies the country associated with the address.",
"fax": "A Fax number associated with the address if one is available.",
"phone": "A phone number associated with the address.",
"state": "The state or province associated with the address.",
"street1": "The first line of the address.",
"street2": "The second line of the address (optional).",
"zip": "The zip or postal code associated with the address.",
"zipPlus4": "string"
},
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"dobInformationInput": {
"dateOfBirth": "Specifies the recipient's date, month, and year of birth.",
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"ssn4InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response.",
"ssn4": "The last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"ssn9": " The recipient's Social Security Number(SSN)."
}
},
"identityVerification": {
"inputOptions": [
{
"name": "string",
"phoneNumberList": [
{
"countryCode": "string",
"extension": "string",
"number": "string"
}
],
"valueType": "string"
}
],
"workflowId": "string"
},
"inheritEmailNotificationConfiguration": "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. ",
"lastName": "The recipient's last name.",
"name": "legal name of the recipient.\n\nMaximum Length: 100 characters.",
"note": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n",
"phoneAuthentication": {
"recipMayProvideNumber": "Boolean. When set to **true**, the recipient can supply a phone number their choice.",
"recordVoicePrint": "Reserved.",
"senderProvidedNumbers": [
"string"
],
"validateRecipProvidedNumber": " Reserved."
},
"proofFile": {
"isInProofFile": "string"
},
"recipientAttachments": [
{
"attachmentId": "string",
"attachmentType": "string",
"data": "string",
"label": "string",
"name": "string",
"remoteUrl": "string"
}
],
"recipientAuthenticationStatus": {
"accessCodeResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ageVerifyResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"anySocialIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"facebookResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"googleResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idLookupResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idQuestionsResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"identityVerificationResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"linkedinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"liveIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ofacResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"openIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"phoneAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"sTANPinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"salesforceResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"signatureProviderResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"smsAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"twitterResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"yahooResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"recipientIdGuid": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.",
"requireIdLookup": "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": "Optional element. Specifies the role name associated with the recipient.\u003cbr/\u003e\u003cbr/\u003eThis is required when working with template recipients.",
"routingOrder": "Specifies the routing order of the recipient in the envelope. ",
"samlAuthentication": {
"samlAssertionAttributes": [
{
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"value": "The value associated with the named SAML assertion attribute"
}
]
},
"sentDateTime": "The UTC DateTime when the envelope was sent. Read only.",
"signedDateTime": "Reserved for DocuSign.",
"signingGroupId": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ",
"signingGroupName": "The display name for the signing group. \n\nMaximum Length: 100 characters. ",
"signingGroupUsers": [
{
"activationAccessCode": "string",
"email": "string",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"loginStatus": "string",
"sendActivationEmail": "string",
"uri": "string",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.",
"userName": "string",
"userStatus": "Status of the user's account. One of:\n\n* ActivationRequired\n* ActivationSent\n* Active\n* Closed\n* Disabled\n",
"userType": "string"
}
],
"smsAuthentication": {
"senderProvidedNumbers": [
"string"
]
},
"socialAuthentications": [
{
"authentication": "Reserved: TBD"
}
],
"status": "Recipient status.\n\u003c!-- todo --\u003e\n",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"totalTabCount": "The total number of tabs in the documents. Read only.",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used."
}
],
"certifiedDeliveries": [
{
"accessCode": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.",
"addAccessCodeToEmail": "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.",
"agentCanEditEmail": "string",
"agentCanEditName": "string",
"clientUserId": "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. ",
"customFields": [
"string"
],
"declinedDateTime": "The date and time the recipient declined the document. Read only.",
"declinedReason": "The reason the recipient declined the document. Read only.",
"deliveredDateTime": "Reserved: For DocuSign use only.",
"deliveryMethod": "Reserved: For DocuSign use only.",
"documentVisibility": [
{
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"rights": "string",
"visible": "string"
}
],
"email": "string",
"emailNotification": {
"emailBody": "Not applicable",
"emailSubject": "Not applicable",
"supportedLanguage": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. "
},
"emailRecipientPostSigningURL": "string",
"embeddedRecipientStartURL": "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]\u0026[[mergeField3]]` ",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"excludedDocuments": [
"string"
],
"faxNumber": "Reserved for DocuSign.",
"firstName": "The user's first name. \nMaximum Length: 50 characters.",
"fullName": "Reserved for DocuSign.",
"idCheckConfigurationName": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.",
"idCheckInformationInput": {
"addressInformationInput": {
"addressInformation": {
"city": "The city associated with the address.",
"country": "Specifies the country associated with the address.",
"fax": "A Fax number associated with the address if one is available.",
"phone": "A phone number associated with the address.",
"state": "The state or province associated with the address.",
"street1": "The first line of the address.",
"street2": "The second line of the address (optional).",
"zip": "The zip or postal code associated with the address.",
"zipPlus4": "string"
},
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"dobInformationInput": {
"dateOfBirth": "Specifies the recipient's date, month, and year of birth.",
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"ssn4InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response.",
"ssn4": "The last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"ssn9": " The recipient's Social Security Number(SSN)."
}
},
"identityVerification": {
"inputOptions": [
{
"name": "string",
"phoneNumberList": [
{
"countryCode": "string",
"extension": "string",
"number": "string"
}
],
"valueType": "string"
}
],
"workflowId": "string"
},
"inheritEmailNotificationConfiguration": "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. ",
"lastName": "The recipient's last name.",
"name": "string",
"note": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n",
"phoneAuthentication": {
"recipMayProvideNumber": "Boolean. When set to **true**, the recipient can supply a phone number their choice.",
"recordVoicePrint": "Reserved.",
"senderProvidedNumbers": [
"string"
],
"validateRecipProvidedNumber": " Reserved."
},
"proofFile": {
"isInProofFile": "string"
},
"recipientAttachments": [
{
"attachmentId": "string",
"attachmentType": "string",
"data": "string",
"label": "string",
"name": "string",
"remoteUrl": "string"
}
],
"recipientAuthenticationStatus": {
"accessCodeResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ageVerifyResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"anySocialIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"facebookResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"googleResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idLookupResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idQuestionsResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"identityVerificationResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"linkedinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"liveIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ofacResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"openIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"phoneAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"sTANPinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"salesforceResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"signatureProviderResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"smsAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"twitterResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"yahooResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"recipientIdGuid": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.",
"requireIdLookup": "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": "Optional element. Specifies the role name associated with the recipient.\u003cbr/\u003e\u003cbr/\u003eThis is required when working with template recipients.",
"routingOrder": "Specifies the routing order of the recipient in the envelope. ",
"samlAuthentication": {
"samlAssertionAttributes": [
{
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"value": "The value associated with the named SAML assertion attribute"
}
]
},
"sentDateTime": "The UTC DateTime when the envelope was sent. Read only.",
"signedDateTime": "Reserved for DocuSign.",
"signingGroupId": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ",
"signingGroupName": "The display name for the signing group. \n\nMaximum Length: 100 characters. ",
"signingGroupUsers": [
{
"activationAccessCode": "string",
"email": "string",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"loginStatus": "string",
"sendActivationEmail": "string",
"uri": "string",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.",
"userName": "string",
"userStatus": "Status of the user's account. One of:\n\n* ActivationRequired\n* ActivationSent\n* Active\n* Closed\n* Disabled\n",
"userType": "string"
}
],
"smsAuthentication": {
"senderProvidedNumbers": [
"string"
]
},
"socialAuthentications": [
{
"authentication": "Reserved: TBD"
}
],
"status": "Recipient status.\n\u003c!-- todo --\u003e\n",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"totalTabCount": "The total number of tabs in the documents. Read only.",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used."
}
],
"currentRoutingOrder": "string",
"editors": [
{
"accessCode": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.",
"addAccessCodeToEmail": "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": "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. ",
"customFields": [
"string"
],
"declinedDateTime": "The date and time the recipient declined the document. Read only.",
"declinedReason": "The reason the recipient declined the document. Read only.",
"deliveredDateTime": "Reserved: For DocuSign use only.",
"deliveryMethod": "Reserved: For DocuSign use only.",
"documentVisibility": [
{
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"rights": "string",
"visible": "string"
}
],
"email": "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ",
"emailNotification": {
"emailBody": "Not applicable",
"emailSubject": "Not applicable",
"supportedLanguage": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. "
},
"emailRecipientPostSigningURL": "string",
"embeddedRecipientStartURL": "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]\u0026[[mergeField3]]` ",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"faxNumber": "Reserved for DocuSign.",
"firstName": "The user's first name. \nMaximum Length: 50 characters.",
"fullName": "Reserved for DocuSign.",
"idCheckConfigurationName": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.",
"idCheckInformationInput": {
"addressInformationInput": {
"addressInformation": {
"city": "The city associated with the address.",
"country": "Specifies the country associated with the address.",
"fax": "A Fax number associated with the address if one is available.",
"phone": "A phone number associated with the address.",
"state": "The state or province associated with the address.",
"street1": "The first line of the address.",
"street2": "The second line of the address (optional).",
"zip": "The zip or postal code associated with the address.",
"zipPlus4": "string"
},
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"dobInformationInput": {
"dateOfBirth": "Specifies the recipient's date, month, and year of birth.",
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"ssn4InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response.",
"ssn4": "The last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"ssn9": " The recipient's Social Security Number(SSN)."
}
},
"identityVerification": {
"inputOptions": [
{
"name": "string",
"phoneNumberList": [
{
"countryCode": "string",
"extension": "string",
"number": "string"
}
],
"valueType": "string"
}
],
"workflowId": "string"
},
"inheritEmailNotificationConfiguration": "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. ",
"lastName": "The recipient's last name.",
"name": "legal name of the recipient.\n\nMaximum Length: 100 characters.",
"note": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n",
"phoneAuthentication": {
"recipMayProvideNumber": "Boolean. When set to **true**, the recipient can supply a phone number their choice.",
"recordVoicePrint": "Reserved.",
"senderProvidedNumbers": [
"string"
],
"validateRecipProvidedNumber": " Reserved."
},
"recipientAttachments": [
{
"attachmentId": "string",
"attachmentType": "string",
"data": "string",
"label": "string",
"name": "string",
"remoteUrl": "string"
}
],
"recipientAuthenticationStatus": {
"accessCodeResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ageVerifyResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"anySocialIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"facebookResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"googleResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idLookupResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idQuestionsResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"identityVerificationResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"linkedinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"liveIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ofacResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"openIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"phoneAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"sTANPinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"salesforceResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"signatureProviderResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"smsAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"twitterResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"yahooResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"recipientIdGuid": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.",
"requireIdLookup": "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": "Optional element. Specifies the role name associated with the recipient.\u003cbr/\u003e\u003cbr/\u003eThis is required when working with template recipients.",
"routingOrder": "Specifies the routing order of the recipient in the envelope. ",
"samlAuthentication": {
"samlAssertionAttributes": [
{
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"value": "The value associated with the named SAML assertion attribute"
}
]
},
"sentDateTime": "The UTC DateTime when the envelope was sent. Read only.",
"signedDateTime": "Reserved for DocuSign.",
"signingGroupId": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ",
"signingGroupName": "The display name for the signing group. \n\nMaximum Length: 100 characters. ",
"signingGroupUsers": [
{
"activationAccessCode": "string",
"email": "string",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"loginStatus": "string",
"sendActivationEmail": "string",
"uri": "string",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.",
"userName": "string",
"userStatus": "Status of the user's account. One of:\n\n* ActivationRequired\n* ActivationSent\n* Active\n* Closed\n* Disabled\n",
"userType": "string"
}
],
"smsAuthentication": {
"senderProvidedNumbers": [
"string"
]
},
"socialAuthentications": [
{
"authentication": "Reserved: TBD"
}
],
"status": "Recipient status.\n\u003c!-- todo --\u003e\n",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"totalTabCount": "The total number of tabs in the documents. Read only.",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used."
}
],
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"inPersonSigners": [
{
"accessCode": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.",
"addAccessCodeToEmail": "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.",
"autoNavigation": "When set to **true**, autonavigation is set for the recipient.",
"canSignOffline": "When set to **true**, specifies that the signer can perform the signing ceremony offline.",
"clientUserId": "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. ",
"creationReason": "The reason why the recipient was created (for example, `sender`). Read only.",
"customFields": [
"string"
],
"declinedDateTime": "The date and time the recipient declined the document. Read only.",
"declinedReason": "The reason the recipient declined the document. Read only.",
"defaultRecipient": "When set to **true**,\nthis is the default recipient for the envelope.\nThis option is used when creating an envelope from a template.\n",
"deliveredDateTime": "Reserved: For DocuSign use only.",
"deliveryMethod": "Reserved: For DocuSign use only.",
"documentVisibility": [
{
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"rights": "string",
"visible": "string"
}
],
"email": "The signer's email address in an eNotary flow.\n\nUse only when `inPersonSigningType` is `notary`.\nFor regular in-person-signer flow, use `signerEmail` instead.\n",
"emailNotification": {
"emailBody": "Not applicable",
"emailSubject": "Not applicable",
"supportedLanguage": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. "
},
"embeddedRecipientStartURL": "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]\u0026[[mergeField3]]` ",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"excludedDocuments": [
"string"
],
"faxNumber": "Reserved for DocuSign.",
"hostEmail": "The email address of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n",
"hostName": "The name of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n",
"idCheckConfigurationName": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.",
"idCheckInformationInput": {
"addressInformationInput": {
"addressInformation": {
"city": "The city associated with the address.",
"country": "Specifies the country associated with the address.",
"fax": "A Fax number associated with the address if one is available.",
"phone": "A phone number associated with the address.",
"state": "The state or province associated with the address.",
"street1": "The first line of the address.",
"street2": "The second line of the address (optional).",
"zip": "The zip or postal code associated with the address.",
"zipPlus4": "string"
},
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"dobInformationInput": {
"dateOfBirth": "Specifies the recipient's date, month, and year of birth.",
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"ssn4InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response.",
"ssn4": "The last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"ssn9": " The recipient's Social Security Number(SSN)."
}
},
"identityVerification": {
"inputOptions": [
{
"name": "string",
"phoneNumberList": [
{
"countryCode": "string",
"extension": "string",
"number": "string"
}
],
"valueType": "string"
}
],
"workflowId": "string"
},
"inPersonSigningType": "Specifies whether the envelope uses the eNotary feature.\nValid values:\n\n* `inPersonSigner` The envelope uses the normal in-person signing flow.\n* `notary`: The envelope uses the eNotary in-person signing flow.\n",
"inheritEmailNotificationConfiguration": "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": "The signer's full legal name in an eNotary flow.\n\nRequired when `inPersonSigningType` is `notary`.\nFor regular in-person-signer flow, use `signerName` instead.\n\nMaximum Length: 100 characters.\n",
"notaryHost": {
"accessCode": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.",
"addAccessCodeToEmail": "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": "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. ",
"customFields": [
"string"
],
"declinedDateTime": "The date and time the recipient declined the document. Read only.",
"declinedReason": "The reason the recipient declined the document. Read only.",
"deliveredDateTime": "Reserved: For DocuSign use only.",
"deliveryMethod": "Reserved: For DocuSign use only.",
"documentVisibility": [
{
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"rights": "string",
"visible": "string"
}
],
"email": "The notary's email address.\n\nMaximum Length: 100 characters.\n",
"emailNotification": {
"emailBody": "Not applicable",
"emailSubject": "Not applicable",
"supportedLanguage": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. "
},
"embeddedRecipientStartURL": "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]\u0026[[mergeField3]]` ",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"faxNumber": "Reserved for DocuSign.",
"hostRecipientId": "string",
"idCheckConfigurationName": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.",
"idCheckInformationInput": {
"addressInformationInput": {
"addressInformation": {
"city": "The city associated with the address.",
"country": "Specifies the country associated with the address.",
"fax": "A Fax number associated with the address if one is available.",
"phone": "A phone number associated with the address.",
"state": "The state or province associated with the address.",
"street1": "The first line of the address.",
"street2": "The second line of the address (optional).",
"zip": "The zip or postal code associated with the address.",
"zipPlus4": "string"
},
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"dobInformationInput": {
"dateOfBirth": "Specifies the recipient's date, month, and year of birth.",
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"ssn4InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response.",
"ssn4": "The last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"ssn9": " The recipient's Social Security Number(SSN)."
}
},
"identityVerification": {
"inputOptions": [
{
"name": "string",
"phoneNumberList": [
{
"countryCode": "string",
"extension": "string",
"number": "string"
}
],
"valueType": "string"
}
],
"workflowId": "string"
},
"inheritEmailNotificationConfiguration": "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": "The notary's full legal name.\n\nMaximum Length: 100 characters.\n",
"note": "A note sent to the notary in the signing email.\nThis note is visible only to this notary.\n\nMaximum Length: 1000 characters.\n",
"phoneAuthentication": {
"recipMayProvideNumber": "Boolean. When set to **true**, the recipient can supply a phone number their choice.",
"recordVoicePrint": "Reserved.",
"senderProvidedNumbers": [
"string"
],
"validateRecipProvidedNumber": " Reserved."
},
"recipientAttachments": [
{
"attachmentId": "string",
"attachmentType": "string",
"data": "string",
"label": "string",
"name": "string",
"remoteUrl": "string"
}
],
"recipientAuthenticationStatus": {
"accessCodeResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ageVerifyResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"anySocialIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"facebookResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"googleResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idLookupResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idQuestionsResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"identityVerificationResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"linkedinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"liveIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ofacResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"openIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"phoneAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"sTANPinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"salesforceResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"signatureProviderResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"smsAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"twitterResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"yahooResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"recipientIdGuid": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.",
"requireIdLookup": "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": "Optional element. Specifies the role name associated with the recipient.\u003cbr/\u003e\u003cbr/\u003eThis is required when working with template recipients.",
"routingOrder": "Specifies the routing order of the recipient in the envelope. ",
"samlAuthentication": {
"samlAssertionAttributes": [
{
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"value": "The value associated with the named SAML assertion attribute"
}
]
},
"sentDateTime": "The UTC DateTime when the envelope was sent. Read only.",
"signedDateTime": "Reserved for DocuSign.",
"smsAuthentication": {
"senderProvidedNumbers": [
"string"
]
},
"socialAuthentications": [
{
"authentication": "Reserved: TBD"
}
],
"status": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.",
"tabs": {
"approveTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": " Specifies the approval text displayed in the tab. ",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"checkboxTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "This property does not apply to `checkbox` tabs. Check boxes are always optional.",
"selected": "When set to **true**, the checkbox is selected.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n"
}
],
"companyTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"dateSignedTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"dateTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"declineTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": " Specifies the decline text displayed in the tab.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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.",
"declineReason": "The reason the recipient declined the document.",
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"emailAddressTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"emailTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"envelopeIdTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"firstNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"formulaTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"hidden": "If this is a regular formula (no `paymentDetails` property is present):\n\n* **true**: The tab is hidden.\n* **false**: The tab is shown.\n\nIf the formula is payment item (a `paymentDetails` property is present):\n\n* **true**: The tab is displayed as a payment.\n* **false**: The tab is displayed as a regular formula.\n",
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"paymentDetails": {
"allowedPaymentMethods": [
"string"
],
"chargeId": "The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment.",
"currencyCode": "Specifies the three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nSupported currencies are:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nSpecifying any other ISO 4217 code for payments is an error.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n",
"customMetadata": "string",
"customMetadataRequired": false,
"customerId": "string",
"gatewayAccountId": "A GUID that identifies the payment gateway\nconnected to the sender's DocuSign account.\n\nThere is no public API\nfor connecting payment gateway accounts\nYou must connect and manage payment gateway accounts\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\n\nYou can get the gateway account ID\nin the Payments section\nof the DocuSign Admin console.\n\n\n[paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways\n",
"gatewayDisplayName": "Display name of the gateway connected to sender's Docusign account.\n\nPossible values are: Stripe, Braintree, Authorize.Net.",
"gatewayName": "Name of the gateway connected to sender's DocuSign account.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`",
"lineItems": [
{
"amountReference": "This is a the `tabLabel`\nthat specifies the amount paid\nfor the line items.\n\n",
"description": "A sender-defined description of the line item.\n",
"itemCode": "This is the sender-defined\nSKU, inventory number, or other item code\nfor the line item.\n",
"name": "This is a sender-defined\nproduct name, service name,\nor other designation for the line item.\n"
}
],
"paymentOption": "string",
"paymentSourceId": "string",
"signerValues": {
"paymentOption": "string"
},
"status": "This read-only property describes the status of a payment.\n\n* `new`\u003cbr\u003e\n This is a new payment request.\n The envelope has been created,\n but no payment authorizations have been made.\n\n* `auth_complete`\u003cbr\u003e\n A recipient has entered their credit card information,\n but the envelope has not been completed.\n The card has not been charged.\n\n* `payment_complete`\u003cbr\u003e\n The recipient's card has been charged.\n\n* `payment_capture_failed`\u003cbr\u003e\n Final charge failed.\n This can happen when too much time\n passes between authorizing the payment\n and completing the document.\n",
"total": {
"amountInBaseUnit": "The total payment amount\nin the currency's base unit.\nFor example, for USD\nthe base currency is one cent.\n",
"currency": "The three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n",
"displayAmount": "The payment amount as displayed\nin the `currency`.\n\nFor example, if the payment amount\nis USD 12.59,\nthe `amountInBaseUnit` is 1259 (cents),\nand the displayed amount is `$12.59 USD`.\n\nThis is a read-only property.\n"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"roundDecimalPlaces": "string",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n"
}
],
"fullNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"initialHereTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -23)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -23)\n"
}
],
"lastNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"listTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"listItems": [
{
"selected": "When set to **true**, indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default.",
"text": "Specifies the text that is shown in the dropdown list. ",
"value": "Specifies the value that is used when the list item is selected."
}
],
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "The value to use when the item is selected.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"notarizeTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "string",
"documentId": "The ID of the document being accessed.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "The page number being accessed.",
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n"
}
],
"noteTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"numberTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"radioGroupTabs": [
{
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"groupName": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.",
"radios": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"required": "When set to **true**, the signer is required to fill out this tab",
"selected": "When set to **true**, the radio button is selected.",
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"shared": "When set to **true**, this custom tab is shared.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string"
}
],
"signHereTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"stampType": "string",
"stampTypeMetadata": {
"options": [
"string"
],
"rights": "string"
},
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -27)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -27)\n"
}
],
"signerAttachmentTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n"
}
],
"smartSectionTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"caseSensitive": false,
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "string",
"displaySettings": {
"cellStyle": "string",
"collapsibleSettings": {
"arrowClosed": "string",
"arrowColor": "string",
"arrowLocation": "string",
"arrowOpen": "string",
"arrowSize": "string",
"arrowStyle": "string",
"containerStyle": "string",
"labelStyle": "string",
"onlyArrowIsClickable": false,
"outerLabelAndArrowStyle": "string"
},
"display": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`\u003cbr\u003e\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`\u003cbr\u003e\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`\u003cbr\u003e\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n",
"displayLabel": "string",
"displayOrder": 0,
"displayPageNumber": 0,
"hideLabelWhenOpened": false,
"inlineOuterStyle": "string",
"labelWhenOpened": "string",
"preLabel": "string",
"scrollToTopWhenOpened": false,
"tableStyle": "string"
},
"documentId": "The ID of the document being accessed.",
"endAnchor": "string",
"endPosition": {
"pageNumber": 0,
"xPosition": 0,
"yPosition": 0
},
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "The page number being accessed.",
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"removeEndAnchor": false,
"removeStartAnchor": false,
"startAnchor": "string",
"startPosition": {
"pageNumber": 0,
"xPosition": 0,
"yPosition": 0
},
"status": "Item status. \u003c!-- TODO --\u003e",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"ssnTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"textTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"height": 0,
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"titleTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"viewTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": "string",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"requiredRead": "string",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n"
}
],
"zipTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"useDash4": "string",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
]
},
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"totalTabCount": "The total number of tabs in the documents. Read only.",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used."
},
"note": "A note sent to the in-person signer in the signing email.\nThis note is visible only to this recipient.\n\nMaximum Length: 1000 characters.\n",
"phoneAuthentication": {
"recipMayProvideNumber": "Boolean. When set to **true**, the recipient can supply a phone number their choice.",
"recordVoicePrint": "Reserved.",
"senderProvidedNumbers": [
"string"
],
"validateRecipProvidedNumber": " Reserved."
},
"recipientAttachments": [
{
"attachmentId": "string",
"attachmentType": "string",
"data": "string",
"label": "string",
"name": "string",
"remoteUrl": "string"
}
],
"recipientAuthenticationStatus": {
"accessCodeResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ageVerifyResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"anySocialIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"facebookResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"googleResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idLookupResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idQuestionsResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"identityVerificationResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"linkedinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"liveIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ofacResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"openIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"phoneAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"sTANPinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"salesforceResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"signatureProviderResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"smsAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"twitterResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"yahooResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"recipientIdGuid": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.",
"recipientSignatureProviders": [
{
"sealDocumentsWithTabsOnly": "By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.\n\nTo apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. ",
"sealName": "Indicates the name of the electronic seal to apply on documents.\n",
"signatureProviderName": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)",
"signatureProviderOptions": {
"cpfNumber": "Reserved for DocuSign",
"oneTimePassword": "A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.",
"signerRole": "The role or capacity of the signing recipient. Examples: Manager, Approver, etc.",
"sms": "The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234."
}
}
],
"recipientSuppliesTabs": "When set to **true**, specifies that the recipient creates the tabs.",
"requireIdLookup": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ",
"requireSignOnPaper": "When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.",
"requireSignerCertificate": "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate.",
"roleName": "Optional element. Specifies the role name associated with the recipient.\u003cbr/\u003e\u003cbr/\u003eThis is required when working with template recipients.",
"routingOrder": "Specifies the routing order of the recipient in the envelope. ",
"samlAuthentication": {
"samlAssertionAttributes": [
{
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"value": "The value associated with the named SAML assertion attribute"
}
]
},
"sentDateTime": "The UTC DateTime when the envelope was sent. Read only.",
"signInEachLocation": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).",
"signatureInfo": {
"fontStyle": "string",
"signatureInitials": "string",
"signatureName": "Specifies the user signature name."
},
"signedDateTime": "Reserved for DocuSign.",
"signerEmail": "The in-person signer's email address.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n\n",
"signerName": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n",
"signingGroupId": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ",
"signingGroupName": "The display name for the signing group. \n\nMaximum Length: 100 characters. ",
"signingGroupUsers": [
{
"activationAccessCode": "string",
"email": "string",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"loginStatus": "string",
"sendActivationEmail": "string",
"uri": "string",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.",
"userName": "string",
"userStatus": "Status of the user's account. One of:\n\n* ActivationRequired\n* ActivationSent\n* Active\n* Closed\n* Disabled\n",
"userType": "string"
}
],
"smsAuthentication": {
"senderProvidedNumbers": [
"string"
]
},
"socialAuthentications": [
{
"authentication": "Reserved: TBD"
}
],
"status": "Recipient status.\n\u003c!-- todo --\u003e\n",
"tabs": {
"approveTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": " Specifies the approval text displayed in the tab. ",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"checkboxTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "This property does not apply to `checkbox` tabs. Check boxes are always optional.",
"selected": "When set to **true**, the checkbox is selected.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n"
}
],
"companyTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"dateSignedTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"dateTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"declineTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": " Specifies the decline text displayed in the tab.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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.",
"declineReason": "The reason the recipient declined the document.",
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"emailAddressTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"emailTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"envelopeIdTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"firstNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"formulaTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"hidden": "If this is a regular formula (no `paymentDetails` property is present):\n\n* **true**: The tab is hidden.\n* **false**: The tab is shown.\n\nIf the formula is payment item (a `paymentDetails` property is present):\n\n* **true**: The tab is displayed as a payment.\n* **false**: The tab is displayed as a regular formula.\n",
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"paymentDetails": {
"allowedPaymentMethods": [
"string"
],
"chargeId": "The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment.",
"currencyCode": "Specifies the three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nSupported currencies are:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nSpecifying any other ISO 4217 code for payments is an error.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n",
"customMetadata": "string",
"customMetadataRequired": false,
"customerId": "string",
"gatewayAccountId": "A GUID that identifies the payment gateway\nconnected to the sender's DocuSign account.\n\nThere is no public API\nfor connecting payment gateway accounts\nYou must connect and manage payment gateway accounts\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\n\nYou can get the gateway account ID\nin the Payments section\nof the DocuSign Admin console.\n\n\n[paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways\n",
"gatewayDisplayName": "Display name of the gateway connected to sender's Docusign account.\n\nPossible values are: Stripe, Braintree, Authorize.Net.",
"gatewayName": "Name of the gateway connected to sender's DocuSign account.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`",
"lineItems": [
{
"amountReference": "This is a the `tabLabel`\nthat specifies the amount paid\nfor the line items.\n\n",
"description": "A sender-defined description of the line item.\n",
"itemCode": "This is the sender-defined\nSKU, inventory number, or other item code\nfor the line item.\n",
"name": "This is a sender-defined\nproduct name, service name,\nor other designation for the line item.\n"
}
],
"paymentOption": "string",
"paymentSourceId": "string",
"signerValues": {
"paymentOption": "string"
},
"status": "This read-only property describes the status of a payment.\n\n* `new`\u003cbr\u003e\n This is a new payment request.\n The envelope has been created,\n but no payment authorizations have been made.\n\n* `auth_complete`\u003cbr\u003e\n A recipient has entered their credit card information,\n but the envelope has not been completed.\n The card has not been charged.\n\n* `payment_complete`\u003cbr\u003e\n The recipient's card has been charged.\n\n* `payment_capture_failed`\u003cbr\u003e\n Final charge failed.\n This can happen when too much time\n passes between authorizing the payment\n and completing the document.\n",
"total": {
"amountInBaseUnit": "The total payment amount\nin the currency's base unit.\nFor example, for USD\nthe base currency is one cent.\n",
"currency": "The three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n",
"displayAmount": "The payment amount as displayed\nin the `currency`.\n\nFor example, if the payment amount\nis USD 12.59,\nthe `amountInBaseUnit` is 1259 (cents),\nand the displayed amount is `$12.59 USD`.\n\nThis is a read-only property.\n"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"roundDecimalPlaces": "string",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n"
}
],
"fullNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"initialHereTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -23)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -23)\n"
}
],
"lastNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"listTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"listItems": [
{
"selected": "When set to **true**, indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default.",
"text": "Specifies the text that is shown in the dropdown list. ",
"value": "Specifies the value that is used when the list item is selected."
}
],
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "The value to use when the item is selected.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"notarizeTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "string",
"documentId": "The ID of the document being accessed.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "The page number being accessed.",
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n"
}
],
"noteTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"numberTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"radioGroupTabs": [
{
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"groupName": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.",
"radios": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"required": "When set to **true**, the signer is required to fill out this tab",
"selected": "When set to **true**, the radio button is selected.",
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"shared": "When set to **true**, this custom tab is shared.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string"
}
],
"signHereTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"stampType": "string",
"stampTypeMetadata": {
"options": [
"string"
],
"rights": "string"
},
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -27)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -27)\n"
}
],
"signerAttachmentTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n"
}
],
"smartSectionTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"caseSensitive": false,
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "string",
"displaySettings": {
"cellStyle": "string",
"collapsibleSettings": {
"arrowClosed": "string",
"arrowColor": "string",
"arrowLocation": "string",
"arrowOpen": "string",
"arrowSize": "string",
"arrowStyle": "string",
"containerStyle": "string",
"labelStyle": "string",
"onlyArrowIsClickable": false,
"outerLabelAndArrowStyle": "string"
},
"display": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`\u003cbr\u003e\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`\u003cbr\u003e\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`\u003cbr\u003e\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n",
"displayLabel": "string",
"displayOrder": 0,
"displayPageNumber": 0,
"hideLabelWhenOpened": false,
"inlineOuterStyle": "string",
"labelWhenOpened": "string",
"preLabel": "string",
"scrollToTopWhenOpened": false,
"tableStyle": "string"
},
"documentId": "The ID of the document being accessed.",
"endAnchor": "string",
"endPosition": {
"pageNumber": 0,
"xPosition": 0,
"yPosition": 0
},
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "The page number being accessed.",
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"removeEndAnchor": false,
"removeStartAnchor": false,
"startAnchor": "string",
"startPosition": {
"pageNumber": 0,
"xPosition": 0,
"yPosition": 0
},
"status": "Item status. \u003c!-- TODO --\u003e",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"ssnTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"textTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"height": 0,
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"titleTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"viewTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": "string",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"requiredRead": "string",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n"
}
],
"zipTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"useDash4": "string",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
]
},
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"totalTabCount": "The total number of tabs in the documents. Read only.",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used."
}
],
"intermediaries": [
{
"accessCode": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.",
"addAccessCodeToEmail": "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": "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. ",
"customFields": [
"string"
],
"declinedDateTime": "The date and time the recipient declined the document. Read only.",
"declinedReason": "The reason the recipient declined the document. Read only.",
"deliveredDateTime": "Reserved: For DocuSign use only.",
"deliveryMethod": "Reserved: For DocuSign use only.",
"documentVisibility": [
{
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"rights": "string",
"visible": "string"
}
],
"email": "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ",
"emailNotification": {
"emailBody": "Not applicable",
"emailSubject": "Not applicable",
"supportedLanguage": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. "
},
"emailRecipientPostSigningURL": "string",
"embeddedRecipientStartURL": "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]\u0026[[mergeField3]]` ",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"excludedDocuments": [
"string"
],
"faxNumber": "Reserved for DocuSign.",
"firstName": "The user's first name. \nMaximum Length: 50 characters.",
"fullName": "Reserved for DocuSign.",
"idCheckConfigurationName": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.",
"idCheckInformationInput": {
"addressInformationInput": {
"addressInformation": {
"city": "The city associated with the address.",
"country": "Specifies the country associated with the address.",
"fax": "A Fax number associated with the address if one is available.",
"phone": "A phone number associated with the address.",
"state": "The state or province associated with the address.",
"street1": "The first line of the address.",
"street2": "The second line of the address (optional).",
"zip": "The zip or postal code associated with the address.",
"zipPlus4": "string"
},
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"dobInformationInput": {
"dateOfBirth": "Specifies the recipient's date, month, and year of birth.",
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"ssn4InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response.",
"ssn4": "The last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"ssn9": " The recipient's Social Security Number(SSN)."
}
},
"identityVerification": {
"inputOptions": [
{
"name": "string",
"phoneNumberList": [
{
"countryCode": "string",
"extension": "string",
"number": "string"
}
],
"valueType": "string"
}
],
"workflowId": "string"
},
"inheritEmailNotificationConfiguration": "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. ",
"lastName": "The recipient's last name.",
"name": "string",
"note": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n",
"phoneAuthentication": {
"recipMayProvideNumber": "Boolean. When set to **true**, the recipient can supply a phone number their choice.",
"recordVoicePrint": "Reserved.",
"senderProvidedNumbers": [
"string"
],
"validateRecipProvidedNumber": " Reserved."
},
"recipientAttachments": [
{
"attachmentId": "string",
"attachmentType": "string",
"data": "string",
"label": "string",
"name": "string",
"remoteUrl": "string"
}
],
"recipientAuthenticationStatus": {
"accessCodeResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ageVerifyResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"anySocialIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"facebookResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"googleResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idLookupResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idQuestionsResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"identityVerificationResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"linkedinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"liveIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ofacResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"openIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"phoneAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"sTANPinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"salesforceResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"signatureProviderResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"smsAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"twitterResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"yahooResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"recipientIdGuid": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.",
"requireIdLookup": "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": "Optional element. Specifies the role name associated with the recipient.\u003cbr/\u003e\u003cbr/\u003eThis is required when working with template recipients.",
"routingOrder": "Specifies the routing order of the recipient in the envelope. ",
"samlAuthentication": {
"samlAssertionAttributes": [
{
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"value": "The value associated with the named SAML assertion attribute"
}
]
},
"sentDateTime": "The UTC DateTime when the envelope was sent. Read only.",
"signedDateTime": "Reserved for DocuSign.",
"signingGroupId": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).",
"signingGroupName": "The display name for the signing group. \n\nMaximum Length: 100 characters. ",
"signingGroupUsers": [
{
"activationAccessCode": "string",
"email": "string",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"loginStatus": "string",
"sendActivationEmail": "string",
"uri": "string",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.",
"userName": "string",
"userStatus": "Status of the user's account. One of:\n\n* ActivationRequired\n* ActivationSent\n* Active\n* Closed\n* Disabled\n",
"userType": "string"
}
],
"smsAuthentication": {
"senderProvidedNumbers": [
"string"
]
},
"socialAuthentications": [
{
"authentication": "Reserved: TBD"
}
],
"status": "Recipient status.\n\u003c!-- todo --\u003e\n",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"totalTabCount": "The total number of tabs in the documents. Read only.",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used."
}
],
"recipientCount": "The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:\n\n* recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.\n* includeDocuments - When set to **true**, the envelope time zone information is included in the message.",
"seals": [
{
"accessCode": "Not applicable",
"addAccessCodeToEmail": "Not applicable",
"clientUserId": "Not applicable",
"customFields": [
"string"
],
"declinedDateTime": "Not applicable",
"declinedReason": "Not applicable",
"deliveredDateTime": "Not applicable",
"deliveryMethod": "Reserved: For DocuSign use only.",
"documentVisibility": [
{
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"rights": "string",
"visible": "string"
}
],
"emailNotification": {
"emailBody": "Not applicable",
"emailSubject": "Not applicable",
"supportedLanguage": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. "
},
"embeddedRecipientStartURL": "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]\u0026[[mergeField3]]` ",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"faxNumber": "Reserved for DocuSign.",
"idCheckConfigurationName": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.",
"idCheckInformationInput": {
"addressInformationInput": {
"addressInformation": {
"city": "The city associated with the address.",
"country": "Specifies the country associated with the address.",
"fax": "A Fax number associated with the address if one is available.",
"phone": "A phone number associated with the address.",
"state": "The state or province associated with the address.",
"street1": "The first line of the address.",
"street2": "The second line of the address (optional).",
"zip": "The zip or postal code associated with the address.",
"zipPlus4": "string"
},
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"dobInformationInput": {
"dateOfBirth": "Specifies the recipient's date, month, and year of birth.",
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"ssn4InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response.",
"ssn4": "The last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"ssn9": " The recipient's Social Security Number(SSN)."
}
},
"identityVerification": {
"inputOptions": [
{
"name": "string",
"phoneNumberList": [
{
"countryCode": "string",
"extension": "string",
"number": "string"
}
],
"valueType": "string"
}
],
"workflowId": "string"
},
"inheritEmailNotificationConfiguration": "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": "Not applicable",
"phoneAuthentication": {
"recipMayProvideNumber": "Boolean. When set to **true**, the recipient can supply a phone number their choice.",
"recordVoicePrint": "Reserved.",
"senderProvidedNumbers": [
"string"
],
"validateRecipProvidedNumber": " Reserved."
},
"recipientAttachments": [
{
"attachmentId": "string",
"attachmentType": "string",
"data": "string",
"label": "string",
"name": "string",
"remoteUrl": "string"
}
],
"recipientAuthenticationStatus": {
"accessCodeResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ageVerifyResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"anySocialIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"facebookResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"googleResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idLookupResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idQuestionsResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"identityVerificationResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"linkedinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"liveIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ofacResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"openIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"phoneAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"sTANPinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"salesforceResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"signatureProviderResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"smsAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"twitterResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"yahooResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
}
},
"recipientId": "(Required) The `recipientId` used when the envelope or template was created.",
"recipientIdGuid": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.",
"recipientSignatureProviders": [
{
"sealDocumentsWithTabsOnly": "By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.\n\nTo apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. ",
"sealName": "Indicates the name of the electronic seal to apply on documents.\n",
"signatureProviderName": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)",
"signatureProviderOptions": {
"cpfNumber": "Reserved for DocuSign",
"oneTimePassword": "A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.",
"signerRole": "The role or capacity of the signing recipient. Examples: Manager, Approver, etc.",
"sms": "The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234."
}
}
],
"requireIdLookup": "Not applicable",
"roleName": "Optional element. Specifies the role name associated with the recipient.\u003cbr/\u003e\u003cbr/\u003eThis is required when working with template recipients.",
"routingOrder": "(Optional, default: 1) \nSpecifies the routing order of the electronic seal in the envelope.\nThe routing order assigned to your electronic seal cannot be shared with another recipient.\nIt is recommended that you set a routing order for your electronic seals.\n",
"samlAuthentication": {
"samlAssertionAttributes": [
{
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"value": "The value associated with the named SAML assertion attribute"
}
]
},
"sentDateTime": "Not applicable",
"signedDateTime": "Not applicable",
"smsAuthentication": {
"senderProvidedNumbers": [
"string"
]
},
"socialAuthentications": [
{
"authentication": "Reserved: TBD"
}
],
"status": "Item status. \u003c!-- TODO --\u003e",
"tabs": {
"approveTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": " Specifies the approval text displayed in the tab. ",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"checkboxTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "This property does not apply to `checkbox` tabs. Check boxes are always optional.",
"selected": "When set to **true**, the checkbox is selected.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n"
}
],
"companyTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"dateSignedTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"dateTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"declineTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": " Specifies the decline text displayed in the tab.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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.",
"declineReason": "The reason the recipient declined the document.",
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"emailAddressTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"emailTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"envelopeIdTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"firstNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"formulaTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"hidden": "If this is a regular formula (no `paymentDetails` property is present):\n\n* **true**: The tab is hidden.\n* **false**: The tab is shown.\n\nIf the formula is payment item (a `paymentDetails` property is present):\n\n* **true**: The tab is displayed as a payment.\n* **false**: The tab is displayed as a regular formula.\n",
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"paymentDetails": {
"allowedPaymentMethods": [
"string"
],
"chargeId": "The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment.",
"currencyCode": "Specifies the three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nSupported currencies are:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nSpecifying any other ISO 4217 code for payments is an error.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n",
"customMetadata": "string",
"customMetadataRequired": false,
"customerId": "string",
"gatewayAccountId": "A GUID that identifies the payment gateway\nconnected to the sender's DocuSign account.\n\nThere is no public API\nfor connecting payment gateway accounts\nYou must connect and manage payment gateway accounts\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\n\nYou can get the gateway account ID\nin the Payments section\nof the DocuSign Admin console.\n\n\n[paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways\n",
"gatewayDisplayName": "Display name of the gateway connected to sender's Docusign account.\n\nPossible values are: Stripe, Braintree, Authorize.Net.",
"gatewayName": "Name of the gateway connected to sender's DocuSign account.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`",
"lineItems": [
{
"amountReference": "This is a the `tabLabel`\nthat specifies the amount paid\nfor the line items.\n\n",
"description": "A sender-defined description of the line item.\n",
"itemCode": "This is the sender-defined\nSKU, inventory number, or other item code\nfor the line item.\n",
"name": "This is a sender-defined\nproduct name, service name,\nor other designation for the line item.\n"
}
],
"paymentOption": "string",
"paymentSourceId": "string",
"signerValues": {
"paymentOption": "string"
},
"status": "This read-only property describes the status of a payment.\n\n* `new`\u003cbr\u003e\n This is a new payment request.\n The envelope has been created,\n but no payment authorizations have been made.\n\n* `auth_complete`\u003cbr\u003e\n A recipient has entered their credit card information,\n but the envelope has not been completed.\n The card has not been charged.\n\n* `payment_complete`\u003cbr\u003e\n The recipient's card has been charged.\n\n* `payment_capture_failed`\u003cbr\u003e\n Final charge failed.\n This can happen when too much time\n passes between authorizing the payment\n and completing the document.\n",
"total": {
"amountInBaseUnit": "The total payment amount\nin the currency's base unit.\nFor example, for USD\nthe base currency is one cent.\n",
"currency": "The three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n",
"displayAmount": "The payment amount as displayed\nin the `currency`.\n\nFor example, if the payment amount\nis USD 12.59,\nthe `amountInBaseUnit` is 1259 (cents),\nand the displayed amount is `$12.59 USD`.\n\nThis is a read-only property.\n"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"roundDecimalPlaces": "string",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n"
}
],
"fullNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"initialHereTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -23)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -23)\n"
}
],
"lastNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"listTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"listItems": [
{
"selected": "When set to **true**, indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default.",
"text": "Specifies the text that is shown in the dropdown list. ",
"value": "Specifies the value that is used when the list item is selected."
}
],
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "The value to use when the item is selected.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"notarizeTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "string",
"documentId": "The ID of the document being accessed.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "The page number being accessed.",
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n"
}
],
"noteTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"numberTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"radioGroupTabs": [
{
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"groupName": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.",
"radios": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"required": "When set to **true**, the signer is required to fill out this tab",
"selected": "When set to **true**, the radio button is selected.",
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"shared": "When set to **true**, this custom tab is shared.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string"
}
],
"signHereTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"stampType": "string",
"stampTypeMetadata": {
"options": [
"string"
],
"rights": "string"
},
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -27)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -27)\n"
}
],
"signerAttachmentTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n"
}
],
"smartSectionTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"caseSensitive": false,
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "string",
"displaySettings": {
"cellStyle": "string",
"collapsibleSettings": {
"arrowClosed": "string",
"arrowColor": "string",
"arrowLocation": "string",
"arrowOpen": "string",
"arrowSize": "string",
"arrowStyle": "string",
"containerStyle": "string",
"labelStyle": "string",
"onlyArrowIsClickable": false,
"outerLabelAndArrowStyle": "string"
},
"display": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`\u003cbr\u003e\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`\u003cbr\u003e\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`\u003cbr\u003e\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n",
"displayLabel": "string",
"displayOrder": 0,
"displayPageNumber": 0,
"hideLabelWhenOpened": false,
"inlineOuterStyle": "string",
"labelWhenOpened": "string",
"preLabel": "string",
"scrollToTopWhenOpened": false,
"tableStyle": "string"
},
"documentId": "The ID of the document being accessed.",
"endAnchor": "string",
"endPosition": {
"pageNumber": 0,
"xPosition": 0,
"yPosition": 0
},
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "The page number being accessed.",
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"removeEndAnchor": false,
"removeStartAnchor": false,
"startAnchor": "string",
"startPosition": {
"pageNumber": 0,
"xPosition": 0,
"yPosition": 0
},
"status": "Item status. \u003c!-- TODO --\u003e",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"ssnTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"textTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"height": 0,
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"titleTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"viewTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": "string",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"requiredRead": "string",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n"
}
],
"zipTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"useDash4": "string",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
]
},
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"totalTabCount": "Not applicable",
"userId": "Not applicable"
}
],
"signers": [
{
"accessCode": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.",
"addAccessCodeToEmail": "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.",
"agentCanEditEmail": "Optional element. When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.",
"agentCanEditName": "Optional. When set to **true**, the agent recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.",
"autoNavigation": "When set to **true**, autonavigation is set for the recipient.",
"bulkRecipientsUri": "The URL for the bulk recipient file with the bulk recipient information for this envelope, if applicable. This information is read only and is only shown after the bulk recipient file is uploaded to the envelope by using the PUT method. ",
"canSignOffline": "When set to **true**, specifies that the signer can perform the signing ceremony offline.",
"clientUserId": "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. ",
"creationReason": "The reason why the recipient was created (for example, `sender`). Read only.",
"customFields": [
"string"
],
"declinedDateTime": "The date and time the recipient declined the document. Read only.",
"declinedReason": "The reason the recipient declined the document. Read only.",
"defaultRecipient": "When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.",
"deliveredDateTime": "Reserved: For DocuSign use only.",
"deliveryMethod": "Reserved: For DocuSign use only.",
"documentVisibility": [
{
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"rights": "string",
"visible": "string"
}
],
"email": "The recipient's email address. The system sends notification of the documents to sign to this email address. \n\nMaximum length: 100 characters. ",
"emailNotification": {
"emailBody": "Not applicable",
"emailSubject": "Not applicable",
"supportedLanguage": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. "
},
"emailRecipientPostSigningURL": "string",
"embeddedRecipientStartURL": "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]\u0026[[mergeField3]]` ",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"excludedDocuments": [
"string"
],
"faxNumber": "Reserved for DocuSign.",
"firstName": "The user's first name. \nMaximum Length: 50 characters.",
"fullName": "Reserved for DocuSign.",
"idCheckConfigurationName": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.",
"idCheckInformationInput": {
"addressInformationInput": {
"addressInformation": {
"city": "The city associated with the address.",
"country": "Specifies the country associated with the address.",
"fax": "A Fax number associated with the address if one is available.",
"phone": "A phone number associated with the address.",
"state": "The state or province associated with the address.",
"street1": "The first line of the address.",
"street2": "The second line of the address (optional).",
"zip": "The zip or postal code associated with the address.",
"zipPlus4": "string"
},
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"dobInformationInput": {
"dateOfBirth": "Specifies the recipient's date, month, and year of birth.",
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"ssn4InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response.",
"ssn4": "The last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"ssn9": " The recipient's Social Security Number(SSN)."
}
},
"identityVerification": {
"inputOptions": [
{
"name": "string",
"phoneNumberList": [
{
"countryCode": "string",
"extension": "string",
"number": "string"
}
],
"valueType": "string"
}
],
"workflowId": "string"
},
"inheritEmailNotificationConfiguration": "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. ",
"isBulkRecipient": "When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. \n\nNote that when this is true the email and name for the recipient becomes bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient. \n",
"lastName": "The recipient's last name.",
"name": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note**: You must always set a value for this property in requests, even if `firstName` and `lastName` are set.",
"note": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n",
"phoneAuthentication": {
"recipMayProvideNumber": "Boolean. When set to **true**, the recipient can supply a phone number their choice.",
"recordVoicePrint": "Reserved.",
"senderProvidedNumbers": [
"string"
],
"validateRecipProvidedNumber": " Reserved."
},
"proofFile": {
"isInProofFile": "string"
},
"recipientAttachments": [
{
"attachmentId": "string",
"attachmentType": "string",
"data": "string",
"label": "string",
"name": "string",
"remoteUrl": "string"
}
],
"recipientAuthenticationStatus": {
"accessCodeResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ageVerifyResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"anySocialIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"facebookResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"googleResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idLookupResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idQuestionsResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"identityVerificationResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"linkedinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"liveIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ofacResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"openIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"phoneAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"sTANPinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"salesforceResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"signatureProviderResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"smsAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"twitterResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"yahooResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
}
},
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"recipientIdGuid": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.",
"recipientSignatureProviders": [
{
"sealDocumentsWithTabsOnly": "By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.\n\nTo apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. ",
"sealName": "Indicates the name of the electronic seal to apply on documents.\n",
"signatureProviderName": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)",
"signatureProviderOptions": {
"cpfNumber": "Reserved for DocuSign",
"oneTimePassword": "A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.",
"signerRole": "The role or capacity of the signing recipient. Examples: Manager, Approver, etc.",
"sms": "The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234."
}
}
],
"recipientSuppliesTabs": "When set to **true**, specifies that the recipient creates the tabs.",
"requireIdLookup": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ",
"requireSignOnPaper": "When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.",
"requireSignerCertificate": "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate.",
"roleName": "Optional element. Specifies the role name associated with the recipient.\u003cbr/\u003e\u003cbr/\u003eThis is required when working with template recipients.",
"routingOrder": "Specifies the routing order of the recipient in the envelope. ",
"samlAuthentication": {
"samlAssertionAttributes": [
{
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"value": "The value associated with the named SAML assertion attribute"
}
]
},
"sentDateTime": "The UTC DateTime when the envelope was sent. Read only.",
"signInEachLocation": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).",
"signatureInfo": {
"fontStyle": "string",
"signatureInitials": "string",
"signatureName": "Specifies the user signature name."
},
"signedDateTime": "Reserved for DocuSign.",
"signingGroupId": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ",
"signingGroupName": "The display name for the signing group. \n\nMaximum Length: 100 characters. ",
"signingGroupUsers": [
{
"activationAccessCode": "string",
"email": "string",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"loginStatus": "string",
"sendActivationEmail": "string",
"uri": "string",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.",
"userName": "string",
"userStatus": "Status of the user's account. One of:\n\n* ActivationRequired\n* ActivationSent\n* Active\n* Closed\n* Disabled\n",
"userType": "string"
}
],
"smsAuthentication": {
"senderProvidedNumbers": [
"string"
]
},
"socialAuthentications": [
{
"authentication": "Reserved: TBD"
}
],
"status": "Specifies the status of the recipient at the time of the request. Read only. Possible values are:\n\n- `created`: The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a created status).\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing web site. This is not an email delivery of the documents in an envelope.\n- `signed`; The recipient has completed (performed all required interactions, such as signing or entering data) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to completed.\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `faxpending`: The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step.\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used by the DocuSign webapp (also known as the DocuSign console) to inform senders about the auto-responded email.",
"tabs": {
"approveTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": " Specifies the approval text displayed in the tab. ",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"checkboxTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "This property does not apply to `checkbox` tabs. Check boxes are always optional.",
"selected": "When set to **true**, the checkbox is selected.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n"
}
],
"companyTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"dateSignedTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"dateTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"declineTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": " Specifies the decline text displayed in the tab.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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.",
"declineReason": "The reason the recipient declined the document.",
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"emailAddressTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"emailTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"envelopeIdTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"firstNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"formulaTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"hidden": "If this is a regular formula (no `paymentDetails` property is present):\n\n* **true**: The tab is hidden.\n* **false**: The tab is shown.\n\nIf the formula is payment item (a `paymentDetails` property is present):\n\n* **true**: The tab is displayed as a payment.\n* **false**: The tab is displayed as a regular formula.\n",
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"paymentDetails": {
"allowedPaymentMethods": [
"string"
],
"chargeId": "The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment.",
"currencyCode": "Specifies the three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nSupported currencies are:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nSpecifying any other ISO 4217 code for payments is an error.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n",
"customMetadata": "string",
"customMetadataRequired": false,
"customerId": "string",
"gatewayAccountId": "A GUID that identifies the payment gateway\nconnected to the sender's DocuSign account.\n\nThere is no public API\nfor connecting payment gateway accounts\nYou must connect and manage payment gateway accounts\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\n\nYou can get the gateway account ID\nin the Payments section\nof the DocuSign Admin console.\n\n\n[paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways\n",
"gatewayDisplayName": "Display name of the gateway connected to sender's Docusign account.\n\nPossible values are: Stripe, Braintree, Authorize.Net.",
"gatewayName": "Name of the gateway connected to sender's DocuSign account.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`",
"lineItems": [
{
"amountReference": "This is a the `tabLabel`\nthat specifies the amount paid\nfor the line items.\n\n",
"description": "A sender-defined description of the line item.\n",
"itemCode": "This is the sender-defined\nSKU, inventory number, or other item code\nfor the line item.\n",
"name": "This is a sender-defined\nproduct name, service name,\nor other designation for the line item.\n"
}
],
"paymentOption": "string",
"paymentSourceId": "string",
"signerValues": {
"paymentOption": "string"
},
"status": "This read-only property describes the status of a payment.\n\n* `new`\u003cbr\u003e\n This is a new payment request.\n The envelope has been created,\n but no payment authorizations have been made.\n\n* `auth_complete`\u003cbr\u003e\n A recipient has entered their credit card information,\n but the envelope has not been completed.\n The card has not been charged.\n\n* `payment_complete`\u003cbr\u003e\n The recipient's card has been charged.\n\n* `payment_capture_failed`\u003cbr\u003e\n Final charge failed.\n This can happen when too much time\n passes between authorizing the payment\n and completing the document.\n",
"total": {
"amountInBaseUnit": "The total payment amount\nin the currency's base unit.\nFor example, for USD\nthe base currency is one cent.\n",
"currency": "The three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n",
"displayAmount": "The payment amount as displayed\nin the `currency`.\n\nFor example, if the payment amount\nis USD 12.59,\nthe `amountInBaseUnit` is 1259 (cents),\nand the displayed amount is `$12.59 USD`.\n\nThis is a read-only property.\n"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"roundDecimalPlaces": "string",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n"
}
],
"fullNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"initialHereTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -23)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -23)\n"
}
],
"lastNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"listTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"listItems": [
{
"selected": "When set to **true**, indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default.",
"text": "Specifies the text that is shown in the dropdown list. ",
"value": "Specifies the value that is used when the list item is selected."
}
],
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "The value to use when the item is selected.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"notarizeTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "string",
"documentId": "The ID of the document being accessed.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "The page number being accessed.",
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n"
}
],
"noteTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"numberTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"radioGroupTabs": [
{
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"groupName": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.",
"radios": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"required": "When set to **true**, the signer is required to fill out this tab",
"selected": "When set to **true**, the radio button is selected.",
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"shared": "When set to **true**, this custom tab is shared.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string"
}
],
"signHereTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"stampType": "string",
"stampTypeMetadata": {
"options": [
"string"
],
"rights": "string"
},
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -27)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -27)\n"
}
],
"signerAttachmentTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n"
}
],
"smartSectionTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"caseSensitive": false,
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "string",
"displaySettings": {
"cellStyle": "string",
"collapsibleSettings": {
"arrowClosed": "string",
"arrowColor": "string",
"arrowLocation": "string",
"arrowOpen": "string",
"arrowSize": "string",
"arrowStyle": "string",
"containerStyle": "string",
"labelStyle": "string",
"onlyArrowIsClickable": false,
"outerLabelAndArrowStyle": "string"
},
"display": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`\u003cbr\u003e\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`\u003cbr\u003e\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`\u003cbr\u003e\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n",
"displayLabel": "string",
"displayOrder": 0,
"displayPageNumber": 0,
"hideLabelWhenOpened": false,
"inlineOuterStyle": "string",
"labelWhenOpened": "string",
"preLabel": "string",
"scrollToTopWhenOpened": false,
"tableStyle": "string"
},
"documentId": "The ID of the document being accessed.",
"endAnchor": "string",
"endPosition": {
"pageNumber": 0,
"xPosition": 0,
"yPosition": 0
},
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "The page number being accessed.",
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"removeEndAnchor": false,
"removeStartAnchor": false,
"startAnchor": "string",
"startPosition": {
"pageNumber": 0,
"xPosition": 0,
"yPosition": 0
},
"status": "Item status. \u003c!-- TODO --\u003e",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"ssnTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"textTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"height": 0,
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"titleTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"viewTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": "string",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"requiredRead": "string",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n"
}
],
"zipTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"useDash4": "string",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
]
},
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"totalTabCount": "The total number of tabs in the documents. Read only.",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used."
}
],
"witnesses": [
{
"accessCode": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.",
"addAccessCodeToEmail": "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.",
"agentCanEditEmail": "string",
"agentCanEditName": "string",
"autoNavigation": "When set to **true**, autonavigation is set for the recipient.",
"bulkRecipientsUri": "The URL for the bulk recipient file with the bulk recipient information for this envelope, if applicable. This information is read only and is only shown after the bulk recipient file is uploaded to the envelope by using the PUT method. ",
"canSignOffline": "When set to **true**, specifies that the signer can perform the signing ceremony offline.",
"clientUserId": "Specifies whether the recipient is embedded or remote. \n\nIf 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.\n\nNote: 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. \n\nMaximum length: 100 characters. ",
"creationReason": "The reason why the recipient was created (for example, `sender`). Read only.",
"customFields": [
"string"
],
"declinedDateTime": "The date and time the recipient declined the document. Read only.",
"declinedReason": "The reason the recipient declined the document. Read only.",
"defaultRecipient": "When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.",
"deliveredDateTime": "Reserved: For DocuSign use only.",
"deliveryMethod": "Reserved: For DocuSign use only.",
"documentVisibility": [
{
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"rights": "string",
"visible": "string"
}
],
"email": "string",
"emailNotification": {
"emailBody": "Not applicable",
"emailSubject": "Not applicable",
"supportedLanguage": "Specifies the language used to localize Electronic Seals UI texts such as \"Sealed by\", etc. \n \nThe supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). \n \nThis parameter is optional. If not set, it defaults to the sender’s language settings at time of sealing. "
},
"emailRecipientPostSigningURL": "string",
"embeddedRecipientStartURL": "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. \n\nIf 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.\n\nIt 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.\n\nIf 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. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]\u0026[[mergeField3]]` ",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"excludedDocuments": [
"string"
],
"faxNumber": "Reserved for DocuSign.",
"firstName": "The user's first name. \nMaximum Length: 50 characters.",
"fullName": "Reserved for DocuSign.",
"idCheckConfigurationName": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example**: Your account has ID Check and SMS Authentication available. 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 $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node.",
"idCheckInformationInput": {
"addressInformationInput": {
"addressInformation": {
"city": "The city associated with the address.",
"country": "Specifies the country associated with the address.",
"fax": "A Fax number associated with the address if one is available.",
"phone": "A phone number associated with the address.",
"state": "The state or province associated with the address.",
"street1": "The first line of the address.",
"street2": "The second line of the address (optional).",
"zip": "The zip or postal code associated with the address.",
"zipPlus4": "string"
},
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"dobInformationInput": {
"dateOfBirth": "Specifies the recipient's date, month, and year of birth.",
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response."
},
"ssn4InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"receiveInResponse": "When set to **true**, the information needs to be returned in the response.",
"ssn4": "The last four digits of the recipient's Social Security Number (SSN)."
},
"ssn9InformationInput": {
"displayLevelCode": "Specifies the display level for the recipient. \nValid values are: \n\n* ReadOnly\n* Editable\n* DoNotDisplay",
"ssn9": " The recipient's Social Security Number(SSN)."
}
},
"identityVerification": {
"inputOptions": [
{
"name": "string",
"phoneNumberList": [
{
"countryCode": "string",
"extension": "string",
"number": "string"
}
],
"valueType": "string"
}
],
"workflowId": "string"
},
"inheritEmailNotificationConfiguration": "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. ",
"isBulkRecipient": "When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. \n\nNote that when this is true the email and name for the recipient becomes bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient. \n",
"lastName": "The recipient's last name.",
"name": "string",
"note": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n",
"phoneAuthentication": {
"recipMayProvideNumber": "Boolean. When set to **true**, the recipient can supply a phone number their choice.",
"recordVoicePrint": "Reserved.",
"senderProvidedNumbers": [
"string"
],
"validateRecipProvidedNumber": " Reserved."
},
"proofFile": {
"isInProofFile": "string"
},
"recipientAttachments": [
{
"attachmentId": "string",
"attachmentType": "string",
"data": "string",
"label": "string",
"name": "string",
"remoteUrl": "string"
}
],
"recipientAuthenticationStatus": {
"accessCodeResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ageVerifyResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"anySocialIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"facebookResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"googleResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idLookupResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"idQuestionsResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"identityVerificationResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"linkedinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"liveIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"ofacResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"openIDResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"phoneAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"sTANPinResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"salesforceResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"signatureProviderResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"smsAuthResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"twitterResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
},
"yahooResult": {
"eventTimestamp": "string",
"failureDescription": "string",
"status": "Event status.",
"vendorFailureStatusCode": "string"
}
},
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"recipientIdGuid": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only.",
"recipientSignatureProviders": [
{
"sealDocumentsWithTabsOnly": "By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.\n\nTo apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. ",
"sealName": "Indicates the name of the electronic seal to apply on documents.\n",
"signatureProviderName": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)",
"signatureProviderOptions": {
"cpfNumber": "Reserved for DocuSign",
"oneTimePassword": "A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.",
"signerRole": "The role or capacity of the signing recipient. Examples: Manager, Approver, etc.",
"sms": "The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234."
}
}
],
"recipientSuppliesTabs": "When set to **true**, specifies that the recipient creates the tabs.",
"requireIdLookup": "When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. ",
"requireSignOnPaper": "When set to **true**, the signer must print, sign, and upload or fax the signed documents to DocuSign.",
"requireSignerCertificate": "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate.",
"roleName": "Optional element. Specifies the role name associated with the recipient.\u003cbr/\u003e\u003cbr/\u003eThis is required when working with template recipients.",
"routingOrder": "Specifies the routing order of the recipient in the envelope. ",
"samlAuthentication": {
"samlAssertionAttributes": [
{
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"value": "The value associated with the named SAML assertion attribute"
}
]
},
"sentDateTime": "The UTC DateTime when the envelope was sent. Read only.",
"signInEachLocation": "When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).",
"signatureInfo": {
"fontStyle": "string",
"signatureInitials": "string",
"signatureName": "Specifies the user signature name."
},
"signedDateTime": "Reserved for DocuSign.",
"signingGroupId": "Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups).\n\n**Note**: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. ",
"signingGroupName": "The display name for the signing group. \n\nMaximum Length: 100 characters. ",
"signingGroupUsers": [
{
"activationAccessCode": "string",
"email": "string",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"loginStatus": "string",
"sendActivationEmail": "string",
"uri": "string",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.",
"userName": "string",
"userStatus": "Status of the user's account. One of:\n\n* ActivationRequired\n* ActivationSent\n* Active\n* Closed\n* Disabled\n",
"userType": "string"
}
],
"smsAuthentication": {
"senderProvidedNumbers": [
"string"
]
},
"socialAuthentications": [
{
"authentication": "Reserved: TBD"
}
],
"status": "Item status. \u003c!-- TODO --\u003e",
"tabs": {
"approveTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": " Specifies the approval text displayed in the tab. ",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"checkboxTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "This property does not apply to `checkbox` tabs. Check boxes are always optional.",
"selected": "When set to **true**, the checkbox is selected.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\n"
}
],
"companyTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"dateSignedTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"dateTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"declineTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": " Specifies the decline text displayed in the tab.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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.",
"declineReason": "The reason the recipient declined the document.",
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"emailAddressTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"emailTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"envelopeIdTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"firstNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"formulaTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"hidden": "If this is a regular formula (no `paymentDetails` property is present):\n\n* **true**: The tab is hidden.\n* **false**: The tab is shown.\n\nIf the formula is payment item (a `paymentDetails` property is present):\n\n* **true**: The tab is displayed as a payment.\n* **false**: The tab is displayed as a regular formula.\n",
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"paymentDetails": {
"allowedPaymentMethods": [
"string"
],
"chargeId": "The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment.",
"currencyCode": "Specifies the three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nSupported currencies are:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nSpecifying any other ISO 4217 code for payments is an error.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n",
"customMetadata": "string",
"customMetadataRequired": false,
"customerId": "string",
"gatewayAccountId": "A GUID that identifies the payment gateway\nconnected to the sender's DocuSign account.\n\nThere is no public API\nfor connecting payment gateway accounts\nYou must connect and manage payment gateway accounts\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\n\nYou can get the gateway account ID\nin the Payments section\nof the DocuSign Admin console.\n\n\n[paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways\n",
"gatewayDisplayName": "Display name of the gateway connected to sender's Docusign account.\n\nPossible values are: Stripe, Braintree, Authorize.Net.",
"gatewayName": "Name of the gateway connected to sender's DocuSign account.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`",
"lineItems": [
{
"amountReference": "This is a the `tabLabel`\nthat specifies the amount paid\nfor the line items.\n\n",
"description": "A sender-defined description of the line item.\n",
"itemCode": "This is the sender-defined\nSKU, inventory number, or other item code\nfor the line item.\n",
"name": "This is a sender-defined\nproduct name, service name,\nor other designation for the line item.\n"
}
],
"paymentOption": "string",
"paymentSourceId": "string",
"signerValues": {
"paymentOption": "string"
},
"status": "This read-only property describes the status of a payment.\n\n* `new`\u003cbr\u003e\n This is a new payment request.\n The envelope has been created,\n but no payment authorizations have been made.\n\n* `auth_complete`\u003cbr\u003e\n A recipient has entered their credit card information,\n but the envelope has not been completed.\n The card has not been charged.\n\n* `payment_complete`\u003cbr\u003e\n The recipient's card has been charged.\n\n* `payment_capture_failed`\u003cbr\u003e\n Final charge failed.\n This can happen when too much time\n passes between authorizing the payment\n and completing the document.\n",
"total": {
"amountInBaseUnit": "The total payment amount\nin the currency's base unit.\nFor example, for USD\nthe base currency is one cent.\n",
"currency": "The three-letter\n[ISO 4217][ISO4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO4217]: https://en.wikipedia.org/wiki/ISO_4217\n",
"displayAmount": "The payment amount as displayed\nin the `currency`.\n\nFor example, if the payment amount\nis USD 12.59,\nthe `amountInBaseUnit` is 1259 (cents),\nand the displayed amount is `$12.59 USD`.\n\nThis is a read-only property.\n"
}
},
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"roundDecimalPlaces": "string",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+35, -2)\n"
}
],
"fullNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"initialHereTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -23)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -23)\n"
}
],
"lastNameTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"listTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"listItems": [
{
"selected": "When set to **true**, indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default.",
"text": "Specifies the text that is shown in the dropdown list. ",
"value": "Specifies the value that is used when the list item is selected."
}
],
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "The value to use when the item is selected.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"notarizeTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "string",
"documentId": "The ID of the document being accessed.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "The page number being accessed.",
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n"
}
],
"noteTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"numberTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"radioGroupTabs": [
{
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"documentId": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"groupName": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.",
"radios": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"required": "When set to **true**, the signer is required to fill out this tab",
"selected": "When set to **true**, the radio button is selected.",
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"value": "Specifies the value of the tab. ",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"shared": "When set to **true**, this custom tab is shared.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string"
}
],
"signHereTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"stampType": "string",
"stampTypeMetadata": {
"options": [
"string"
],
"rights": "string"
},
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -27)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+2, -27)\n"
}
],
"signerAttachmentTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"optional": "string",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"scaleValue": 0,
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (+0, -24)\n"
}
],
"smartSectionTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"caseSensitive": false,
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "string",
"displaySettings": {
"cellStyle": "string",
"collapsibleSettings": {
"arrowClosed": "string",
"arrowColor": "string",
"arrowLocation": "string",
"arrowOpen": "string",
"arrowSize": "string",
"arrowStyle": "string",
"containerStyle": "string",
"labelStyle": "string",
"onlyArrowIsClickable": false,
"outerLabelAndArrowStyle": "string"
},
"display": "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`\u003cbr\u003e\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`\u003cbr\u003e\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`\u003cbr\u003e\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n",
"displayLabel": "string",
"displayOrder": 0,
"displayPageNumber": 0,
"hideLabelWhenOpened": false,
"inlineOuterStyle": "string",
"labelWhenOpened": "string",
"preLabel": "string",
"scrollToTopWhenOpened": false,
"tableStyle": "string"
},
"documentId": "The ID of the document being accessed.",
"endAnchor": "string",
"endPosition": {
"pageNumber": 0,
"xPosition": 0,
"yPosition": 0
},
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "The page number being accessed.",
"recipientId": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.",
"removeEndAnchor": false,
"removeStartAnchor": false,
"startAnchor": "string",
"startPosition": {
"pageNumber": 0,
"xPosition": 0,
"yPosition": 0
},
"status": "Item status. \u003c!-- TODO --\u003e",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n"
}
],
"ssnTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"textTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"formula": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n",
"height": 0,
"isPaymentAmount": "When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. ",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "Specifies the tool tip text for the tab.",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"titleTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
],
"viewTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"buttonText": "string",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"height": 0,
"italic": "When set to **true**, the information in the tab is italic.",
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"required": "When set to **true**, the signer is required to fill out this tab",
"requiredRead": "string",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\n"
}
],
"zipTabs": [
{
"anchorCaseSensitive": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.\n--\u003e",
"anchorHorizontalAlignment": "Reserved for DocuSign.\n\u003c!--\nSpecifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.\n--\u003e\n",
"anchorIgnoreIfNotPresent": "When set to **true**, this tab is ignored if anchorString is not found in the document.",
"anchorMatchWholeWord": "Reserved for DocuSign.\n\u003c!--\nWhen set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.\n--\u003e\n",
"anchorString": "Specifies the anchor string.",
"anchorUnits": "Specifies units of the\n`anchorXOffset` and\n`anchorYOffset`.\nValid units are:\n\n- `pixels`\n- `inches`\n- `mms`\n- `cms`\n",
"anchorXOffset": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"anchorYOffset": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n",
"bold": "When set to **true**, the information in the tab is bold.",
"concealValueOnDocument": "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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.",
"conditionalParentLabel": "For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.",
"conditionalParentValue": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n",
"customTabId": "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": "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": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.",
"errorDetails": {
"errorCode": "An error code associated with the error.",
"message": "A short error message."
},
"font": "The font to be used for the tab value. Supported Fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n",
"fontColor": "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n",
"fontSize": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72",
"italic": "When set to **true**, the information in the tab is italic.",
"locked": "When set to **true**, the signer cannot change the data of the custom tab.",
"maxLength": 0,
"mergeField": {
"allowSenderToEdit": "When set to **true**, the sender can modify the value of the custom tab during the sending process.",
"configurationType": "If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.",
"path": "Sets the object associated with the custom tab. Currently this is the Salesforce Object.",
"row": "Specifies the row number in a Salesforce table that the merge field value corresponds to.",
"writeBack": "When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed."
},
"name": "string",
"originalValue": "The initial value of the tab when it was sent to the recipient. ",
"pageNumber": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.",
"recipientId": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.",
"requireAll": "When set to **true** and shared is true, information must be entered in this field to complete the envelope. ",
"requireInitialOnSharedChange": "Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.",
"required": "When set to **true**, the signer is required to fill out this tab",
"senderRequired": "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.",
"shared": "When set to **true**, this custom tab is shared.",
"status": "Tab status\n\u003c!-- todo --\u003e\n",
"tabGroupLabels": [
"string"
],
"tabId": "The unique identifier for the tab.",
"tabLabel": "The label string associated with the tab.\nThe string may be the empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum of 500 characters.\n",
"tabOrder": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.",
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"tooltip": "string",
"underline": "When set to **true**, the information in the tab is underlined.",
"useDash4": "string",
"validationMessage": "The message displayed if the custom tab fails input validation (either custom of embedded).",
"validationPattern": "A regular expressionn used to validate input for the tab.",
"value": "Specifies the value of the tab. ",
"width": 0,
"xPosition": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n",
"yPosition": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
}
]
},
"templateLocked": "When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ",
"templateRequired": "When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.",
"totalTabCount": "The total number of tabs in the documents. Read only.",
"userId": "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. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.",
"witnessFor": "string",
"witnessForGuid": "string"
}
]
},
"recipientsLock": "When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.",
"recipientsUri": "Contains a URI for an endpoint that you can use to retrieve the recipients.",
"sentDateTime": "The UTC DateTime when the envelope was sent. Read only.",
"signerCanSignOnMobile": "string",
"signingLocation": "Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.",
"status": "Item status. \u003c!-- TODO --\u003e",
"statusChangedDateTime": "The data and time the status changed.",
"templatesUri": "Contains a URI for an endpoint which you can use to retrieve the templates.",
"transactionId": "Specifies the Transaction ID from the AppStore.",
"useDisclosure": "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. \n\nIf 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": "The date and time the envelope or template was voided.",
"voidedReason": "The reason the envelope or template was voided."
}
],
"lastQueriedDateTime": "string",
"nextUri": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ",
"previousUri": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ",
"resultSetSize": "The number of results returned in this response. ",
"startPosition": "Starting position of the current result set.",
"totalSetSize": "The total number of items in the search's result set. It will always be greater than or equal to the value of the `resultSetSize` field."
}
Workflow Library Example
Get Envelopes with Docusign and Send Results Via Email
Preview this Workflow on desktop
Was this page helpful?