DocuSign v0.1.2 API Reference
Modules
Documentation for DocuSign
GenServer to store API client and refresh access token by schedule
API calls for all endpoints tagged AccountBrands
API calls for all endpoints tagged AccountConsumerDisclosures
API calls for all endpoints tagged AccountCustomFields
API calls for all endpoints tagged AccountPasswordRules
API calls for all endpoints tagged AccountPermissionProfiles
API calls for all endpoints tagged AccountSealProviders
API calls for all endpoints tagged AccountSignatureProviders
API calls for all endpoints tagged AccountTabSettings
API calls for all endpoints tagged AccountWatermarks
API calls for all endpoints tagged Accounts
API calls for all endpoints tagged Authentication
API calls for all endpoints tagged BillingPlans
API calls for all endpoints tagged BulkEnvelopes
API calls for all endpoints tagged ChunkedUploads
API calls for all endpoints tagged CloudStorage
API calls for all endpoints tagged CloudStorageProviders
API calls for all endpoints tagged ConnectConfigurations
API calls for all endpoints tagged ConnectEvents
API calls for all endpoints tagged Contacts
API calls for all endpoints tagged CustomTabs
API calls for all endpoints tagged ENoteConfigurations
API calls for all endpoints tagged EnvelopeAttachments
API calls for all endpoints tagged EnvelopeBulkRecipients
API calls for all endpoints tagged EnvelopeConsumerDisclosures
API calls for all endpoints tagged EnvelopeCustomFields
API calls for all endpoints tagged EnvelopeDocumentFields
API calls for all endpoints tagged EnvelopeDocumentTabs
API calls for all endpoints tagged EnvelopeDocumentVisibility
API calls for all endpoints tagged EnvelopeDocuments
API calls for all endpoints tagged EnvelopeEmailSettings
API calls for all endpoints tagged EnvelopeFormData
API calls for all endpoints tagged EnvelopeLocks
API calls for all endpoints tagged EnvelopeRecipientTabs
API calls for all endpoints tagged EnvelopeRecipients
API calls for all endpoints tagged EnvelopeTemplates
API calls for all endpoints tagged EnvelopeViews
API calls for all endpoints tagged Envelopes
API calls for all endpoints tagged Folders
API calls for all endpoints tagged GroupBrands
API calls for all endpoints tagged GroupUsers
API calls for all endpoints tagged Groups
API calls for all endpoints tagged IdentityVerifications
API calls for all endpoints tagged Invoices
API calls for all endpoints tagged NotaryJournals
API calls for all endpoints tagged PaymentGatewayAccounts
API calls for all endpoints tagged Payments
API calls for all endpoints tagged PowerFormData
API calls for all endpoints tagged PowerForms
API calls for all endpoints tagged RequestLogs
API calls for all endpoints tagged Resources
API calls for all endpoints tagged Services
API calls for all endpoints tagged SigningGroupUsers
API calls for all endpoints tagged SigningGroups
API calls for all endpoints tagged TemplateBulkRecipients
API calls for all endpoints tagged TemplateCustomFields
API calls for all endpoints tagged TemplateDocumentFields
API calls for all endpoints tagged TemplateDocumentTabs
API calls for all endpoints tagged TemplateDocumentVisibility
API calls for all endpoints tagged TemplateDocuments
API calls for all endpoints tagged TemplateLocks
API calls for all endpoints tagged TemplateRecipientTabs
API calls for all endpoints tagged TemplateRecipients
API calls for all endpoints tagged TemplateViews
API calls for all endpoints tagged Templates
API calls for all endpoints tagged Uncategorized
API calls for all endpoints tagged UserCustomSettings
API calls for all endpoints tagged UserProfiles
API calls for all endpoints tagged UserSignatures
API calls for all endpoints tagged UserSocialAccountLogins
API calls for all endpoints tagged Users
API calls for all endpoints tagged WorkspaceItems
API calls for all endpoints tagged Workspaces
The module is intended for to make and perform request to DocuSign API
Handle Tesla connections
Helper functions for deserializing responses into models
Contains information about an account address
Contains information about an account billing plan
Brand management for accounts
Account consumer disclosures
Custom Fields
Contains account settings information
Contains shared access information
Account SBS Signature Providers
Account management
Contains information about add ons
Contains address information
Contains address input information
Contains information about agent recipients
Contains API request log information
Contains information about mutiple API request logs
Contains information about an APP store product
Contains information about an APP store receipt
A tab that allows the recipient to approve documents without placing a signature or initials on the document
Contains information about an attachment
Authentication and login
Contains information about the method used for authentication
Contains information about the authentication status
Contains information about the BCC email address
Contains information about a billing charge
Defines a billing charge response object
Contains information about an item on a billing invoice
Defines a billing invoice response object
Contains information on a billing plan
Defines an billing payment response object
Defines a billing payments response object
Contains information about a billing plan
Contains information about a preview billing plan
Defines a billing plan response object
Defines a billing plan update response object
Billing plans
Defines a billing plans response object
Bulk envelopes
A tab that allows the recipient to select a yes/no (on/off) option
Chunked Uploads resource
Cloud storage
Cloud storage providers
A tab that displays the recipient's company name
Connect configurations
Connect event logging
Custom tabs
A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format
A tab that displays the date that the recipient signed the document
A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided
Complex type containing: dateOfBirth displayLevelCode * receiveInResponse
A document object
A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response
A tab that displays the recipient's email as entered in the recipient information
Envelope bulk recipients
Envelope consumer disclosures
Envelope custom fields
Envelope document fields
Envelope Document Tabs resource
Envelope documents
Envelope email settings
For which envelope events should your webhook be called?
A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab
Envelope locks
All of the tabs associated with a recipient. Each property is a list of a type of tab
Envelope recipients
A complex element containing the following information: templateId: Unique identifier of the template. If this is not provided, DocuSign will generate a value. name: Name of the template. Maximum length: 100 characters. shared: When set to true, the template is shared with the Everyone group in the account. If false, the template is only shared with the Administrator group. password: Password, if the template is locked. description: Description of the template. Maximum Length: 500 characters. pageCount: Number of document pages in the template. folderName: The name of the folder the template is located in. folderId: The ID for the folder. owner: The userName, email, userId, userType, and userStatus for the template owner
Envelope templates
Embedding Envelope views
Envelope creation, management
Result set for the Envelopes: listStatusChanges method
This object describes errors that occur. It is only valid for responses, and ignored in requests
Register a Connect webhook for a specific envelope
A complex element that specifies the expiration settings for the envelope
A tab that displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name
Folder management
A complex element that has up to four Question/Answer pairs for forgotten password information
The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures
A tab that displays the recipient's full name
Brand management for groups
Groups' users
Group information
A complex element that contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipient's date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of: ssn4: Specifies the last four digits of the recipient's SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay
An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about fields used for eNotary feature, see the [EnvelopeRecipients resource][enveloperecipientsInPerson]. [enveloperecipientsInPerson]: /esign/restapi/Envelopes/EnvelopeRecipients/#in-person-signers-recipient
A tab that allows the recipient to initial the document. May be optional
Invoices
A tab that displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name
This tab offers a list of options to choose from. The `listItems` property contains a list of `listItem` objects to specify the selectable options
One of the selectable items in the `listItems` property of a `list` tab
Contains information for transfering values between Salesforce data fields and DocuSign Tabs
Describes information about the `total` of a payment
A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page
This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: `name`: Specifies the notary's full legal name. `email`: Specifies the notary's email address. * `recipientId`: A unique ID number for the notary signing host
A tab that displays additional information, in the form of a note, for the recipient
A complex element that specifies the notification options for the envelope. It consists of: useAccountDefaults - When set to true, the account default notification settings are used for the envelope. reminders - A complex element that specifies reminder settings for the envelope. It consists of: reminderEnabled - When set to true, a reminder message is sent to the recipient. reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. reminderFrequency - An interger that sets the interval, in days, between reminder emails. expirations - A complex element that specifies the expiration settings for the envelope. It consists of: expireEnabled - When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. expireAfter - An integer that sets the number of days the envelope is active. * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent
A tab that allows the recipient to enter numbers and decimal (.) points
Description of a page of a document
When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures
Information about a connected payment gateway account
Holds information about connected payment accounts
A line item describes details about an individual line item in a payment request
Payments
An object used to identify the features and attributes of the account being created
One of the selectable radio buttons in the `radios` property of a `radioGroup` tab
This group tab is used to place radio buttons on a document. The `radios` property contains a list of `radio` objects associated with the group. Only one radio button can be selected in a group
A complex type that Contains the elements: recipMayProvideNumber - Boolean. When set to true, the recipient can use whatever phone number they choose. senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. recordVoicePrint - Reserved. validateRecipProvidedNumber - Reserved
Contains the name/value pair information for the SAML assertion attributes: name - The name of the SAML assertion attribute. value - The value associated with the named SAML assertion attribute. Your account must be set up to use SSO to use this
Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers
An Electronic or Standards Based Signature (digital signature) provider for the signer to use. More information.
Option settings for the signature provider. Different providers require or use different options. The current provider list and the options they require.
Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication
A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only
A complex element that specifies reminder settings for the envelope
Request logs
API resource information
The request body for the EnvelopeViews: createSender method
API service information
A tab that allows the recipient to sign a document. May be optional
A tab that allows the recipient to attach supporting documents to an envelope
An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created
Signing groups' users
Signing groups
A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information
Template bulk recipients
Template custom fields
Template document fields
Template documents
Template locks
Template tabs
Template recipients
Embedding template views
Template management
A tab that allows the recipient to enter any type of text
A tab that displays the recipient's title
A complex element consisting of: lastSentDateTime - the date and time the user last sent an envelope. lastSignedDateTime - the date and time the user last signed an envelope. sentCount - the number of envelopes the user has sent. signedCount - the number of envelopes the user has signed
Describes which account management capabilities a user has
Users' custom settings
Users' profiles
Users' signatures
Users' social account logins
User management
This tab is used with the Approve tab to handle [supplemental documents][supdocs]. [supdocs]: /esign/guide/appendix/glossary.html#supplemental-documents
Provides properties that describe the contents of a workspace folder
Provides properties that describe the items contained in a workspace
Provides properties that describe the workspaces avaialble
A workspaceUser representing the user. This property is only returned in response to user specific GET call
Provides properties that describe user authorization to a workspace
A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information
This module implements an oauth2 strategy for DocuSign
Helper functions for building Tesla requests
This module contains the User struct and functions for working with it