{"api":"esign_rest","category":"reference"}

Accounts Category

Use the Account category for various account management tasks including:

Programmatically creating and deleting accounts.
Getting information about an account and its capabilities.
Branding the account with custom colors, message text, and more.
Account charges.

The Accounts category also includes end points for listing the recipient names associated with an email address that was used by the account. For example, a single email address is often shared by multiple members of a family.

AccountBrands

The AccountBrands resource enables you to use account-level brands to customize the styles and text that recipients see.

Method	Description
list	`GET /v2.1/accounts/{accountId}/brands` Gets a list of brands.
create	`POST /v2.1/accounts/{accountId}/brands` Creates one or more brand profiles for an account.
deleteList	`DELETE /v2.1/accounts/{accountId}/brands` Deletes one or more brand profiles.
get	`GET /v2.1/accounts/{accountId}/brands/{brandId}` Gets information about a brand.
update	`PUT /v2.1/accounts/{accountId}/brands/{brandId}` Updates an existing brand.
delete	`DELETE /v2.1/accounts/{accountId}/brands/{brandId}` Deletes a brand.
getExportFile	`GET /v2.1/accounts/{accountId}/brands/{brandId}/file` Exports a brand.
getLogo	`GET /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}` Gets a brand logo.
updateLogo	`PUT /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}` Updates a brand logo.
deleteLogo	`DELETE /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}` Deletes a brand logo.
listResources	`GET /v2.1/accounts/{accountId}/brands/{brandId}/resources` Returns metadata about the branding resources for an account.
getResource	`GET /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}` Returns a branding resource file.
updateResource	`PUT /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}` Updates a branding resource file.

AccountConsumerDisclosures

Details about account consumer disclosures.

Method Description

Method	Description
getDefault	`GET /v2.1/accounts/{accountId}/consumer_disclosure` Gets the default Electronic Record and Signature Disclosure for an account.
get	`GET /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}` Gets the Electronic Record and Signature Disclosure for an account.
update	`PUT /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}` Updates the Electronic Record and Signature Disclosure for an account.

getDefault

GET /v2.1/accounts/{accountId}/consumer_disclosure

Gets the default Electronic Record and Signature Disclosure for an account.

get

GET /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}

Gets the Electronic Record and Signature Disclosure for an account.

update

PUT /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}

Updates the Electronic Record and Signature Disclosure for an account.

AccountCustomFields

An accountCustomField is an envelope custom field that you set at the account level. Applying custom fields enables account administators to group and manage envelopes.

Method	Description
list	`GET /v2.1/accounts/{accountId}/custom_fields` Gets a list of custom fields.
create	`POST /v2.1/accounts/{accountId}/custom_fields` Creates an account custom field.
update	`PUT /v2.1/accounts/{accountId}/custom_fields/{customFieldId}` Updates an account custom field.
delete	`DELETE /v2.1/accounts/{accountId}/custom_fields/{customFieldId}` Deletes an account custom field.

AccountSealProviders

Method	Description
list	`GET /v2.1/accounts/{accountId}/seals`

Accounts

Account management

Method	Description
create	`POST /v2.1/accounts` Creates new accounts.
get	`GET /v2.1/accounts/{accountId}` Retrieves the account information for the specified account.
delete	`DELETE /v2.1/accounts/{accountId}` Deletes the specified account.
getBillingCharges	`GET /v2.1/accounts/{accountId}/billing_charges` Gets list of recurring and usage charges for the account.
deleteCaptiveRecipient	`DELETE /v2.1/accounts/{accountId}/captive_recipients/{recipientPart}` Deletes the signature for one or more captive recipient records.
listRecipientNamesByEmail	`GET /v2.1/accounts/{accountId}/recipient_names` Gets the recipient names associated with an email address.
listSettings	`GET /v2.1/accounts/{accountId}/settings` Gets account settings information.
updateSettings	`PUT /v2.1/accounts/{accountId}/settings` Updates the account settings for an account.
getEnvelopePurgeConfiguration	`GET /v2.1/accounts/{accountId}/settings/envelope_purge_configuration` Gets the envelope purge configuration for an account.
updateEnvelopePurgeConfiguration	`PUT /v2.1/accounts/{accountId}/settings/envelope_purge_configuration` Sets the envelope purge configuration for an account.
getNotificationDefaults	`GET /v2.1/accounts/{accountId}/settings/notification_defaults` Gets envelope notification defaults.
updateNotificationDefaults	`PUT /v2.1/accounts/{accountId}/settings/notification_defaults` Updates envelope notification default settings.
listSharedAccess	`GET /v2.1/accounts/{accountId}/shared_access` Reserved: Gets the shared item status for one or more users.
updateSharedAccess	`PUT /v2.1/accounts/{accountId}/shared_access` Reserved: Sets the shared access information for users.
listSupportedLanguages	`GET /v2.1/accounts/{accountId}/supported_languages` Gets the supported languages for envelope recipients.
listUnsupportedFileTypes	`GET /v2.1/accounts/{accountId}/unsupported_file_types` Gets a list of unsupported file types.
getProvisioning	`GET /v2.1/accounts/provisioning` Retrieves the account provisioning information for the account.

AccountSignatureProviders

This resource provides information on the Standards Based Signature providers that have been provisioned for an account.

Method	Description
list	`GET /v2.1/accounts/{accountId}/signatureProviders` Gets the available signature providers for an account.

AccountPermissionProfiles

The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users.

Method	Description
list	`GET /v2.1/accounts/{accountId}/permission_profiles` Gets a list of permission profiles.
create	`POST /v2.1/accounts/{accountId}/permission_profiles` Creates a new permission profile for an account.
get	`GET /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}` Returns a permission profile for an account.
update	`PUT /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}` Updates a permission profile.
delete	`DELETE /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}` Deletes a permission profile from an account.

AccountTabSettings

Tab settings determine the tab types and tab functionality that are enabled for an account.

Method Description

Method	Description
get	`GET /v2.1/accounts/{accountId}/settings/tabs` Returns tab settings list for specified account
update	`PUT /v2.1/accounts/{accountId}/settings/tabs` Modifies tab settings for specified account

get

GET /v2.1/accounts/{accountId}/settings/tabs

Returns tab settings list for specified account

update

PUT /v2.1/accounts/{accountId}/settings/tabs

Modifies tab settings for specified account

ENoteConfigurations

Method Description

Method	Description
get	`GET /v2.1/accounts/{accountId}/settings/enote_configuration` Returns the configuration information for the eNote eOriginal integration.
update	`PUT /v2.1/accounts/{accountId}/settings/enote_configuration` Updates configuration information for the eNote eOriginal integration.
delete	`DELETE /v2.1/accounts/{accountId}/settings/enote_configuration` Deletes configuration information for the eNote eOriginal integration.

get

GET /v2.1/accounts/{accountId}/settings/enote_configuration

Returns the configuration information for the eNote eOriginal integration.

update

PUT /v2.1/accounts/{accountId}/settings/enote_configuration

Updates configuration information for the eNote eOriginal integration.

delete

DELETE /v2.1/accounts/{accountId}/settings/enote_configuration

Deletes configuration information for the eNote eOriginal integration.

AccountPasswordRules

Contains details about the password rules for an account.

Method Description

Method	Description
get	`GET /v2.1/accounts/{accountId}/settings/password_rules` Gets the password rules for an account.
update	`PUT /v2.1/accounts/{accountId}/settings/password_rules` Updates the password rules for an account.
getForUser	`GET /v2.1/current_user/password_rules` Gets membership account password rules.

get

GET /v2.1/accounts/{accountId}/settings/password_rules

Gets the password rules for an account.

update

PUT /v2.1/accounts/{accountId}/settings/password_rules

Updates the password rules for an account.

getForUser

GET /v2.1/current_user/password_rules

Gets membership account password rules.

AccountWatermarks

Method Description

Method	Description
get	`GET /v2.1/accounts/{accountId}/watermark` Get watermark information.
update	`PUT /v2.1/accounts/{accountId}/watermark` Update watermark information.
preview	`PUT /v2.1/accounts/{accountId}/watermark/preview` Get watermark preview.

get

GET /v2.1/accounts/{accountId}/watermark

Get watermark information.

update

PUT /v2.1/accounts/{accountId}/watermark

Update watermark information.

preview

PUT /v2.1/accounts/{accountId}/watermark/preview

Get watermark preview.

IdentityVerifications

Identity Verification enables you to verify a signer's identity before they can access a document. The IdentityVerifications resource provides a method that enables you to list the workflows that are available to an account.

Method	Description
list	`GET /v2.1/accounts/{accountId}/identity_verification` Retrieves the Identity Verification workflows available to an account.

NotificationDefaults

The NotificationDefaults resource provides methods that enable you to manage the default notifications for envelopes.

Method	Description

FavoriteTemplates

Method Description

Method	Description
getFavoriteTemplates	`GET /v2.1/accounts/{accountId}/favorite_templates`
updateFavoriteTemplate	`PUT /v2.1/accounts/{accountId}/favorite_templates`
unFavoriteTemplate	`DELETE /v2.1/accounts/{accountId}/favorite_templates`

getFavoriteTemplates

GET /v2.1/accounts/{accountId}/favorite_templates

updateFavoriteTemplate

PUT /v2.1/accounts/{accountId}/favorite_templates

unFavoriteTemplate

DELETE /v2.1/accounts/{accountId}/favorite_templates

}} />