| ▼NDocuSign | |
| ▼NeSign | |
| ►NApi | |
| ►CAccountsApi | Represents a collection of functions to interact with the API endpoints |
| CCreateAccountSignaturesOptions | Adds/updates one or more account signatures. This request may include images in multi-part format. |
| CCreateCustomFieldOptions | Creates an acount custom field. This method creates a custom field and makes it available for all new envelopes associated with an account. |
| CCreateOptions | Creates new accounts. Creates new DocuSign service accounts. This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a `newAccountRequests` element. A maximum of 100 new accounts can be created at one time. Note that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a `newAccountDefinition` property inside the `newAccountRequests` element. Response The response returns the new account ID, password and the default user information for each newly created account. A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an `errorDetails` node is added in the response to each specific request that failed. |
| CCreatePermissionProfileOptions | Creates a new permission profile in the specified account. This method creates a new permission profile for an account. ### Related topics - How to create a permission profile |
| CDeleteCustomFieldOptions | Delete an existing account custom field. This method deletes an existing account custom field. |
| CDeleteOptions | Deletes the specified account. This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign. |
| CDeletePermissionProfileOptions | Deletes a permissions profile within the specified account. This method deletes a permission profile from an account. To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the `move_users_to` query parameter. ### Related topics - How to delete a permission profile |
| CGetAccountIdentityVerificationOptions | Get the list of identity verification options for an account This method returns a list of Identity Verification workflows that are available to an account. Note: To use this method, you must either be an account administrator or a sender. ### Related topics - How to require ID Verification (IDV) for a recipient |
| CGetAccountInformationOptions | Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API. |
| CGetAccountSignatureImageOptions | Returns a signature, initials, or stamps image. |
| CGetAccountSignaturesOptions | Returns the managed signature definitions for the account |
| CGetAgentUserAuthorizationsOptions | Returns the agent user authorizations |
| CGetBillingChargesOptions | Gets list of recurring and usage charges for the account. Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator |
| CGetBrandOptions | Get information for a specific brand. This method returns details about an account brand. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). |
| CGetBrandResourcesByContentTypeOptions | Returns the specified branding resource file. This method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience. Important: When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). |
| CGetConsumerDisclosureDefaultOptions | Gets the Electronic Record and Signature Disclosure for the account. Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure. |
| CGetPermissionProfileOptions | Returns a permissions profile in the specified account. This method returns information about a specific permission profile that is associated with an account. ### Related topics - How to set a permission profile |
| CGetPrincipalUserAuthorizationsOptions | Returns the principal user authorizations |
| CListBrandsOptions | Gets a list of brand profiles. Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to true for the account to use this call. |
| CListPermissionsOptions | Gets a list of permission profiles. Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently, Permission Profiles can only be created and modified in the DocuSign console. |
| CListRecipientNamesByEmailOptions | Gets recipient names associated with an email address. Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string. |
| CListSharedAccessOptions | Reserved: Gets the shared item status for one or more users. Reserved: Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves and the returned information is limited to the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from. |
| CUpdateAccountSignatureByIdOptions | Updates a account signature. |
| CUpdateAccountSignatureImageOptions | Sets a signature, initials, or stamps image. |
| CUpdateBrandOptions | Updates an existing brand. This method updates an account brand. Note: Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be true). |
| CUpdateConsumerDisclosureOptions | Update Consumer Disclosure. Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter. Note: Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - `accountEsignId`: This property is read-only. - `custom`: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure. - `esignAgreement`: This property is read-only. - `esignText`: You cannot edit this property when `custom` is set to false. The API returns a 200 OK HTTP response, but does not update the `esignText`. - Metadata properties: These properties are read-only. Note: The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the `custom` property to true and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. Note: When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating. Important: When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. Important: Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. |
| CUpdateCustomFieldOptions | Updates an existing account custom field. This method updates an existing account custom field. |
| CUpdatePermissionProfileOptions | Updates a permission profile within the specified account. This method updates an account permission profile. ### Related topics - How to update individual permission settings |
| CUpdateSharedAccessOptions | Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users. |
| ►CAuthenticationApi | Represents a collection of functions to interact with the API endpoints |
| CLoginOptions | Gets login information for a specified user. Retrieves login information for a specified user. Each account that is associated with the login credentials is listed. You can use the returned information to determine whether a user is authenticated and select an account to use in future operations. The `baseUrl` property, returned in the response, is used in all future API calls as the base of the request URL. The `baseUrl` property contains the DocuSign server, the API version, and the `accountId` property that is used for the login. This request uses your DocuSign credentials to retrieve the account information. |
| ►CBillingApi | Represents a collection of functions to interact with the API endpoints |
| CGetPlanOptions | Get Account Billing Plan Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the `setting` set to false. Response The response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [ML:Update Billing Plan] reference. ###### Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible. |
| CListInvoicesOptions | Get a List of Billing Invoices Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administrator |
| CListPaymentsOptions | Gets payment information for one or more payments. Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. Privileges required: account administrator |
| CUpdatePlanOptions | Updates the account billing plan. Updates the billing plan information, billing address, and credit card information for the specified account. |
| ►CBulkEnvelopesApi | Represents a collection of functions to interact with the API endpoints |
| CGetBulkSendBatchEnvelopesOptions | Gets envelopes from a specific bulk send batch This method returns a list of envelopes in a specified bulk batch. Use the query parameters to filter and sort the envelopes by different attributes. |
| CGetBulkSendBatchesOptions | Returns a list of bulk send batch satuses initiated by account. Returns a summary of bulk send batches. Use the `batch_ids` query parameter to narrow the list of batches. |
| CBulkProcessDataApi | Represents a collection of functions to interact with the API endpoints |
| CBulkProcessDataSendApi | Represents a collection of functions to interact with the API endpoints |
| ►CCloudStorageApi | Represents a collection of functions to interact with the API endpoints |
| CGetProviderOptions | Gets the specified Cloud Storage Provider configuration for the User. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. |
| CListFoldersOptions | Retrieves a list of all the items in a specified folder from the specified cloud storage provider. Retrieves a list of all the items in a specified folder from the specified cloud storage provider. |
| CListOptions | Gets a list of all the items from the specified cloud storage provider. Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request. |
| CListProvidersOptions | Get the Cloud Storage Provider configuration for the specified user. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. The {serviceId} parameter can be either the service name or serviceId. |
| ►CConnectApi | Represents a collection of functions to interact with the API endpoints |
| CGetConnectAllUsersOptions | Returns all users from the configured Connect service. |
| CGetEventLogOptions | Get the specified Connect log entry. Retrieves the specified Connect log entry for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. |
| CListEventFailureLogsOptions | Gets the Connect failure log information. Retrieves the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created. |
| CListEventLogsOptions | Gets the Connect log. Retrieves a list of connect log entries for your account. ###### Note: The `enableLog` setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. |
| CListUsersOptions | Returns users from the configured Connect service. Returns users from the configured Connect service. |
| ►CCustomTabsApi | Represents a collection of functions to interact with the API endpoints |
| CListOptions | Gets a list of all account tabs. Retrieves a list of all tabs associated with the account. |
| ►CDiagnosticsApi | Represents a collection of functions to interact with the API endpoints |
| CListRequestLogsOptions | Gets the API request logging log files. Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below. |
| ►CEmailArchiveApi | Represents a collection of functions to interact with the API endpoints |
| CGetBCCEmailArchiveHistoryListOptions | Get the blind carbon copy email archive history entries for the specified archive This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address. |
| CGetBCCEmailArchiveListOptions | Get the blind carbon copy email archive entries owned by the specified account This method retrieves all of the BCC email archive configurations associated with an account. |
| ►CEnvelopesApi | Represents a collection of functions to interact with the API endpoints |
| CApplyTemplateOptions | Adds templates to an envelope. Adds templates to the specified envelope. |
| CApplyTemplateToDocumentOptions | Adds templates to a document in an envelope. Adds templates to a document in the specified envelope. |
| CCreateEnvelopeOptions | Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the `document` object ### Recipient Types An `envelopeDefinition` object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an `EnvelopeRecipients` resource object. It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - – – – – – – - | - – – – – – – – – agent (can add name and email information for later recipients/signers) | `agent` carbon copy (receives a copy of the documents) | `carbonCopy` certified delivery (receives a copy of the documents and must acknowledge receipt) | `certifiedDelivery` editor (can change recipients and document fields for later recipients/signers) | `editor` in-person signer ("hosts" someone who signs in-person) | `inPersonSigner` intermediary (can add name and email information for some later recipients/signers.) | `intermediary` signer (signs and/or updates document fields) | `signer` Additional information about the different types of recipients is available from the `EnvelopeRecipients` resource page and from the Developer Center ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an `EnvelopeTabs` resource object. It includes arrays of the 24 different tab types available. See the `EnvelopeTabs` resource for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the `EnvelopeRecipients` object are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the Webhook recipe for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the first template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "\*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a PDF Form Digital Signature Field, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming PDF Form Text Fields, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status. |
| CCreateRecipientOptions | Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to true. |
| CCreateRecipientProofFileResourceTokenOptions | Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API. |
| CGetChunkedUploadOptions | Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions. |
| CGetCommentsTranscriptOptions | Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true). |
| CGetConsumerDisclosureDefaultOptions | Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure. |
| CGetConsumerDisclosureOptions | Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. |
| CGetDocumentOptions | Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined |
| CGetDocumentPageImageOptions | Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope. |
| CGetDocumentTabsOptions | Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`. |
| CGetEnvelopeOptions | Gets the status of a envelope. Retrieves the overall status for the specified envelope. |
| CGetEnvelopeTransferRulesOptions | Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. |
| CGetPagesOptions | Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify. |
| CGetRecipientInitialsImageOptions | Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image. |
| CGetRecipientSignatureImageOptions | Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. |
| CListDocumentsOptions | Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope. |
| CListRecipientsOptions | Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. |
| CListStatusChangesOptions | Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. |
| CListStatusOptions | Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes. |
| CListTabsOptions | Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope. |
| CListTemplatesForDocumentOptions | Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope. |
| CListTemplatesOptions | Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope. |
| CUpdateChunkedUploadOptions | Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts. |
| CUpdateEnvelopeDocGenFormFieldsOptions | Updates formfields for an envelope |
| CUpdateOptions | Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {"status":"sent"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {"purgeState":"purge type"} to the request body. Additional information on purging documents The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted. |
| CUpdateRecipientsOptions | Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST). |
| ►CFoldersApi | Represents a collection of functions to interact with the API endpoints |
| CListItemsOptions | Gets a list of the envelopes in the specified folder. Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters. |
| CListOptions | Gets a list of the folders for the account. Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter. |
| CSearchOptions | Gets a list of envelopes in folders matching the specified criteria. Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients. |
| ►CGroupsApi | Represents a collection of functions to interact with the API endpoints |
| CListGroupsOptions | Gets information about groups associated with the account. Retrieves information about groups associated with the account. |
| CListGroupUsersOptions | Gets a list of users in a group. Retrieves a list of users in a group. |
| CIAccountsApi | Represents a collection of functions to interact with the API endpoints |
| CIAuthenticationApi | Represents a collection of functions to interact with the API endpoints |
| CIBillingApi | Represents a collection of functions to interact with the API endpoints |
| CIBulkEnvelopesApi | Represents a collection of functions to interact with the API endpoints |
| CIBulkProcessDataApi | Represents a collection of functions to interact with the API endpoints |
| CIBulkProcessDataSendApi | Represents a collection of functions to interact with the API endpoints |
| CICloudStorageApi | Represents a collection of functions to interact with the API endpoints |
| CIConnectApi | Represents a collection of functions to interact with the API endpoints |
| CICustomTabsApi | Represents a collection of functions to interact with the API endpoints |
| CIDiagnosticsApi | Represents a collection of functions to interact with the API endpoints |
| CIEmailArchiveApi | Represents a collection of functions to interact with the API endpoints |
| CIEnvelopesApi | Represents a collection of functions to interact with the API endpoints |
| CIFoldersApi | Represents a collection of functions to interact with the API endpoints |
| CIGroupsApi | Represents a collection of functions to interact with the API endpoints |
| CINotaryApi | Represents a collection of functions to interact with the API endpoints |
| CIOrganizationsApi | Represents a collection of functions to interact with the API endpoints |
| CIPowerFormsApi | Represents a collection of functions to interact with the API endpoints |
| CISigningGroupsApi | Represents a collection of functions to interact with the API endpoints |
| CITemplatesApi | Represents a collection of functions to interact with the API endpoints |
| CITrustServiceProvidersApi | Represents a collection of functions to interact with the API endpoints |
| CIUsersApi | Represents a collection of functions to interact with the API endpoints |
| CIWorkspacesApi | Represents a collection of functions to interact with the API endpoints |
| ►CNotaryApi | Represents a collection of functions to interact with the API endpoints |
| CGetNotaryOptions | Get notary settings for a user Gets settings for a notary user. The current user must be a notary. |
| CListNotaryJournalsOptions | Get notary jurisdictions for a user |
| COrganizationsApi | Represents a collection of functions to interact with the API endpoints |
| ►CPowerFormsApi | Represents a collection of functions to interact with the API endpoints |
| CGetPowerFormDataOptions | Returns the form data associated with the usage of a PowerForm. This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm. |
| CListPowerFormSendersOptions | Returns the list of PowerForms available to the user. This method returns a list of users who have sent PowerForms. |
| CListPowerFormsOptions | Returns the list of PowerForms available to the user. This method returns a list of PowerForms that are available to the user. |
| ►CSigningGroupsApi | Represents a collection of functions to interact with the API endpoints |
| CListOptions | Gets a list of the Signing Groups in an account. Retrieves a list of all signing groups in the specified account. |
| ►CTemplatesApi | Represents a collection of functions to interact with the API endpoints |
| CCreateRecipientsOptions | Adds tabs for a recipient. Adds one or more recipients to a template. |
| CGetDocumentOptions | Gets PDF documents from a template. Retrieves one or more PDF documents from the specified template. You can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf. |
| CGetDocumentPageImageOptions | Gets a page image from a template for display. Retrieves a page image for display from the specified template. |
| CGetDocumentTabsOptions | Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the template specified by `templateId`. |
| CGetOptions | Gets a list of templates for a specified account. Retrieves the definition of the specified template. |
| CGetPagesOptions | Returns document page image(s) based on input. Returns images of the pages in a template document for display based on the parameters that you specify. |
| CListDocumentsOptions | Gets a list of documents associated with a template. Retrieves a list of documents associated with the specified template. |
| CListRecipientsOptions | Gets recipient information from a template. Retrieves the information for all recipients in the specified template. |
| CListTabsOptions | Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template. |
| CListTemplatesOptions | Gets the definition of a template. Retrieves the list of templates for the specified account. The request can be limited to a specific folder. |
| CUpdateDocumentOptions | Adds a document to a template document. Adds the specified document to an existing template document. |
| CUpdateRecipientsOptions | Updates recipients in a template. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. |
| CTrustServiceProvidersApi | Represents a collection of functions to interact with the API endpoints |
| ►CUsersApi | Represents a collection of functions to interact with the API endpoints |
| CDeleteOptions | Removes users account privileges. This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions. The response returns whether the API execution was successful (200 - OK) or if it failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, the response for that user contains an `errorDetails` node with `errorCode` and `message` properties. |
| CGetContactByIdOptions | Gets a particular contact associated with the user's account. This method returns one or more contacts associated with a DocuSign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] providers by using the `cloud_provider` query parameter. By default, contacts are retrieved from the DocuSign account's default address book. To return a specific contact, use the `contactId` query parameter. To return all contacts associated with an account, omit this parameter. [CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/ |
| CGetInformationOptions | Gets the user information for a specified user. Retrieves the user information for the specified user. To return additional user information that details the last login date, login status, and the user's password expiration date, set the optional `additional_info` query string parameter to true. |
| CGetProfileImageOptions | Retrieves the user profile image for the specified user. Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account. If successful, the response returns a 200 - OK and the user profile image. |
| CGetSignatureImageOptions | Retrieves the user initials image or the user signature image for the specified user. Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith". ###### Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. |
| CListOptions | Retrieves the list of users for the specified account. Retrieves the list of users for the specified account. The response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to true, the full user information is returned for each user |
| CListSignaturesOptions | Retrieves a list of user signature definitions for a specified user. Retrieves the signature definitions for the specified user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith". |
| CUpdateSettingsOptions | Updates the user account settings for a specified user. Updates the account settings list and email notification types for the specified user. |
| CUpdateSignatureImageOptions | Updates the user signature image or user initials image for the specified user. Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith". |
| CUpdateSignatureOptions | Updates the user signature for a specified user. Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature. ###### Note: This will also create a default signature for the user when one does not exist. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith". |
| CUpdateUserOptions | Updates the specified user information. To update user information for a specific user, submit a Users object with updated field values in the request body of this operation. |
| CUpdateUsersOptions | Change one or more user in the specified account. This method updates the information about one or more account users. |
| ►CWorkspacesApi | Represents a collection of functions to interact with the API endpoints |
| CGetWorkspaceFileOptions | Get Workspace File Retrieves a workspace file (the binary). |
| CListWorkspaceFilePagesOptions | List File Pages Retrieves a workspace file as rasterized pages. |
| CListWorkspaceFolderItemsOptions | List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files. |
| ►NClient | |
| ►NAuth | |
| ►COAuth | |
| COAuthToken | |
| ►CUserInfo | |
| CAccount | Account model with the following properties: accountId: the account ID GUID. isDefault: whether this is the default account, when the user has access to multiple accounts. accountName: the human-readable name of the account. baseUri: the base URI associated with this account. It also tells which Docusign data center the account is hosted on. |
| CLink | Link model with the following properties: rel: currently the only value is "self". href: the direct link of the organization. |
| COrganization | Organization model with the following properties: organizationId: the organization ID GUID if Docusign Org Admin is enabled. links: this is list of organization direct links associated with the Docusign account. |
| CApiClient | API client is mainly responsible for making the HTTP call to the API backend. |
| CApiException | API Exception |
| CApiResponse | API Response |
| CConfiguration | Represents a set of configuration settings |
| CDocuSignClient | DocuSignClient is mainly responsible for facilitating HTTP calls to the Docusign APIs. |
| CDocuSignRequest | |
| CDocuSignResponse | |
| CFileParameter | |
| CGlobalConfiguration | GlobalConfiguration provides a compile-time extension point for globally configuring API Clients. |
| CIApiAccessor | Represents configuration aspects required to interact with the API endpoints. |
| CIHttpClient | |
| CIReadableConfiguration | Represents a readable-only configuration contract. |
| CSwaggerDateConverter | Formatter for 'date' swagger formats ss defined by full-date - RFC3339 see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types |
| CSystemNetHttpClient | |
| ►NModel | |
| CAccessCodeFormat | Object specifying the format of the string provided to a recipient in order to access an envelope. |
| CAccountAddress | Contains information about an account address. |
| CAccountBillingPlan | Contains information about an account billing plan. |
| CAccountBillingPlanResponse | Defines an account billing plan response object. |
| CAccountIdentityInputOption | AccountIdentityInputOption |
| CAccountIdentityVerificationResponse | AccountIdentityVerificationResponse |
| CAccountIdentityVerificationStep | Information about a specific step in an Identity Verification workflow. |
| CAccountIdentityVerificationWorkflow | Specifies an Identity Verification workflow. |
| CAccountInformation | Contains account Information. |
| CAccountMinimumPasswordLength | AccountMinimumPasswordLength |
| CAccountNotification | A complex element that specifies notifications (expirations and reminders) for the envelope. |
| CAccountPasswordExpirePasswordDays | AccountPasswordExpirePasswordDays |
| CAccountPasswordLockoutDurationMinutes | AccountPasswordLockoutDurationMinutes |
| CAccountPasswordLockoutDurationType | AccountPasswordLockoutDurationType |
| CAccountPasswordMinimumPasswordAgeDays | AccountPasswordMinimumPasswordAgeDays |
| CAccountPasswordQuestionsRequired | Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password. |
| CAccountPasswordRules | AccountPasswordRules |
| CAccountPasswordStrengthType | AccountPasswordStrengthType |
| CAccountPasswordStrengthTypeOption | AccountPasswordStrengthTypeOption |
| CAccountRoleSettings | This object defines account permissions for users who are associated with the account permission profile. |
| CAccountSeals | AccountSeals |
| CAccountSettingsInformation | Contains account settings information. |
| CAccountSharedAccess | Contains shared access information. |
| CAccountSignature | AccountSignature |
| CAccountSignatureDefinition | AccountSignatureDefinition |
| CAccountSignatureProvider | Contains information abotu the signature provider associated with the Identity Verification workflow. If empty, then this specific workflow is not intended for signers. |
| CAccountSignatureProviderOption | Reserved for DocuSign. |
| CAccountSignatureProviders | AccountSignatureProviders |
| CAccountSignaturesInformation | AccountSignaturesInformation |
| CAccountUISettings | An object that defines the options that are available to non-administrators in the UI. |
| CAddOn | Contains information about add ons. |
| CAddressInformation | Contains address information. |
| CAddressInformationInput | Contains address input information. |
| CAddressInformationV2 | AddressInformationV2 |
| CAdminMessage | AdminMessage |
| CAgent | Contains information about agent recipients. |
| CApiRequestLog | Contains API request log information. |
| CApiRequestLogsResult | Contains information about mutiple API request logs. |
| CApprove | A tab that allows the recipient to approve documents without placing a signature or initials on the document. |
| CAppStoreProduct | Contains information about an APP store product. |
| CAppStoreReceipt | Contains information about an APP store receipt. |
| CAskAnAdmin | AskAnAdmin |
| CAttachment | Contains information about an attachment. |
| CAuthenticationMethod | Contains information about the method used for authentication. |
| CAuthenticationStatus | Contains information about the authentication status. |
| CAuthorizationUser | AuthorizationUser |
| CBccEmailAddress | Contains information about the BCC email address. |
| CBccEmailArchive | This object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails). |
| CBccEmailArchiveHistory | Contains details about the history of the BCC email archive configuration. |
| CBccEmailArchiveHistoryList | BccEmailArchiveHistoryList |
| CBccEmailArchiveList | Contains a list of BCC email archive configurations. |
| CBillingCharge | Contains information about a billing charge. |
| CBillingChargeResponse | Defines a billing charge response object. |
| CBillingDiscount | BillingDiscount |
| CBillingEntityInformationResponse | BillingEntityInformationResponse |
| CBillingInvoice | Contains information about a billing invoice. |
| CBillingInvoiceItem | Contains information about an item on a billing invoice. |
| CBillingInvoicesResponse | Defines a billing invoice response object. |
| CBillingInvoicesSummary | BillingInvoicesSummary |
| CBillingPayment | Contains information on a billing plan. |
| CBillingPaymentItem | Defines a billing payment request object. |
| CBillingPaymentRequest | BillingPaymentRequest |
| CBillingPaymentResponse | Defines an billing payment response object. |
| CBillingPaymentsResponse | Defines a billing payments response object. |
| CBillingPlan | Contains information about a billing plan. |
| CBillingPlanInformation | This object contains details about a billing plan. |
| CBillingPlanPreview | Contains information about a preview billing plan. |
| CBillingPlanResponse | Defines a billing plan response object. |
| CBillingPlansResponse | Defines a billing plans response object. |
| CBillingPlanUpdateResponse | Defines a billing plan update response object. |
| CBillingPrice | BillingPrice |
| CBrand | Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope. |
| CBrandEmailContent | Deprecated. |
| CBrandLink | Information about a link that a brand uses. |
| CBrandLogos | The URIs for retrieving the logos that are associated with the brand. These are read-only properties that provide a URI to logos in use. To update a logo use AccountBrands: updateLogo. |
| CBrandRequest | This request object contains information about a specific brand. |
| CBrandResources | Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences. |
| CBrandResourcesList | BrandResourcesList |
| CBrandResourceUrls | Brands use resource files to style the following experiences: - Email - Sending - Signing - Captive (embedded) signing You can modify these resource files to customize these experiences. |
| CBrandsRequest | Details about one or more brands. |
| CBrandsResponse | BrandsResponse |
| CBulkEnvelope | BulkEnvelope |
| CBulkEnvelopesResponse | BulkEnvelopesResponse |
| CBulkEnvelopeStatus | BulkEnvelopeStatus |
| CBulkProcessingLists | BulkProcessingLists |
| CBulkProcessingListSummaries | BulkProcessingListSummaries |
| CBulkProcessingListSummary | BulkProcessingListSummary |
| CBulkProcessRequest | BulkProcessRequest |
| CBulkProcessResponse | BulkProcessResponse |
| CBulkProcessResult | BulkProcessResult |
| CBulkRecipient | BulkRecipient |
| CBulkRecipientSignatureProvider | BulkRecipientSignatureProvider |
| CBulkRecipientsRequest | BulkRecipientsRequest |
| CBulkRecipientsResponse | BulkRecipientsResponse |
| CBulkRecipientsSummaryResponse | BulkRecipientsSummaryResponse |
| CBulkRecipientsUpdateResponse | BulkRecipientsUpdateResponse |
| CBulkRecipientTabLabel | BulkRecipientTabLabel |
| CBulkSendBatchActionRequest | BulkSendBatchActionRequest |
| CBulkSendBatchError | BulkSendBatchError |
| CBulkSendBatchRequest | BulkSendBatchRequest |
| CBulkSendBatchStatus | Result of `getBulkSendBatchStatus` |
| CBulkSendBatchSummaries | A list of bulk send batch summaries. |
| CBulkSendBatchSummary | Summary status of a single batch. |
| CBulkSendEnvelopesInfo | BulkSendEnvelopesInfo |
| CBulkSendErrorStatus | A single bulk send error report. |
| CBulkSendingCopy | This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance. |
| CBulkSendingCopyCustomField | This object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send. |
| CBulksendingCopyDocGenFormField | BulksendingCopyDocGenFormField |
| CBulkSendingCopyDocGenFormFieldRowValue | BulkSendingCopyDocGenFormFieldRowValue |
| CBulkSendingCopyRecipient | This object contains details about a bulk send recipient. |
| CBulkSendingCopyTab | A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same. For example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information. |
| CBulkSendingList | This object contains the details for the bulk send list. |
| CBulkSendingListSummaries | This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user. |
| CBulkSendingListSummary | This object contains basic information about a bulk send list. |
| CBulkSendRequest | This object contains information about the envelope or template that you want to send in bulk. |
| CBulkSendResponse | The object contains the response to a bulk send request. |
| CBulkSendTestResponse | This object contains the results of a bulk send test. |
| CCaptiveRecipient | This object contains details about a captive (embedded) recipient. |
| CCaptiveRecipientInformation | Contains information about captive (embedded) recipients. |
| CCarbonCopy | Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. |
| CCertifiedDelivery | Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents. |
| CCheckbox | A tab that allows the recipient to select a yes/no (on/off) option. |
| CChunkedUploadPart | An object that contains information about the chunked upload part. |
| CChunkedUploadRequest | This is the request object for uploading a chunked upload. |
| CChunkedUploadResponse | This response object is returned after you upload a chunked upload. |
| CCloudStorageProvider | Contains details about a specific cloud storage provider. |
| CCloudStorageProviders | CloudStorageProviders |
| CComment | Comment |
| CCommentHistoryResult | CommentHistoryResult |
| CCommentPublish | CommentPublish |
| CCommentsPublish | CommentsPublish |
| CCommentThread | CommentThread |
| CCommissionCounty | A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using DocuSign Notary. |
| CCommissionExpiration | A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using DocuSign Notary. |
| CCommissionNumber | A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ |
| CCommissionState | A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ |
| CCompany | A tab that displays the recipient's company name. |
| CCompleteSignHashResponse | CompleteSignHashResponse |
| CCompleteSignRequest | CompleteSignRequest |
| CCompositeTemplate | This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/ |
| CConciergeQueryRequest | ConciergeQueryRequest |
| CConciergeQueryResponse | ConciergeQueryResponse |
| CConditionalRecipientRule | A rule that defines a set of recipients and the conditions under which they will be used for the envelope. |
| CConditionalRecipientRuleCondition | ConditionalRecipientRuleCondition |
| CConditionalRecipientRuleFilter | ConditionalRecipientRuleFilter |
| CConnectConfigResults | This object contains the results of a ConnectConfigurations::GET method. |
| CConnectCustomConfiguration | The `connectCustomConfiguration` object describes how Connect is configured for your account. |
| CConnectDebugLog | ConnectDebugLog |
| CConnectDeleteFailureResult | ConnectDeleteFailureResult |
| CConnectEventData | This object lets you choose the data format of your Connect response. For more information about using this object, see Connect webhooks with JSON notifications. |
| CConnectFailureFilter | A list of failed envelope IDs to retry. |
| CConnectFailureResult | This object contains details about a Connect failure result. |
| CConnectFailureResults | ConnectFailureResults |
| CConnectHistoricalEnvelopeRepublish | ConnectHistoricalEnvelopeRepublish |
| CConnectLog | Contains information about a Connect log entry. |
| CConnectLogs | ConnectLogs |
| CConnectOAuthConfig | ConnectOAuthConfig |
| CConnectSalesforceField | This object is used to match a DocuSign field to a Salesforce field so that Docusign can send information to your Salesforce account. |
| CConnectSalesforceObject | A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account. When you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments. |
| CConnectUserInfo | ConnectUserInfo |
| CConnectUserObject | ConnectUserObject |
| CConsentDetails | ConsentDetails |
| CConsoleViewRequest | The request object for the EnvelopeViews: createConsole method. |
| CConsumerDisclosure | Details about consumer disclosures. |
| CContact | Contact |
| CContactGetResponse | This response object contains information about the contacts associated with an account. |
| CContactModRequest | The request object containing the new information for the contacts. |
| CContactPhoneNumber | Details about the phone numbers associated with a specific contact. |
| CContactUpdateResponse | This response objects shows the updated details for the contacts. |
| CCorrectViewRequest | The request body for the EnvelopeViews: createCorrect method. |
| CCountry | Country |
| CCredential | Credential |
| CCreditCardInformation | This object contains information about a credit card that is associated with an account. |
| CCreditCardTypes | CreditCardTypes |
| CCurrency | Currency |
| CCurrencyFeatureSetPrice | Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only. |
| CCurrencyPlanPrice | CurrencyPlanPrice |
| CCustomField | This object provides details about a custom field. |
| CCustomFields | Contains information about custom fields. |
| CCustomFieldsEnvelope | CustomFieldsEnvelope |
| CCustomFieldV2 | CustomFieldV2 |
| CCustomSettingsInformation | CustomSettingsInformation |
| CDate | 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. |
| CDateSigned | A tab that displays the date that the recipient signed the document. |
| CDateStampProperties | Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. |
| CDecline | 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. |
| CDelayedRouting | DelayedRouting |
| CDelayedRoutingApiModel | DelayedRoutingApiModel |
| CDelegationInfo | DelegationInfo |
| CDiagnosticsSettingsInformation | DiagnosticsSettingsInformation |
| CDirectDebitProcessorInformation | Contains information about a bank that processes a customer's direct debit payments. |
| CDisplayApplianceAccount | DisplayApplianceAccount |
| CDisplayApplianceDocument | DisplayApplianceDocument |
| CDisplayApplianceDocumentPage | DisplayApplianceDocumentPage |
| CDisplayApplianceEnvelope | DisplayApplianceEnvelope |
| CDisplayApplianceInfo | DisplayApplianceInfo |
| CDisplayAppliancePage | DisplayAppliancePage |
| CDisplayAppliancePdf | DisplayAppliancePdf |
| CDisplayApplianceRecipient | DisplayApplianceRecipient |
| CDisplayApplianceSignerAttachment | DisplayApplianceSignerAttachment |
| CDobInformationInput | Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse |
| CDocGenFormField | DocGenFormField |
| CDocGenFormFieldOption | DocGenFormFieldOption |
| CDocGenFormFieldRequest | DocGenFormFieldRequest |
| CDocGenFormFieldResponse | DocGenFormFieldResponse |
| CDocGenFormFieldRowValue | DocGenFormFieldRowValue |
| CDocGenFormFields | DocGenFormFields |
| CDocGenFormFieldValidation | DocGenFormFieldValidation |
| CDocGenSyntaxError | DocGenSyntaxError |
| CDocument | A document object. |
| CDocumentFieldsInformation | DocumentFieldsInformation |
| CDocumentHtmlCollapsibleDisplaySettings | Display settings for collapsible section. |
| CDocumentHtmlDefinition | Holds the properties that define how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide. |
| CDocumentHtmlDefinitionOriginal | DocumentHtmlDefinitionOriginal |
| CDocumentHtmlDefinitionOriginals | DocumentHtmlDefinitionOriginals |
| CDocumentHtmlDefinitions | DocumentHtmlDefinitions |
| CDocumentHtmlDisplayAnchor | DocumentHtmlDisplayAnchor |
| CDocumentHtmlDisplaySettings | DocumentHtmlDisplaySettings |
| CDocumentSecurityStore | DocumentSecurityStore |
| CDocumentTemplate | DocumentTemplate |
| CDocumentTemplateList | DocumentTemplateList |
| CDocumentUpdateInfo | DocumentUpdateInfo |
| CDocumentVisibility | This object configures a recipient's read/write access to a document. |
| CDocumentVisibilityList | A list of `documentVisibility` objects that specify whether documents are visible to recipients. |
| CDowngradeBillingPlanInformation | DowngradeBillingPlanInformation |
| CDowngradePlanUpdateResponse | DowngradePlanUpdateResponse |
| CDowngradeRequestInformation | DowngradeRequestInformation |
| CDowngradRequestBillingInfoResponse | DowngradRequestBillingInfoResponse |
| CDraw | A tab that allows the recipient to add a free-form drawing to the document. |
| CEditor | A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients. |
| CEmail | 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. |
| CEmailAddress | A tab that displays the recipient's email as entered in the recipient information. |
| CEmailSettings | A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. IMPORTANT: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. Example: if your account has BCC for Email Archive set up for the email address 'archi.nosp@m.ve@m.nosp@m.ycomp.nosp@m.any..nosp@m.com' and you send an envelope using the BCC Email Override to send a BCC email to 'sales.nosp@m.arch.nosp@m.ive@m.nosp@m.ycom.nosp@m.pany..nosp@m.com', then a copy of the envelope is only sent to the 'sales.nosp@m.arch.nosp@m.ive@m.nosp@m.ycom.nosp@m.pany..nosp@m.com' email address. |
| CENoteConfiguration | This object contains information used to configure eNote functionality. To use eNote, the Allow eNote for eOriginal account plan item must be on, and the Connect configuration for eOriginal must be set correctly. |
| CEnvelope | Envelope |
| CEnvelopeAttachment | EnvelopeAttachment |
| CEnvelopeAttachmentsRequest | EnvelopeAttachmentsRequest |
| CEnvelopeAttachmentsResult | EnvelopeAttachmentsResult |
| CEnvelopeAuditEvent | EnvelopeAuditEvent |
| CEnvelopeAuditEventResponse | EnvelopeAuditEventResponse |
| CEnvelopeCustomMetadata | EnvelopeCustomMetadata |
| CEnvelopeDefinition | Envelope object definition. |
| CEnvelopeDelayRule | An envelope delay rule is a rule which determines how the envelope should be delayed either for sending or routing. It can expressed as either a delay in some number of days, hours, minutes and seconds or an exact resumeDate in the future. |
| CEnvelopeDelayRuleApiModel | An envelope delay rule is a rule which determines how the envelope should be delayed either for sending or routing. It can expressed as either a delay in some number of days, hours, minutes and seconds or an exact resumeDate in the future. |
| CEnvelopeDocument | This object contains details about the envelope document. |
| CEnvelopeDocumentsResult | EnvelopeDocumentsResult |
| CEnvelopeEvent | For which envelope events should your webhook be called? |
| CEnvelopeFormData | Describes the form data of the envelope. |
| CEnvelopeFormDataPrefillFormData | EnvelopeFormDataPrefillFormData |
| CEnvelopeId | A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab. |
| CEnvelopeIdsRequest | Lists of envelope and transaction IDs to use in the results. If you use this request body with Envelopes: listStatus, you must set one or both of the following query parameters to the special value `request_body`: - `envelope_ids=request_body` - `transaction_ids=request_body` |
| CEnvelopeMetadata | EnvelopeMetadata |
| CEnvelopeNotificationRequest | A complex element that specifies the notification settings for the envelope. |
| CEnvelopePublishRequest | EnvelopePublishRequest |
| CEnvelopePublishTransaction | EnvelopePublishTransaction |
| CEnvelopePublishTransactionErrorRollup | EnvelopePublishTransactionErrorRollup |
| CEnvelopePublishTransactionList | EnvelopePublishTransactionList |
| CEnvelopePurgeConfiguration | Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). |
| CEnvelopesInformation | Result set for the Envelopes: listStatusChanges method |
| CEnvelopeSummary | This object describes an envelope. |
| CEnvelopeTemplate | EnvelopeTemplate |
| CEnvelopeTemplateDefinition | 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. |
| CEnvelopeTemplateResult | EnvelopeTemplateResult |
| CEnvelopeTemplateResults | Information about templates. |
| CEnvelopeTransactionStatus | EnvelopeTransactionStatus |
| CEnvelopeTransferRule | This object contains details about an envelope transfer rule. |
| CEnvelopeTransferRuleInformation | EnvelopeTransferRuleInformation |
| CEnvelopeTransferRuleRequest | This object contains details about the envelope transfer rule that you want to create. |
| CEnvelopeUpdateSummary | EnvelopeUpdateSummary |
| CEnvelopeViewDocumentSettings | EnvelopeViewDocumentSettings |
| CEnvelopeViewEnvelopeCustomFieldSettings | EnvelopeViewEnvelopeCustomFieldSettings |
| CEnvelopeViewRecipientSettings | EnvelopeViewRecipientSettings |
| CEnvelopeViewRequest | EnvelopeViewRequest |
| CEnvelopeViewSettings | EnvelopeViewSettings |
| CEnvelopeViewTaggerSettings | EnvelopeViewTaggerSettings |
| CEnvelopeViewTemplateSettings | EnvelopeViewTemplateSettings |
| CErrorDetails | This object describes errors that occur. It is only valid for responses, and ignored in requests. |
| CEventNotification | This optional complex element allows a message to be sent a specified URL when the envelope or recipient changes status. It is similar to DocuSign Connect. For example, if an envelope changes from "Sent" to "Delivered", a message containing the updated envelope status and optionally the documents is sent to the URL. When an eventNotification is attached to an envelope using the API, it only applies to the envelope (treating the envelope as the sender). This is different from envelopes created through the console user interface, where the user is treated as the sender. |
| CEventResult | Information about the result of an event. |
| CExpirations | A complex element that specifies the expiration settings for the envelope. |
| CExternalClaim | ExternalClaim |
| CExternalDocServiceErrorDetails | ExternalDocServiceErrorDetails |
| CExternalDocumentSources | A complex object specifying the external document sources. |
| CExternalFile | This object contains information about a file or folder in cloud storage. |
| CExternalFolder | ExternalFolder |
| CExternalPrimaryAccountRecipientAuthRequirements | ExternalPrimaryAccountRecipientAuthRequirements |
| CFavoriteTemplatesContentItem | FavoriteTemplatesContentItem |
| CFavoriteTemplatesInfo | FavoriteTemplatesInfo |
| CFeatureAvailableMetadata | FeatureAvailableMetadata |
| CFeatureSet | This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only. |
| CFileType | FileType |
| CFileTypeList | FileTypeList |
| CFilter | Use this object to create a filtered view of the items in a folder. |
| CFirstName | 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. |
| CFolder | This object contains details about a folder. |
| CFolderItem | FolderItem |
| CFolderItemResponse | Results from a folder item request. |
| CFolderItemsResponse | FolderItemsResponse |
| CFolderItemV2 | Information about folder item results. |
| CFolderSharedItem | FolderSharedItem |
| CFoldersRequest | Information for a folder request. |
| CFoldersResponse | FoldersResponse |
| CForgottenPasswordInformation | A complex element that has up to four Question/Answer pairs for forgotten password information. |
| CFormDataItem | FormDataItem |
| CFormulaTab | 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 |
| CFullName | A tab that displays the recipient's full name. |
| CGraphicsContext | GraphicsContext |
| CGroup | This object contains information about a group. |
| CGroupBrands | GroupBrands |
| CGroupInformation | GroupInformation |
| CIdCheckConfiguration | A complex object specifying ID check configuration. |
| CIdCheckInformationInput | 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. |
| CIdCheckSecurityStep | IdCheckSecurityStep |
| CIdEvidenceResourceToken | IdEvidenceResourceToken |
| CIdEvidenceViewLink | IdEvidenceViewLink |
| CInitialHere | A tab that allows the recipient to initial the document. May be optional. |
| CInlineTemplate | InlineTemplate |
| CInPersonSigner | Contains information about an in-person recipient. This is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about the fields used for the eNotary feature, see the [recipients resource][resource]. [resource]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-recipient |
| CIntegratedConnectUserInfoList | IntegratedConnectUserInfoList |
| CIntegratedUserInfoList | IntegratedUserInfoList |
| CIntermediary | Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added. |
| CJurisdiction | Describes the jurisdiction of a notary. This is read-only object. |
| CJurisdictionSummary | JurisdictionSummary |
| CLastName | 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. |
| CLinkedExternalPrimaryAccount | LinkedExternalPrimaryAccount |
| CList | This tab offers a list of options to choose from. The `listItems` property contains a list of `listItem` objects to specify the selectable options. |
| CListCustomField | This object represents a list custom field from which envelope creators and senders can select custom data. |
| CListItem | One of the selectable items in the `listItems` property of a `list` tab. |
| CLocalePolicy | LocalePolicy |
| CLocalePolicyTab | LocalePolicyTab |
| CLockInformation | LockInformation |
| CLockRequest | This request object contains information about the lock that you want to create or update. |
| CLoginAccount | LoginAccount |
| CLoginInformation | LoginInformation |
| CMatchBox | MatchBox |
| CMemberGroupSharedItem | Information about items shared among groups. |
| CMemberSharedItems | Information about shared items. |
| CMergeField | Contains information for transfering values between Salesforce data fields and DocuSign Tabs. |
| CMobileNotifierConfiguration | MobileNotifierConfiguration |
| CMobileNotifierConfigurationInformation | MobileNotifierConfigurationInformation |
| CMoney | Describes information about the `total` of a payment. |
| CNameValue | A name-value pair that describes an item and provides a value for the item. |
| CNewAccountDefinition | NewAccountDefinition |
| CNewAccountSummary | NewAccountSummary |
| CNewUser | Object representing a new user. |
| CNewUsersDefinition | NewUsersDefinition |
| CNewUsersSummary | Object representing a summary of data for new users. |
| CNotarize | A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page. |
| CNotary | Notary |
| CNotaryCertificate | NotaryCertificate |
| CNotaryContactDetails | NotaryContactDetails |
| CNotaryHost | 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. |
| CNotaryJournal | NotaryJournal |
| CNotaryJournalCredibleWitness | NotaryJournalCredibleWitness |
| CNotaryJournalList | NotaryJournalList |
| CNotaryJournalMetaData | NotaryJournalMetaData |
| CNotaryJurisdiction | A notary jurisdiction. |
| CNotaryJurisdictionList | A paged list of jurisdictions. |
| CNotaryRecipient | NotaryRecipient |
| CNotaryResult | Describes a single notary jurisdiction. |
| CNotarySeal | A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ |
| CNote | A tab that displays additional information, in the form of a note, for the recipient. |
| CNotification | 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. |
| CNotificationDefaults | NotificationDefaults |
| CNotificationDefaultSettings | Contains details about the default notification settings for the envelope notifications that senders and signers receive. |
| CNumber | A tab that allows the recipient to enter numbers and decimal (.) points. |
| CNumerical | Numerical |
| COauthAccess | OauthAccess |
| COcrRequest | OcrRequest |
| COfflineAttributes | Reserved for DocuSign use. |
| CPage | Description of a page of a document. |
| CPageImages | PageImages |
| CPageRequest | PageRequest |
| CPageSize | PageSize |
| CPaletteItemSettings | PaletteItemSettings |
| CPaletteSettings | PaletteSettings |
| CParticipant | Participant |
| CPathExtendedElement | PathExtendedElement |
| CPaymentDetails | 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 |
| CPaymentGatewayAccount | This object contains details about a payment gateway account. |
| CPaymentGatewayAccountSetting | PaymentGatewayAccountSetting |
| CPaymentGatewayAccountsInfo | Holds information about connected payment accounts. |
| CPaymentLineItem | A line item describes details about an individual line item in a payment request. |
| CPaymentMethodWithOptions | This object contains information about a payment method that the gateway accepts and the payment options that are compatible with it. |
| CPaymentProcessorInformation | PaymentProcessorInformation |
| CPaymentSignerValues | PaymentSignerValues |
| CPayPalLegacySettings | PayPalLegacySettings |
| CPermissionProfile | This object defines the account permissions for a profile that you can apply to a group of users. |
| CPermissionProfileInformation | Contains details about the permission profiles associated with an account. |
| CPhoneNumber | A Phone Number tab enables a recipient to enter a phone number. Note: This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ |
| CPlanInformation | An object used to identify the features and attributes of the account being created. |
| CPolyLine | PolyLine |
| CPolyLineOverlay | This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates. |
| CPowerForm | Contains details about a PowerForm. |
| CPowerFormFormDataEnvelope | PowerFormFormDataEnvelope |
| CPowerFormFormDataRecipient | PowerFormFormDataRecipient |
| CPowerFormRecipient | Note: For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`. |
| CPowerFormSendersResponse | This object includes information about the users who have sent PowerForms. |
| CPowerFormsFormDataResponse | PowerFormsFormDataResponse |
| CPowerFormsRequest | PowerFormsRequest |
| CPowerFormsResponse | A list of PowerForms. |
| CPrefillFormData | PrefillFormData |
| CPrefillTabs | Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields |
| CProofServiceResourceToken | ProofServiceResourceToken |
| CProofServiceViewLink | ProofServiceViewLink |
| CPropertyMetadata | Metadata about a property. |
| CProvince | Province |
| CProvisioningInformation | ProvisioningInformation |
| CPurchasedEnvelopesInformation | PurchasedEnvelopesInformation |
| CRadio | One of the selectable radio buttons in the `radios` property of a `radioGroup` tab. |
| CRadioGroup | 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. |
| CRecipientAdditionalNotification | Describes an additional notification method. |
| CRecipientAttachment | RecipientAttachment |
| CRecipientDomain | RecipientDomain |
| CRecipientEmail | RecipientEmail |
| CRecipientEmailNotification | RecipientEmailNotification |
| CRecipientEvent | RecipientEvent |
| CRecipientFormData | RecipientFormData |
| CRecipientGroup | Describes a group of recipients. |
| CRecipientIdentityInputOption | RecipientIdentityInputOption |
| CRecipientIdentityPhoneNumber | RecipientIdentityPhoneNumber |
| CRecipientIdentityVerification | Specifies ID Verification applied on an envelope by workflow ID. See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other recipient authentication methods. |
| CRecipientNamesResponse | This response object contains a list of recipients. |
| CRecipientOption | Describes a recipient who is a member of a conditional group. |
| CRecipientPhoneAuthentication | 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. |
| CRecipientPhoneNumber | Describes the recipient phone number. |
| CRecipientPreviewRequest | This request object contains the information necessary to create a recipient preview. |
| CRecipientProofFile | The proof file of the recipient. ID Evidence uses proof files to store the identification data that recipients submit when verifying their ID with ID Verification |
| CRecipientRouting | Describes the recipient routing rules. |
| CRecipientRules | RecipientRules |
| CRecipients | Specifies the envelope recipients. |
| CRecipientSAMLAuthentication | 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. |
| CRecipientSignatureInformation | 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. |
| CRecipientSignatureProvider | An Electronic or Standards Based Signature (digital signature) provider for the signer to use. More information. |
| CRecipientSignatureProviderOptions | Option settings for the signature provider. Different providers require or use different options. The current provider list and the options they require. |
| CRecipientSMSAuthentication | Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. |
| CRecipientsUpdateSummary | This is the response that the API returns after you update recipients. |
| CRecipientTokenClientURLs | RecipientTokenClientURLs |
| CRecipientUpdateResponse | The recipient details that are returned after you update the recipient. |
| CRecipientViewRequest | The request body for the EnvelopeViews: createRecipient and EnvelopeViews: createSharedRecipient methods. |
| CReferralInformation | 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. |
| CReminders | A complex element that specifies reminder settings for the envelope |
| CReportInProductCsvRunRequest | ReportInProductCsvRunRequest |
| CReportInProductField | ReportInProductField |
| CReportInProductGet | ReportInProductGet |
| CReportInProductList | ReportInProductList |
| CReportInProductListItem | ReportInProductListItem |
| CReportInProductRunRequest | ReportInProductRunRequest |
| CReportInProductRunResponse | ReportInProductRunResponse |
| CReportInProductRunResponseRow | ReportInProductRunResponseRow |
| CReportInProductRunResponseRowFields | ReportInProductRunResponseRowFields |
| CReportInProductSaveResponse | ReportInProductSaveResponse |
| CReportInProductSentByDetails | ReportInProductSentByDetails |
| CReservedDomainExistence | ReservedDomainExistence |
| CResourceInformation | ResourceInformation |
| CReturnUrlRequest | The request body for the EnvelopeViews: createSender method. |
| CRevision | Revision |
| CSamlAssertionAttribute | SamlAssertionAttribute |
| CScheduledSending | ScheduledSending |
| CScheduledSendingApiModel | ScheduledSendingApiModel |
| CSeal | Seal |
| CSealIdentifier | SealIdentifier |
| CSealSign | Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow. Example: ```json "recipients": { "seals": [ { "recipientId": "1", "routingOrder" : 1, "recipientSignatureProviders": [ { "sealName": "52e9d968-xxxx-xxxx-xxxx-4682bc45c106" } ] } ] }, . . . ``` For more information about Electronic Seals, see Apply Electronic Seals to Your Documents. |
| CSeatDiscount | This object contains information about a seat discount. |
| CSender | Sender |
| CSenderCompany | SenderCompany |
| CSenderEmailNotifications | Contains the settings for the email notifications that senders receive about the envelopes that they send. |
| CSenderName | SenderName |
| CServerTemplate | ServerTemplate |
| CServiceInformation | ServiceInformation |
| CServiceVersion | ServiceVersion |
| CSettingsMetadata | Metadata that indicates whether a property is editable and describes setting-specific options. |
| CSharedItem | Information about the shared item. |
| CSignatureDataInfo | SignatureDataInfo |
| CSignatureGroup | SignatureGroup |
| CSignatureGroupDef | SignatureGroupDef |
| CSignatureProperties | SignatureProperties |
| CSignatureProviderRequiredOption | Contains additional information that a specific signature provider requires. |
| CSignatureType | This object contains information about the type of signature. |
| CSignatureUser | SignatureUser |
| CSignatureUserDef | SignatureUserDef |
| CSigner | A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document. |
| CSignerAttachment | A tab that allows the recipient to attach supporting documents to an envelope. |
| CSignerEmailNotifications | 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. |
| CSignHashDocument | SignHashDocument |
| CSignHashSessionInfoResponse | SignHashSessionInfoResponse |
| CSignHere | A tab that allows the recipient to sign a document. May be optional. |
| CSigningGroup | Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. |
| CSigningGroupInformation | SigningGroupInformation |
| CSigningGroupUser | SigningGroupUser |
| CSigningGroupUsers | SigningGroupUsers |
| CSignSessionInfoRequest | SignSessionInfoRequest |
| CSmartContractInformation | SmartContractInformation |
| CSmartSection | SmartSection |
| CSmartSectionAnchorPosition | SmartSectionAnchorPosition |
| CSmartSectionCollapsibleDisplaySettings | SmartSectionCollapsibleDisplaySettings |
| CSmartSectionDisplaySettings | These properties define how a Smart Section displays. A Smart Section is a type of display section. |
| CSocialAccountInformation | SocialAccountInformation |
| CSocialAuthentication | SocialAuthentication |
| CSsn | 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. |
| CSsn4InformationInput | Ssn4InformationInput |
| CSsn9InformationInput | Ssn9InformationInput |
| CStamp | Stamp |
| CSupportedLanguages | A list of supported languages. |
| CTabAccountSettings | TabAccountSettings |
| CTabGroup | TabGroup |
| CTabMetadata | TabMetadata |
| CTabMetadataList | TabMetadataList |
| CTabs | Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. |
| CTemplateCustomFields | TemplateCustomFields |
| CTemplateDocumentsResult | TemplateDocumentsResult |
| CTemplateDocumentVisibilityList | A list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients. |
| CTemplateInformation | TemplateInformation |
| CTemplateMatch | TemplateMatch |
| CTemplateNotificationRequest | TemplateNotificationRequest |
| CTemplateRecipients | TemplateRecipients |
| CTemplateRole | Information about a specific role. |
| CTemplateSharedItem | Information about shared templates. |
| CTemplateSummary | Summary of a template request. |
| CTemplateTabs | TemplateTabs |
| CTemplateUpdateSummary | TemplateUpdateSummary |
| CTemplateViewRequest | TemplateViewRequest |
| CText | A tab that allows the recipient to enter any type of text. |
| CTextCustomField | This object represents a free text custom field where envelope creators and senders can enter custom data. |
| CTimeStampField | TimeStampField |
| CTitle | A tab that displays the recipient's title. |
| CTspHealthCheckRequest | TspHealthCheckRequest |
| CTspHealthCheckStatusDescription | TspHealthCheckStatusDescription |
| CUpdateTransactionRequest | UpdateTransactionRequest |
| CUpdateTransactionResponse | UpdateTransactionResponse |
| CUsageHistory | 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. |
| CUser | User |
| CUserAccountManagementGranularInformation | Describes which account management capabilities a user has. |
| CUserAuthorization | UserAuthorization |
| CUserAuthorizationCreateRequest | UserAuthorizationCreateRequest |
| CUserAuthorizationCreateRequestWithId | UserAuthorizationCreateRequestWithId |
| CUserAuthorizationIdWithStatus | UserAuthorizationIdWithStatus |
| CUserAuthorizations | UserAuthorizations |
| CUserAuthorizationsDeleteRequest | UserAuthorizationsDeleteRequest |
| CUserAuthorizationsDeleteResponse | UserAuthorizationsDeleteResponse |
| CUserAuthorizationsRequest | UserAuthorizationsRequest |
| CUserAuthorizationsResponse | UserAuthorizationsResponse |
| CUserAuthorizationUpdateRequest | UserAuthorizationUpdateRequest |
| CUserAuthorizationWithStatus | UserAuthorizationWithStatus |
| CUserInfo | UserInfo |
| CUserInfoList | UserInfoList |
| CUserInfoResponse | UserInfoResponse |
| CUserInformation | User information. |
| CUserInformationList | Contains a list of account users. |
| CUserPasswordInformation | UserPasswordInformation |
| CUserPasswordRules | Contains details about the password rules for a user. |
| CUserProfile | UserProfile |
| CUserSettingsInformation | Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following: - `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`) - `uiHint`: Internally used to build UIs (can be `available` or `hidden`) - `options`: The values supported for this setting (not all settings have this element) |
| CUserSharedItem | Information about a shared item. |
| CUserSignature | UserSignature |
| CUserSignatureDefinition | UserSignatureDefinition |
| CUserSignaturesInformation | UserSignaturesInformation |
| CUserSocialIdResult | UserSocialIdResult |
| CUsersResponse | UsersResponse |
| CView | This tab is used with the Approve tab to handle supplemental documents. |
| CViewLinkRequest | ViewLinkRequest |
| CViewUrl | ViewUrl |
| CWatermark | Watermark |
| CWitness | A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. |
| CWorkflow | Describes the workflow for an envelope. |
| CWorkflowStep | Describes a single step in a workflow. |
| CWorkspace | Provides properties that describe a workspace. |
| CWorkspaceFolderContents | Provides properties that describe the contents of a workspace folder. |
| CWorkspaceItem | A workspaceItem (file type only) representing the file. This property is only returned in response to file specific GET call. |
| CWorkspaceItemList | Provides properties that describe the items contained in a workspace. |
| CWorkspaceList | Provides properties that describe the workspaces avaialble. |
| CWorkspaceSettings | This object provides information about the settings for the workspace. |
| CWorkspaceUser | A workspaceUser representing the user. This property is only returned in response to user specific GET call. |
| CWorkspaceUserAuthorization | Provides properties that describe user authorization to a workspace. |
| CZip | 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. |
