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 Account 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 mulitple members of a family.

AccountBrands

Brand management for accounts

Method Description
create POST /v2/accounts/{accountId}/brands

Creates one or more brand profile files for the account.

delete DELETE /v2/accounts/{accountId}/brands/{brandId}

Removes a brand.

deleteList DELETE /v2/accounts/{accountId}/brands

Deletes one or more brand profiles.

deleteLogo DELETE /v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}

Delete one branding logo.

get GET /v2/accounts/{accountId}/brands/{brandId}

Get information for a specific brand.

getExportFile GET /v2/accounts/{accountId}/brands/{brandId}/file

Export a specific brand.

getLogo GET /v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}

Obtains the specified image for a brand.

getResource GET /v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}

Returns the specified branding resource file.

list GET /v2/accounts/{accountId}/brands

Gets a list of brand profiles.

listResources GET /v2/accounts/{accountId}/brands/{brandId}/resources

Returns the specified account's list of branding resources (metadata).

update PUT /v2/accounts/{accountId}/brands/{brandId}

Updates an existing brand.

updateLogo PUT /v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}

Put one branding logo.

updateResource PUT /v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}

Uploads a branding resource file.

AccountConsumerDisclosures

Account consumer disclosures

Method Description
get GET /v2/accounts/{accountId}/consumer_disclosure/{langCode}

Gets the Electronic Record and Signature Disclosure.

getDefault GET /v2/accounts/{accountId}/consumer_disclosure

Gets the Electronic Record and Signature Disclosure for the account.

update PUT /v2/accounts/{accountId}/consumer_disclosure/{langCode}

Update Consumer Disclosure.

AccountCustomFields

Custom Fields

Method Description
create POST /v2/accounts/{accountId}/custom_fields

Creates an acount custom field.

delete DELETE /v2/accounts/{accountId}/custom_fields/{customFieldId}

Delete an existing account custom field.

list GET /v2/accounts/{accountId}/custom_fields

Gets a list of custom fields associated with the account.

update PUT /v2/accounts/{accountId}/custom_fields/{customFieldId}

Updates an existing account custom field.

AccountPasswordRules

Method Description
get GET /v2/accounts/{accountId}/settings/password_rules

Get the password rules

getForUser GET /v2/current_user/password_rules

Get membership account password rules

update PUT /v2/accounts/{accountId}/settings/password_rules

Update the password rules

AccountPermissionProfiles

Method Description
create POST /v2/accounts/{accountId}/permission_profiles

Creates a new permission profile in the specified account.

delete DELETE /v2/accounts/{accountId}/permission_profiles/{permissionProfileId}

Deletes a permissions profile within the specified account.

get GET /v2/accounts/{accountId}/permission_profiles/{permissionProfileId}

Returns a permissions profile in the specified account.

list GET /v2/accounts/{accountId}/permission_profiles

Gets a list of permission profiles.

update PUT /v2/accounts/{accountId}/permission_profiles/{permissionProfileId}

Updates a permission profile within the specified account.

AccountSignatureProviders

Account SBS Signature Providers

Method Description
list GET /v2/accounts/{accountId}/signatureProviders

Returns Account available signature providers for specified account.

AccountTabSettings

Method Description
get GET /v2/accounts/{accountId}/settings/tabs

Returns tab settings list for specified account

update PUT /v2/accounts/{accountId}/settings/tabs

Modifies tab settings for specified account

AccountWatermarks

Method Description
get GET /v2/accounts/{accountId}/watermark

Get watermark information.

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

Get watermark preview.

update PUT /v2/accounts/{accountId}/watermark

Update watermark information.

Accounts

Account management

Method Description
create POST /v2/accounts

Creates new accounts.

delete DELETE /v2/accounts/{accountId}

Deletes the specified account.

deleteCaptiveRecipient DELETE /v2/accounts/{accountId}/captive_recipients/{recipientPart}

Deletes the signature for one or more captive recipient records.

get GET /v2/accounts/{accountId}

Retrieves the account information for the specified account.

getBillingCharges GET /v2/accounts/{accountId}/billing_charges

Gets list of recurring and usage charges for the account.

getProvisioning GET /v2/accounts/provisioning

Retrieves the account provisioning information for the account.

listRecipientNamesByEmail GET /v2/accounts/{accountId}/recipient_names

Gets recipient names associated with an email address.

listSettings GET /v2/accounts/{accountId}/settings

Gets account settings information.

listSharedAccess GET /v2/accounts/{accountId}/shared_access

Reserved: Gets the shared item status for one or more users.

listSupportedLanguages GET /v2/accounts/{accountId}/supported_languages

List supported languages for the recipient language setting

listUnsupportedFileTypes GET /v2/accounts/{accountId}/unsupported_file_types

Gets a list of unsupported file types.

updateSettings PUT /v2/accounts/{accountId}/settings

Updates the account settings for an account.

updateSharedAccess PUT /v2/accounts/{accountId}/shared_access

Reserved: Sets the shared access information for users.

EMortgageTransactions

Method Description
create POST /v2/accounts/{accountId}/eMortgage/transactions

Starts a new eMortgage Transaction

ENoteConfigurations

Method Description
delete DELETE /v2/accounts/{accountId}/settings/enote_configuration

Deletes configuration information for the eNote eOriginal integration.

get GET /v2/accounts/{accountId}/settings/enote_configuration

Returns the configuration information for the eNote eOriginal integration.

update PUT /v2/accounts/{accountId}/settings/enote_configuration

Updates configuration information for the eNote eOriginal integration.