Retrieves signature information for a signer or 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.

Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.

For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the CanSendEnvelope property set to true and the ExpressSendOnly property in SendingUser structure must be set to false.

Remove one or more templates from the account favorites.

Your request should include each template to remove as a separate favoriteTemplatesContentItem JSON object, like this:

{
    "favoriteTemplates": [
        {
            "templateId": "6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1"
        },
        {
            "templateId": "8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f"
        }
    ]
}

The response includes the IDs of the templates that were successfully removed from your favorites. To get the account’s remaining favorite templates, use the getFavoriteTemplates endpoint.

Retrieves the list of favorite templates for the account.

Set one or more templates as account favorites.

Your request should include each template as a separate favoriteTemplatesContentItem JSON object, like this:

{
    "favoriteTemplates": [
        {
            "templateId": "6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1"
        },
        {
            "templateId": "8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f"
        }
    ]
}

Returns a list of the account’s folders.

Use the include query parameter to specify the kinds of folders to return.

By default, only the first level of subfolders is shown.
Set the sub_folder_depth query parameter to -1 to return the entire folder hierarchy.

Related topics

• Searching for envelopes
• Sharing templates

Gets information about items in the specified folder.

To include a list of the items in the folder, set the include_items query parameter to true.

Related topics

• Searching for envelopes
• Sharing templates

Moves a set of envelopes from their current folder to another folder.

The folderId path parameter is the destination folder.
The request body has an array of envelope IDs and the
ID of the source folder.

If folderId is the special value recyclebin
the envelopes are moved to the Deleted folder.
Moving an in-process envelope
(envelope status of sent or delivered)
to the recyclebin
voids the envelope.

Related topics

• Searching for envelopes
• Sharing templates

Retrieves a list of items 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.

This method deletes one or more brands from a group.

This method returns information about the brands associated with a group.

This method adds one or more existing brands to a group based on the groupId.

Deletes one or more users from a group. This request takes a userInfoList that contains the users that you want to delete.

Retrieves a list of users in a group.

Adds one or more existing DocuSign users to an existing group.

Deletes an existing user group.

When you delete a group, you include only the groupId in the request body.

Example:

{
  "groups": [
    {
      "groupId": "12345"
    }
}

Gets information about groups associated with the account.

Related topics

• How to set a permission profile

Creates one or more groups for the account.

Groups help you manage users.
For example, you can use groups
to limit user access to templates.

You can associate a group with a
permission profile,
which sets the user permissions for users in that group
without having to set the userSettings property for each user.
You are not required to set permission profiles for a group,
but it makes it easier to manage user permissions
for a large number of users.

Example request:

{
  "groups": [
    { "groupName": "montagues" },
    { "groupName": "capulets" },
    { "groupName": "nobles",
       "permissionProfileId": 1597 }
  ]
}

Use AccountPermissionProfiles: list
to get a list of permission profiles and their IDs.
It is an error if the permissionProfileId does not exist.

Related topics

• How-To Set Up a Permission Profile

Updates the group name and modifies, or sets, the permission profile for the group.

Related topics

• How-To Set Up a Permission Profile

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

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

Retrieves the specified invoice.

Note: If the pdfAvailable property in the response is set to true, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the Accept property in the header to Accept: application/pdf.

Privileges required: account administrator

The response returns a list of charges and information about the charges. Quantities are usually shown as ‘unlimited’ or an integer. Amounts are shown in the currency set for the account.

Response
The following table provides a description of the different chargeName property values. The information will grow as more chargeable items are added to the system.

Returns a list past due invoices for the account and notes if payment can be made through the REST API.

Privileges Required: account administrator

Gets settings for a notary user.
The current user must be a notary.

Registers the current user as a notary.

Updates notary information for the current user.

Returns a list of jurisdictions that the notary is registered in.
The current user must be a notary.

Creates a jurisdiction object.

Deletes the specified jurisdiction.

Gets a jurisdiction object for the current user. The following restrictions apply:

• The current user must be a notary.
• The jurisdictionId must be a jurisdiction that the notary is registered for.

Updates the jurisdiction information about a notary.

The following restrictions apply:

• The current user must be a notary.
• The jurisdictionId path parameter must be a jurisdiction that the notary is registered for.
• The jurisdictionId path parameter must match the request body’s jurisdiction.jurisdictionId.

The request body must have a full jurisdiction object for the jurisdiction property.
The best way to do this is to use getNotaryJurisdiction to obtain the current values and update the properties you want to change.

For example, assume getNotaryJurisdiction returns this:

{
    "jurisdiction": {
        "jurisdictionId": "15",
        "name": "Iowa",
        "county": "",
        "enabled": "true",
        "countyInSeal": "false",
        "commissionIdInSeal": "true",
        "stateNameInSeal": "true",
        "notaryPublicInSeal": "true",
        "allowSystemCreatedSeal": "true",
        "allowUserUploadedSeal": "false"
    },
    "commissionId": "123456",
    "commissionExpiration": "2020-08-31T07:00:00.0000000Z",
    "registeredName": "Bob Notary",
    "county": "Adams",
    "sealType": "system_created"
}

If you want to change the name of the notary from “Bob Notary” to “Robert Notary”, your request body would be:

{
    "jurisdiction": {
        "jurisdictionId": "15",
        "name": "Iowa",
        "county": "",
        "enabled": "true",
        "countyInSeal": "false",
        "commissionIdInSeal": "true",
        "stateNameInSeal": "true",
        "notaryPublicInSeal": "true",
        "allowSystemCreatedSeal": "true",
        "allowUserUploadedSeal": "false"
    },
    "commissionId": "123456",
    "commissionExpiration": "2020-08-31T07:00:00.0000000Z",
    "registeredName": "Robert Notary",
    "county": "Adams",
    "sealType": "system_created"
}

This method returns a list of payment gateway accounts and basic information about them.

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

Posts a payment to a past due invoice.

This method can only be used if the paymentAllowed value for a past due invoice is true. This can be determined calling Billing::listInvoicesPastDue.

The response returns information for a single payment
if a payment ID was used in the endpoint, or a list of payments.
If the from date or to date queries or payment ID are not used,
the response returns payment information for the last 365 days.

If the request was for a single payment ID, the nextUri and previousUri properties are not returned.

Privileges required: account administrator

Retrieves the information for a specified payment.

Privileges required: account administrator

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.

This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the powerFormId.

This method returns a list of PowerForms that are available to the user.

This method creates a new PowerForm.

You create a PowerForm from an existing DocuSign template, based on the templateId in the request body.

PowerForms that you create from a template are referred to as web PowerForms.

Note: The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a PDF PowerForm). However, PDF PowerForms are deprecated and are not supported in the API.

Note: A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm initiator.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.

Signing modes

You can use one of the following signing modes for a PowerForm:

email

This mode verifies the recipient’s identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks Begin Signing to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.

Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the activateonly flag to the PowerForm URL and set it to true by passing in the value 1. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code.

Example: activateonly=1

direct

This mode does not require any verification. After a recipient enters their email address on the landing page and clicks Begin Signing, a new browser tab opens and the recipient can immediately begin the signing process.

Because the direct signing mode does not verify the recipient’s identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient’s identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check).

Note: In the account settings, enablePowerFormDirect must be true to use direct as the signingMode.

Redirect URLs

You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see How do I specify a URL to redirect to when a PowerForm is completed?.

More information

For more information about creating PowerForms, see Create a PowerForm.

This method returns a list of users who have sent PowerForms.

This method deletes a PowerForm.

This method returns detailed information about a specific PowerForm.

This method updates an existing PowerForm.

Deletes the request 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.

Retrieves information for a single log entry.

Request
The requestLogId property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.

Response
If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.

Retrieves the current API request logging setting for the user and remaining log entries.

Response
The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.

Enables or disables API request logging for troubleshooting.

When enabled (apiRequestLogging is true),
REST API requests and responses for the user are added to a log.
A log can have up to 50 requests/responses
and the current number of log entries can be determined
by getting the settings.
Logging is automatically disabled when the log limit of 50 is reached.

You can call
Diagnostics: getRequestLog
or
Diagnostics: listRequestLogs
to download the log files (individually or as a zip file).
Call Diagnostics: deleteRequestLogs
to clear the log by deleting current entries.

Private information, such as passwords and integration key information,
which is normally located in the call header is omitted from the request/response log.

API request logging only captures requests from the authenticated user.
Any call that does not authenticate the user and resolve a userId is not logged.