| AccessCodeFormat |
Object specifying the format of the string provided to a recipient in order to access an
envelope..
|
| AccountAddress |
Contains information about an account address..
|
| AccountBillingPlan |
Contains information about an account billing plan..
|
| AccountBillingPlanResponse |
Defines an account billing plan response object..
|
| AccountIdentityInputOption |
AccountIdentityInputOption.
|
| AccountIdentityVerificationResponse |
AccountIdentityVerificationResponse.
|
| AccountIdentityVerificationStep |
Information about a specific step in an Identity Verification workflow..
|
| AccountIdentityVerificationWorkflow |
Specifies an Identity Verification workflow..
|
| AccountInformation |
Contains account Information..
|
| AccountMinimumPasswordLength |
AccountMinimumPasswordLength.
|
| AccountNotification |
A complex element that specifies notifications (expirations and reminders) for the envelope..
|
| AccountPasswordExpirePasswordDays |
AccountPasswordExpirePasswordDays.
|
| AccountPasswordLockoutDurationMinutes |
AccountPasswordLockoutDurationMinutes.
|
| AccountPasswordLockoutDurationType |
AccountPasswordLockoutDurationType.
|
| AccountPasswordMinimumPasswordAgeDays |
AccountPasswordMinimumPasswordAgeDays.
|
| AccountPasswordQuestionsRequired |
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..
|
| AccountPasswordRules |
AccountPasswordRules.
|
| AccountPasswordStrengthType |
AccountPasswordStrengthType.
|
| AccountPasswordStrengthTypeOption |
AccountPasswordStrengthTypeOption.
|
| AccountRoleSettings |
This object defines account permissions for users who are associated with the account permission
profile.
|
| AccountSeals |
AccountSeals.
|
| AccountSettingsInformation |
Contains account settings information..
|
| AccountSharedAccess |
Contains shared access information..
|
| AccountSignature |
AccountSignature.
|
| AccountSignatureDefinition |
AccountSignatureDefinition.
|
| AccountSignatureProvider |
Contains information abotu the signature provider associated with the Identity Verification
workflow.
|
| AccountSignatureProviderOption |
Reserved for DocuSign..
|
| AccountSignatureProviders |
AccountSignatureProviders.
|
| AccountSignaturesInformation |
AccountSignaturesInformation.
|
| AccountUISettings |
An object that defines the options that are available to non-administrators in the UI..
|
| AddOn |
Contains information about add ons..
|
| AddressInformation |
Contains address information..
|
| AddressInformationInput |
Contains address input information..
|
| AddressInformationV2 |
AddressInformationV2
|
| AdminMessage |
AdminMessage.
|
| Agent |
Contains information about agent recipients..
|
| ApiRequestLog |
Contains API request log information..
|
| ApiRequestLogsResult |
Contains information about mutiple API request logs..
|
| Approve |
A tab that allows the recipient to approve documents without placing a signature or initials on
the document.
|
| AppStoreProduct |
Contains information about an APP store product..
|
| AppStoreReceipt |
Contains information about an APP store receipt..
|
| AskAnAdmin |
AskAnAdmin.
|
| Attachment |
Contains information about an attachment..
|
| AuthenticationMethod |
Contains information about the method used for authentication..
|
| AuthenticationStatus |
Contains information about the authentication status..
|
| BccEmailAddress |
Contains information about the BCC email address..
|
| BccEmailArchive |
This object contains information abut a BCC email archive configuration (a BCC email address used
to archive DocuSign-generated emails)..
|
| BccEmailArchiveHistory |
Contains details about the history of the BCC email archive configuration..
|
| BccEmailArchiveHistoryList |
BccEmailArchiveHistoryList.
|
| BccEmailArchiveList |
Contains a list of BCC email archive configurations..
|
| BillingCharge |
Contains information about a billing charge..
|
| BillingChargeResponse |
Defines a billing charge response object..
|
| BillingDiscount |
BillingDiscount.
|
| BillingEntityInformationResponse |
BillingEntityInformationResponse.
|
| BillingInvoice |
Contains information about a billing invoice..
|
| BillingInvoiceItem |
Contains information about an item on a billing invoice..
|
| BillingInvoicesResponse |
Defines a billing invoice response object..
|
| BillingInvoicesSummary |
BillingInvoicesSummary.
|
| BillingPayment |
Contains information on a billing plan..
|
| BillingPaymentItem |
Defines a billing payment request object..
|
| BillingPaymentRequest |
BillingPaymentRequest.
|
| BillingPaymentResponse |
Defines an billing payment response object..
|
| BillingPaymentsResponse |
Defines a billing payments response object..
|
| BillingPlan |
Contains information about a billing plan..
|
| BillingPlanInformation |
This object contains details about a billing plan..
|
| BillingPlanPreview |
Contains information about a preview billing plan..
|
| BillingPlanResponse |
Defines a billing plan response object..
|
| BillingPlansResponse |
Defines a billing plans response object..
|
| BillingPlanUpdateResponse |
Defines a billing plan update response object..
|
| BillingPrice |
BillingPrice.
|
| Brand |
Information about a brand that is associated with an account.
|
| BrandEmailContent |
Deprecated..
|
| BrandLink |
Information about a link that a brand uses..
|
| BrandLogos |
The URIs for retrieving the logos that are associated with the brand.
|
| BrandRequest |
This request object contains information about a specific brand..
|
| BrandResources |
Information about the resource files that the brand uses for the email, signing, sending, and
captive (embedded) signing experiences..
|
| BrandResourcesList |
BrandResourcesList.
|
| BrandResourceUrls |
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..
|
| BrandsRequest |
Details about one or more brands..
|
| BrandsResponse |
BrandsResponse.
|
| BulkEnvelope |
BulkEnvelope.
|
| BulkEnvelopesResponse |
BulkEnvelopesResponse
|
| BulkEnvelopeStatus |
BulkEnvelopeStatus.
|
| BulkProcessingLists |
BulkProcessingLists.
|
| BulkProcessingListSummaries |
BulkProcessingListSummaries.
|
| BulkProcessingListSummary |
BulkProcessingListSummary.
|
| BulkProcessRequest |
BulkProcessRequest.
|
| BulkProcessResponse |
BulkProcessResponse.
|
| BulkProcessResult |
BulkProcessResult.
|
| BulkRecipient |
BulkRecipient.
|
| BulkRecipientSignatureProvider |
BulkRecipientSignatureProvider.
|
| BulkRecipientsRequest |
BulkRecipientsRequest.
|
| BulkRecipientsResponse |
BulkRecipientsResponse.
|
| BulkRecipientsSummaryResponse |
BulkRecipientsSummaryResponse.
|
| BulkRecipientsUpdateResponse |
BulkRecipientsUpdateResponse.
|
| BulkRecipientTabLabel |
BulkRecipientTabLabel.
|
| BulkSendBatchActionRequest |
BulkSendBatchActionRequest.
|
| BulkSendBatchError |
BulkSendBatchError.
|
| BulkSendBatchRequest |
BulkSendBatchRequest.
|
| BulkSendBatchStatus |
Result of `getBulkSendBatchStatus`.
|
| BulkSendBatchSummaries |
A list of bulk send batch summaries.
|
| BulkSendBatchSummary |
Summary status of a single batch..
|
| BulkSendEnvelopesInfo |
BulkSendEnvelopesInfo.
|
| BulkSendErrorStatus |
A single bulk send error report..
|
| BulkSendingCopy |
This object contains the details to use for a specific copy, or instance, of the envelope.
|
| BulkSendingCopyCustomField |
This object contains details about a custom field for a bulk send copy.
|
| BulkSendingCopyRecipient |
This object contains details about a bulk send recipient..
|
| BulkSendingCopyTab |
A tab associated with the bulk send recipient.
|
| BulkSendingList |
This object contains the details for the bulk send list..
|
| BulkSendingListSummaries |
This complex type contains summaries that provide basic information about the bulk send lists
that belong to the current user..
|
| BulkSendingListSummary |
This object contains basic information about a bulk send list..
|
| BulkSendRequest |
This object contains information about the envelope or template that you want to send in bulk..
|
| BulkSendResponse |
The object contains the response to a bulk send request..
|
| BulkSendTestResponse |
This object contains the results of a bulk send test..
|
| CaptiveRecipient |
This object contains details about a captive (embedded) recipient..
|
| CaptiveRecipientInformation |
Contains information about captive (embedded) recipients..
|
| CarbonCopy |
Contains information about a carbon copy recipient.
|
| CertifiedDelivery |
Contains information about a certified delivery recipient.
|
| Checkbox |
A tab that allows the recipient to select a yes/no (on/off) option.
|
| ChunkedUploadPart |
An object that contains information about the chunked upload part..
|
| ChunkedUploadRequest |
This is the request object for uploading a chunked upload..
|
| ChunkedUploadResponse |
This response object is returned after you upload a chunked upload..
|
| CloudStorageProvider |
Contains details about a specific cloud storage provider..
|
| CloudStorageProviders |
CloudStorageProviders.
|
| Comment |
Comment.
|
| CommentHistoryResult |
CommentHistoryResult.
|
| CommentPublish |
CommentPublish.
|
| CommentsPublish |
CommentsPublish.
|
| CommentThread |
CommentThread.
|
| CommissionCounty |
A Commission County tab displays the county of a notary's commission.
|
| CommissionExpiration |
A Commission Expiration tab displays the expiration date of a notary's commission.
|
| CommissionNumber |
A Commission Number tab displays a notary's commission number.
|
| CommissionState |
A Commission State tab displays the state in which a notary's commission was granted.
|
| Company |
A tab that displays the recipient's company name.
|
| CompleteSignHashResponse |
CompleteSignHashResponse
|
| CompleteSignRequest |
CompleteSignRequest
|
| CompositeTemplate |
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.
|
| ConciergeQueryRequest |
ConciergeQueryRequest
|
| ConciergeQueryResponse |
ConciergeQueryResponse
|
| ConditionalRecipientRule |
A rule that defines a set of recipients and the conditions under which they will be used for the
envelope..
|
| ConditionalRecipientRuleCondition |
ConditionalRecipientRuleCondition.
|
| ConditionalRecipientRuleFilter |
ConditionalRecipientRuleFilter.
|
| ConnectConfigResults |
This object contains the results of a ConnectConfigurations::GET method..
|
| ConnectCustomConfiguration |
The `connectCustomConfiguration` object describes how Connect is configured for your
account..
|
| ConnectDebugLog |
ConnectDebugLog.
|
| ConnectEventData |
This object lets you choose the data format of your Connect response.
|
| ConnectFailureFilter |
A list of failed envelope IDs to retry..
|
| ConnectFailureResult |
This object contains details about a Connect failure result..
|
| ConnectFailureResults |
ConnectFailureResults.
|
| ConnectHistoricalEnvelopeRepublish |
ConnectHistoricalEnvelopeRepublish.
|
| ConnectLog |
Contains information about a Connect log entry..
|
| ConnectLogs |
ConnectLogs.
|
| ConnectOAuthConfig |
ConnectOAuthConfig.
|
| ConnectSalesforceField |
This object is used to match a DocuSign field to a Salesforce field so that Docusign can send
information to your Salesforce account..
|
| ConnectSalesforceObject |
A `connectSalesforceObject` is an object that updates envelope and document status or
recipient status in your Salesforce account.
|
| ConnectUserInfo |
ConnectUserInfo.
|
| ConnectUserObject |
ConnectUserObject.
|
| ConsentDetails |
ConsentDetails.
|
| ConsoleViewRequest |
The request object for the [EnvelopeViews:
createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) method..
|
| ConsumerDisclosure |
Details about consumer disclosures..
|
| Contact |
Contact.
|
| ContactGetResponse |
This response object contains information about the contacts associated with an account..
|
| ContactModRequest |
The request object containing the new information for the contacts..
|
| ContactPhoneNumber |
Details about the phone numbers associated with a specific contact..
|
| ContactUpdateResponse |
This response objects shows the updated details for the contacts..
|
| CorrectViewRequest |
The request body for the [EnvelopeViews:
createCorrect](/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/) method..
|
| Country |
Country.
|
| Credential |
Credential
|
| CreditCardInformation |
This object contains information about a credit card that is associated with an account..
|
| CreditCardTypes |
CreditCardTypes.
|
| Currency |
Currency.
|
| CurrencyFeatureSetPrice |
Information about the price and currency associated with the feature set.
|
| CurrencyPlanPrice |
CurrencyPlanPrice.
|
| CustomField |
This object provides details about a custom field..
|
| CustomFields |
Contains information about custom fields..
|
| CustomFieldsEnvelope |
CustomFieldsEnvelope.
|
| CustomFieldV2 |
CustomFieldV2
|
| CustomSettingsInformation |
CustomSettingsInformation.
|
| Date |
A tab that allows the recipient to enter a date.
|
| DateSigned |
A tab that displays the date that the recipient signed the document.
|
| DateStampProperties |
Specifies the area in which a date stamp is placed.
|
| Decline |
A tab that allows the recipient the option of declining an envelope.
|
| DelayedRouting |
DelayedRouting.
|
| DelayedRoutingApiModel |
DelayedRoutingApiModel.
|
| DelegationInfo |
DelegationInfo.
|
| DiagnosticsSettingsInformation |
DiagnosticsSettingsInformation.
|
| DirectDebitProcessorInformation |
Contains information about a bank that processes a customer's direct debit payments..
|
| DisplayApplianceAccount |
DisplayApplianceAccount
|
| DisplayApplianceDocument |
DisplayApplianceDocument
|
| DisplayApplianceDocumentPage |
DisplayApplianceDocumentPage
|
| DisplayApplianceEnvelope |
DisplayApplianceEnvelope
|
| DisplayAppliancePage |
DisplayAppliancePage
|
| DisplayApplianceRecipient |
DisplayApplianceRecipient
|
| DobInformationInput |
Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse.
|
| Document |
A document object..
|
| DocumentFieldsInformation |
DocumentFieldsInformation.
|
| DocumentHtmlCollapsibleDisplaySettings |
Display settings for collapsible section..
|
| DocumentHtmlDefinition |
Holds the properties that define how to generate the responsive-formatted HTML for the document.
|
| DocumentHtmlDefinitionOriginal |
DocumentHtmlDefinitionOriginal.
|
| DocumentHtmlDefinitionOriginals |
DocumentHtmlDefinitionOriginals.
|
| DocumentHtmlDefinitions |
DocumentHtmlDefinitions.
|
| DocumentHtmlDisplayAnchor |
DocumentHtmlDisplayAnchor.
|
| DocumentHtmlDisplaySettings |
DocumentHtmlDisplaySettings.
|
| DocumentSecurityStore |
DocumentSecurityStore
|
| DocumentTemplate |
DocumentTemplate.
|
| DocumentTemplateList |
DocumentTemplateList.
|
| DocumentUpdateInfo |
DocumentUpdateInfo
|
| DocumentVisibility |
This object configures a recipient's read/write access to a document..
|
| DocumentVisibilityList |
A list of `documentVisibility` objects that specify whether documents are visible to
recipients..
|
| DowngradeBillingPlanInformation |
DowngradeBillingPlanInformation.
|
| DowngradePlanUpdateResponse |
DowngradePlanUpdateResponse.
|
| DowngradeRequestInformation |
DowngradeRequestInformation.
|
| DowngradRequestBillingInfoResponse |
DowngradRequestBillingInfoResponse.
|
| Draw |
A tab that allows the recipient to add a free-form drawing to the document..
|
| Editor |
A complex type defining the management and access rights of a recipient assigned as an editor on
the envelope.
|
| Email |
A tab that allows the recipient to enter an email address.
|
| EmailAddress |
A tab that displays the recipient's email as entered in the recipient information.
|
| EmailSettings |
A complex element that allows the sender to override some envelope email setting information.
|
| ENoteConfiguration |
This object contains information used to configure
[eNote](https://www.docusign.com/products/enote) functionality.
|
| Envelope |
Envelope.
|
| EnvelopeAttachment |
EnvelopeAttachment.
|
| EnvelopeAttachmentsRequest |
EnvelopeAttachmentsRequest.
|
| EnvelopeAttachmentsResult |
EnvelopeAttachmentsResult.
|
| EnvelopeAuditEvent |
EnvelopeAuditEvent.
|
| EnvelopeAuditEventResponse |
EnvelopeAuditEventResponse.
|
| EnvelopeCustomMetadata |
EnvelopeCustomMetadata.
|
| EnvelopeDefinition |
Envelope object definition..
|
| EnvelopeDelayRule |
EnvelopeDelayRule.
|
| EnvelopeDelayRuleApiModel |
An envelope delay rule is a rule which determines how the envelope should be delayed either for
sending or routing.
|
| EnvelopeDocument |
This object contains details about the envelope document..
|
| EnvelopeDocumentsResult |
EnvelopeDocumentsResult.
|
| EnvelopeEvent |
For which envelope events should your webhook be called?.
|
| EnvelopeFormData |
Describes the form data of the envelope..
|
| EnvelopeFormDataPrefillFormData |
EnvelopeFormDataPrefillFormData
|
| EnvelopeId |
A tab that displays the envelope ID.
|
| EnvelopeIdsRequest |
Lists of envelope and transaction IDs to use in the results.
|
| EnvelopeMetadata |
EnvelopeMetadata.
|
| EnvelopeNotificationRequest |
A complex element that specifies the notification settings for the envelope..
|
| EnvelopePublishRequest |
EnvelopePublishRequest
|
| EnvelopePublishTransaction |
EnvelopePublishTransaction.
|
| EnvelopePublishTransactionErrorRollup |
EnvelopePublishTransactionErrorRollup.
|
| EnvelopePublishTransactionList |
EnvelopePublishTransactionList
|
| EnvelopePurgeConfiguration |
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`).
|
| EnvelopesInformation |
Result set for the Envelopes: listStatusChanges method.
|
| EnvelopeSummary |
This object describes an envelope..
|
| EnvelopeTemplate |
EnvelopeTemplate.
|
| EnvelopeTemplateDefinition |
A complex element containing the following information: templateId: Unique identifier of the
template.
|
| EnvelopeTemplateResult |
EnvelopeTemplateResult
|
| EnvelopeTemplateResults |
Information about templates..
|
| EnvelopeTransactionStatus |
EnvelopeTransactionStatus.
|
| EnvelopeTransferRule |
This object contains details about an envelope transfer rule..
|
| EnvelopeTransferRuleInformation |
EnvelopeTransferRuleInformation.
|
| EnvelopeTransferRuleRequest |
This object contains details about the envelope transfer rule that you want to create..
|
| EnvelopeUpdateSummary |
EnvelopeUpdateSummary.
|
| ErrorDetails |
This object describes errors that occur.
|
| EventNotification |
This optional complex element allows a message to be sent a specified URL when the envelope or
recipient changes status.
|
| EventResult |
Information about the result of an event..
|
| Expirations |
A complex element that specifies the expiration settings for the envelope..
|
| ExternalClaim |
ExternalClaim
|
| ExternalDocServiceErrorDetails |
ExternalDocServiceErrorDetails.
|
| ExternalDocumentSources |
A complex object specifying the external document sources..
|
| ExternalFile |
This object contains information about a file or folder in cloud storage..
|
| ExternalFolder |
ExternalFolder.
|
| ExternalPrimaryAccountRecipientAuthRequirements |
ExternalPrimaryAccountRecipientAuthRequirements.
|
| FavoriteTemplatesContentItem |
FavoriteTemplatesContentItem.
|
| FavoriteTemplatesInfo |
FavoriteTemplatesInfo.
|
| FeatureAvailableMetadata |
FeatureAvailableMetadata.
|
| FeatureSet |
This object provides details about a feature set, or add-on product that is associated with an
account.
|
| FileType |
FileType.
|
| FileTypeList |
FileTypeList.
|
| Filter |
Use this object to create a filtered view of the items in a folder..
|
| FirstName |
A tab that displays the recipient's first name.
|
| Folder |
This object contains details about a folder..
|
| FolderItem |
FolderItem
|
| FolderItemResponse |
Results from a folder item request..
|
| FolderItemsResponse |
FolderItemsResponse.
|
| FolderItemV2 |
Information about folder item results..
|
| FolderSharedItem |
FolderSharedItem.
|
| FoldersRequest |
Information for a folder request..
|
| FoldersResponse |
FoldersResponse.
|
| ForgottenPasswordInformation |
A complex element that has up to four Question/Answer pairs for forgotten password information..
|
| FormDataItem |
FormDataItem.
|
| FormulaTab |
The value of a formula tab is calculated from the values of other number or date tabs in the
document.
|
| FullName |
A tab that displays the recipient's full name.
|
| GraphicsContext |
GraphicsContext.
|
| Group |
This object contains information about a group..
|
| GroupBrands |
.
|
| GroupInformation |
GroupInformation.
|
| IdCheckConfiguration |
A complex object specifying ID check configuration..
|
| IdCheckInformationInput |
A complex element that contains input information related to a recipient ID check.
|
| IdCheckSecurityStep |
IdCheckSecurityStep.
|
| IdEvidenceResourceToken |
IdEvidenceResourceToken.
|
| IdEvidenceViewLink |
IdEvidenceViewLink.
|
| InitialHere |
A tab that allows the recipient to initial the document.
|
| InlineTemplate |
InlineTemplate.
|
| InPersonSigner |
Contains information about an in-person recipient.
|
| IntegratedConnectUserInfoList |
IntegratedConnectUserInfoList.
|
| IntegratedUserInfoList |
IntegratedUserInfoList.
|
| Intermediary |
Contains information about an intermediary recipient.
|
| Jurisdiction |
Describes the jurisdiction of a notary.
|
| LastName |
A tab that displays the recipient's last name.
|
| LinkedExternalPrimaryAccount |
LinkedExternalPrimaryAccount.
|
| List |
List
|
| ListCustomField |
This object represents a list custom field from which envelope creators and senders can select
custom data..
|
| ListItem |
One of the selectable items in the `listItems` property of a
[`list`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) tab..
|
| LocalePolicy |
LocalePolicy.
|
| LocalePolicyTab |
LocalePolicyTab.
|
| LockInformation |
LockInformation.
|
| LockRequest |
This request object contains information about the lock that you want to create or update..
|
| LoginAccount |
LoginAccount.
|
| LoginInformation |
LoginInformation.
|
| MatchBox |
MatchBox.
|
| MemberGroupSharedItem |
Information about items shared among groups..
|
| MemberSharedItems |
Information about shared items..
|
| MergeField |
Contains information for transfering values between Salesforce data fields and DocuSign Tabs..
|
| MobileNotifierConfiguration |
MobileNotifierConfiguration.
|
| MobileNotifierConfigurationInformation |
MobileNotifierConfigurationInformation.
|
| ModelList |
This tab offers a list of options to choose from.
|
| Money |
Describes information about the `total` of a payment.
|
| NameValue |
A name-value pair that describes an item and provides a value for the item..
|
| NewAccountDefinition |
NewAccountDefinition.
|
| NewAccountSummary |
NewAccountSummary.
|
| NewUser |
Object representing a new user..
|
| NewUsersDefinition |
NewUsersDefinition.
|
| NewUsersSummary |
Object representing a summary of data for new users..
|
| Notarize |
A tab that alerts notary recipients that they must take action on the page.
|
| Notary |
Notary.
|
| NotaryCertificate |
NotaryCertificate
|
| NotaryHost |
This object is used only when `inPersonSigningType` in the `inPersonSigner`
object is `notary`.
|
| NotaryJournal |
NotaryJournal.
|
| NotaryJournalCredibleWitness |
NotaryJournalCredibleWitness.
|
| NotaryJournalList |
NotaryJournalList.
|
| NotaryJournalMetaData |
NotaryJournalMetaData.
|
| NotaryJurisdiction |
A notary jurisdiction..
|
| NotaryJurisdictionList |
A paged list of jurisdictions..
|
| NotaryRecipient |
NotaryRecipient.
|
| NotaryResult |
Describes a single notary jurisdiction..
|
| NotarySeal |
A Notary Seal tab enables the recipient to notarize a document.
|
| Note |
A tab that displays additional information, in the form of a note, for the recipient.
|
| Notification |
A complex element that specifies the notification options for the envelope.
|
| NotificationDefaults |
NotificationDefaults.
|
| NotificationDefaultSettings |
Contains details about the default notification settings for the envelope notifications that
senders and signers receive..
|
| Number |
A tab that allows the recipient to enter numbers and decimal (.) points.
|
| OauthAccess |
OauthAccess.
|
| OcrRequest |
OcrRequest
|
| OfflineAttributes |
Reserved for DocuSign use..
|
| Page |
Description of a page of a document..
|
| PageImages |
PageImages.
|
| PageRequest |
PageRequest.
|
| PageSize |
PageSize
|
| Participant |
Participant.
|
| PathExtendedElement |
PathExtendedElement.
|
| PaymentDetails |
When a formula tab has a `paymentDetails` property, the formula tab is a payment item.
|
| PaymentGatewayAccount |
This object contains details about a payment gateway account..
|
| PaymentGatewayAccountSetting |
PaymentGatewayAccountSetting.
|
| PaymentGatewayAccountsInfo |
Holds information about connected payment accounts..
|
| PaymentLineItem |
A line item describes details about an individual line item in a payment request.
|
| PaymentMethodWithOptions |
This object contains information about a payment method that the gateway accepts and the payment
options that are compatible with it..
|
| PaymentProcessorInformation |
PaymentProcessorInformation.
|
| PaymentSignerValues |
PaymentSignerValues.
|
| PayPalLegacySettings |
PayPalLegacySettings.
|
| PermissionProfile |
This object defines the account permissions for a profile that you can apply to a group of
users..
|
| PermissionProfileInformation |
Contains details about the permission profiles associated with an account..
|
| PhoneNumber |
A Phone Number tab enables a recipient to enter a phone number.
|
| PlanInformation |
An object used to identify the features and attributes of the account being created..
|
| PolyLine |
PolyLine.
|
| PolyLineOverlay |
This tab enables users to strike through the text of a document.
|
| PostTransactionsRequest |
PostTransactionsRequest
|
| PostTransactionsResponse |
PostTransactionsResponse
|
| PowerForm |
Contains details about a PowerForm..
|
| PowerFormFormDataEnvelope |
PowerFormFormDataEnvelope.
|
| PowerFormFormDataRecipient |
PowerFormFormDataRecipient.
|
| PowerFormRecipient |
**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`..
|
| PowerFormSendersResponse |
This object includes information about the users who have sent PowerForms..
|
| PowerFormsFormDataResponse |
PowerFormsFormDataResponse.
|
| PowerFormsRequest |
PowerFormsRequest.
|
| PowerFormsResponse |
A list of PowerForms..
|
| PrefillFormData |
PrefillFormData.
|
| PrefillTabs |
Prefill tabs are tabs that the sender can fill in before the envelope is sent.
|
| ProofServiceResourceToken |
ProofServiceResourceToken.
|
| ProofServiceViewLink |
ProofServiceViewLink.
|
| PropertyMetadata |
Metadata about a property..
|
| Province |
Province.
|
| ProvisioningInformation |
ProvisioningInformation.
|
| PurchasedEnvelopesInformation |
PurchasedEnvelopesInformation.
|
| Radio |
One of the selectable radio buttons in the `radios` property of a
[`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab.
|
| RadioGroup |
This group tab is used to place radio buttons on a document.
|
| RecipientAdditionalNotification |
Describes an additional notification method..
|
| RecipientAttachment |
RecipientAttachment.
|
| RecipientDomain |
RecipientDomain.
|
| RecipientEmail |
RecipientEmail
|
| RecipientEmailNotification |
RecipientEmailNotification.
|
| RecipientEvent |
RecipientEvent.
|
| RecipientFormData |
RecipientFormData.
|
| RecipientGroup |
Describes a group of recipients..
|
| RecipientIdentityInputOption |
RecipientIdentityInputOption.
|
| RecipientIdentityPhoneNumber |
RecipientIdentityPhoneNumber.
|
| RecipientIdentityVerification |
Specifies ID Verification applied on an envelope by workflow ID.
|
| RecipientNamesResponse |
This response object contains a list of recipients..
|
| RecipientOption |
Describes a recipient who is a member of a conditional group..
|
| RecipientPhoneAuthentication |
A complex type that Contains the elements: * recipMayProvideNumber - Boolean.
|
| RecipientPhoneNumber |
Describes the recipient phone number..
|
| RecipientPreviewRequest |
This request object contains the information necessary to create a recipient preview..
|
| RecipientProofFile |
The proof file of the recipient.
|
| RecipientRouting |
Describes the recipient routing rules..
|
| RecipientRules |
RecipientRules.
|
| Recipients |
Specifies the envelope recipients..
|
| RecipientSAMLAuthentication |
Contains the name/value pair information for the SAML assertion attributes: * name - The name of
the SAML assertion attribute.
|
| RecipientSignatureInformation |
Allows the sender to pre-specify the signature name, signature initials and signature font used
in the signature stamp for the recipient.
|
| RecipientSignatureProvider |
An Electronic or Standards Based Signature (digital signature) provider for the signer to use.
|
| RecipientSignatureProviderOptions |
Option settings for the signature provider.
|
| RecipientSMSAuthentication |
Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can
use for SMS text authentication..
|
| RecipientsUpdateSummary |
This is the response that the API returns after you update recipients..
|
| RecipientTokenClientURLs |
RecipientTokenClientURLs.
|
| RecipientUpdateResponse |
The recipient details that are returned after you update the recipient..
|
| RecipientViewRequest |
The request body for the [EnvelopeViews:
createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/) and
[EnvelopeViews:
createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/)
methods..
|
| ReferralInformation |
A complex type that contains the following information for entering referral and discount
information.
|
| Reminders |
A complex element that specifies reminder settings for the envelope.
|
| ReportInProductCsvRunRequest |
ReportInProductCsvRunRequest.
|
| ReportInProductField |
ReportInProductField.
|
| ReportInProductGet |
ReportInProductGet.
|
| ReportInProductList |
ReportInProductList.
|
| ReportInProductListItem |
ReportInProductListItem.
|
| ReportInProductRunRequest |
ReportInProductRunRequest.
|
| ReportInProductRunResponse |
ReportInProductRunResponse.
|
| ReportInProductRunResponseRow |
ReportInProductRunResponseRow.
|
| ReportInProductRunResponseRowFields |
ReportInProductRunResponseRowFields.
|
| ReportInProductSaveResponse |
ReportInProductSaveResponse.
|
| ReportInProductSentByDetails |
ReportInProductSentByDetails.
|
| ReservedDomainExistence |
ReservedDomainExistence.
|
| ResourceInformation |
ResourceInformation.
|
| ReturnUrlRequest |
The request body for the [EnvelopeViews:
createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) method..
|
| Revision |
Revision
|
| SamlAssertionAttribute |
SamlAssertionAttribute
|
| ScheduledSending |
ScheduledSending.
|
| ScheduledSendingApiModel |
ScheduledSendingApiModel.
|
| Seal |
Seal
|
| SealIdentifier |
SealIdentifier.
|
| SealSign |
Specifies one or more electronic seals to apply on documents.
|
| SeatDiscount |
This object contains information about a seat discount..
|
| Sender |
Sender
|
| SenderCompany |
SenderCompany.
|
| SenderEmailNotifications |
Contains the settings for the email notifications that senders receive about the envelopes that
they send..
|
| SenderName |
SenderName.
|
| ServerTemplate |
ServerTemplate.
|
| ServiceInformation |
ServiceInformation.
|
| ServiceVersion |
ServiceVersion.
|
| SettingsMetadata |
Metadata that indicates whether a property is editable and describes setting-specific options..
|
| SharedItem |
Information about the shared item..
|
| SignatureDataInfo |
SignatureDataInfo
|
| SignatureGroup |
SignatureGroup.
|
| SignatureGroupDef |
SignatureGroupDef.
|
| SignatureProperties |
SignatureProperties
|
| SignatureProviderRequiredOption |
Contains additional information that a specific signature provider requires..
|
| SignatureType |
This object contains information about the type of signature..
|
| SignatureUser |
SignatureUser.
|
| SignatureUserDef |
SignatureUserDef.
|
| Signer |
A complex type containing information about a signer recipient.
|
| SignerAttachment |
A tab that allows the recipient to attach supporting documents to an envelope.
|
| SignerEmailNotifications |
An array of email notifications that specifies the email the user receives when they are a
sender.
|
| SignHashDocument |
SignHashDocument
|
| SignHashSessionInfoResponse |
SignHashSessionInfoResponse
|
| SignHere |
A tab that allows the recipient to sign a document.
|
| SigningGroup |
Contains details about a signing group.
|
| SigningGroupInformation |
SigningGroupInformation.
|
| SigningGroupUser |
SigningGroupUser.
|
| SigningGroupUsers |
SigningGroupUsers.
|
| SignSessionInfoRequest |
SignSessionInfoRequest
|
| SmartContractInformation |
SmartContractInformation.
|
| SmartSection |
SmartSection.
|
| SmartSectionAnchorPosition |
SmartSectionAnchorPosition.
|
| SmartSectionCollapsibleDisplaySettings |
SmartSectionCollapsibleDisplaySettings.
|
| SmartSectionDisplaySettings |
These properties define how a Smart Section displays.
|
| SocialAccountInformation |
SocialAccountInformation.
|
| SocialAuthentication |
SocialAuthentication.
|
| Ssn |
A one-line field that allows the recipient to enter a Social Security Number.
|
| Ssn4InformationInput |
Ssn4InformationInput.
|
| Ssn9InformationInput |
Ssn9InformationInput.
|
| Stamp |
Stamp.
|
| SupportedLanguages |
A list of supported languages..
|
| TabAccountSettings |
TabAccountSettings.
|
| TabGroup |
TabGroup.
|
| TabMetadata |
TabMetadata.
|
| TabMetadataList |
TabMetadataList.
|
| Tabs |
Tabs indicate to recipients where they should sign, initial, or enter data on a document.
|
| TemplateCustomFields |
TemplateCustomFields.
|
| TemplateDocumentsResult |
TemplateDocumentsResult.
|
| TemplateDocumentVisibilityList |
A list of `documentVisibility` objects that specify whether the documents associated
with a template are visible to recipients..
|
| TemplateInformation |
TemplateInformation.
|
| TemplateMatch |
TemplateMatch.
|
| TemplateNotificationRequest |
TemplateNotificationRequest.
|
| TemplateRecipients |
TemplateRecipients.
|
| TemplateRole |
Information about a specific role..
|
| TemplateSharedItem |
Information about shared templates..
|
| TemplateSummary |
Summary of a template request..
|
| TemplateTabs |
TemplateTabs.
|
| TemplateUpdateSummary |
TemplateUpdateSummary.
|
| Text |
A tab that allows the recipient to enter any type of text.
|
| TextCustomField |
This object represents a free text custom field where envelope creators and senders can enter
custom data..
|
| TimeStampField |
TimeStampField
|
| Title |
A tab that displays the recipient's title.
|
| TspHealthCheckRequest |
TspHealthCheckRequest
|
| TspHealthCheckStatusDescription |
TspHealthCheckStatusDescription
|
| UpdateTransactionRequest |
UpdateTransactionRequest
|
| UpdateTransactionResponse |
UpdateTransactionResponse
|
| UsageHistory |
A complex element consisting of: * lastSentDateTime - the date and time the user last sent an
envelope.
|
| User |
User
|
| UserAccountManagementGranularInformation |
Describes which account management capabilities a user has..
|
| UserInfo |
UserInfo.
|
| UserInfoList |
UserInfoList.
|
| UserInfoResponse |
UserInfoResponse
|
| UserInformation |
User information..
|
| UserInformationList |
Contains a list of account users..
|
| UserPasswordInformation |
UserPasswordInformation.
|
| UserPasswordRules |
Contains details about the password rules for a user..
|
| UserProfile |
UserProfile.
|
| UserSettingsInformation |
Properties that configure the settings for a user.
|
| UserSharedItem |
Information about a shared item..
|
| UserSignature |
UserSignature.
|
| UserSignatureDefinition |
UserSignatureDefinition.
|
| UserSignaturesInformation |
UserSignaturesInformation.
|
| UserSocialIdResult |
UserSocialIdResult.
|
| UsersResponse |
UsersResponse.
|
| View |
This tab is used with the Approve tab to handle supplemental documents..
|
| ViewLinkRequest |
ViewLinkRequest
|
| ViewUrl |
ViewUrl.
|
| Watermark |
Watermark.
|
| Witness |
A complex type containing information about a witness recipient.
|
| Workflow |
Describes the workflow for an envelope..
|
| WorkflowStep |
Describes a single step in a workflow..
|
| Workspace |
Provides properties that describe a workspace..
|
| WorkspaceFolderContents |
Provides properties that describe the contents of a workspace folder..
|
| WorkspaceItem |
A workspaceItem (file type only) representing the file.
|
| WorkspaceItemList |
Provides properties that describe the items contained in a workspace..
|
| WorkspaceList |
Provides properties that describe the workspaces avaialble..
|
| WorkspaceSettings |
This object provides information about the settings for the workspace..
|
| WorkspaceUser |
A workspaceUser representing the user.
|
| WorkspaceUserAuthorization |
Provides properties that describe user authorization to a workspace..
|
| Zip |
A tab that allows the recipient to enter a ZIP code.
|