Returns a list of signature providers that the specified account can use.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Responses

CodeDescriptionReference
200

Successful response.

AccountSignatureProviders
400

Error encountered.

errorDetails

SDK Method

Accounts::listSignatureProviders

Definitions

accountSignatureProvider

Contains information abotu the signature provider associated with the Identity Verification workflow. If empty, then this specific workflow is not intended for signers.

isRequiredstring

Reserved for DocuSign.

prioritystring

Reserved for DocuSign.

signatureProviderDisplayNamestring

Reserved for DocuSign.

signatureProviderIdstring

Reserved for DocuSign.

signatureProviderNamestring

The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see the current provider list. You can also retrieve the list by using the AccountSignatureProviders::List method.

Example: universalsignaturepen_default

signatureProviderOptionsMetadata[accountSignatureProviderOption]

Reserved for DocuSign.

signatureProviderRequiredOptions[signatureProviderRequiredOption]

Reserved for DocuSign.

accountSignatureProviderOption

Reserved for DocuSign.

signatureProviderOptionDisplayNamestring

Reserved for DocuSign.

signatureProviderOptionIdstring

Reserved for DocuSign.

signatureProviderOptionNamestring

Reserved for DocuSign.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

signatureProviderRequiredOption

Contains additional information that a specific signature provider requires.

requiredSignatureProviderOptionIds[array]

Reserved for DocuSign.

signerTypestring

Reserved for DocuSign.

AccountSignatureProviders

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

signatureProviders[accountSignatureProvider]

Names of electronic or digital signature providers that can be used.

Examples

Generic JSON Response

Response
{
  "signatureProviders": [
    {
      "signatureProviderId": "sample string 1",
      "signatureProviderName": "sample string 2",
      "signatureProviderDisplayName": "sample string 3",
      "priority": "sample string 4",
      "isRequired": "sample string 5",
      "signatureProviderOptionsMetadata": [
        {
          "signatureProviderOptionId": "sample string 1",
          "signatureProviderOptionName": "sample string 2",
          "signatureProviderOptionDisplayName": "sample string 3"
        }
      ],
      "signatureProviderRequiredOptions": [
        {
          "signerType": "sample string 1",
          "requiredSignatureProviderOptionIds": [
            "sample string 1"
          ]
        }
      ]
    }
  ]
}
Generic XML Response

Response
<accountSignatureProviders xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <signatureProviders>
    <accountSignatureProvider>
      <isRequired>sample string 5</isRequired>
      <priority>sample string 4</priority>
      <signatureProviderDisplayName>sample string 3</signatureProviderDisplayName>
      <signatureProviderId>sample string 1</signatureProviderId>
      <signatureProviderName>sample string 2</signatureProviderName>
      <signatureProviderOptionsMetadata>
        <accountSignatureProviderOption>
          <signatureProviderOptionDisplayName>sample string 3</signatureProviderOptionDisplayName>
          <signatureProviderOptionId>sample string 1</signatureProviderOptionId>
          <signatureProviderOptionName>sample string 2</signatureProviderOptionName>
        </accountSignatureProviderOption>
      </signatureProviderOptionsMetadata>
      <signatureProviderRequiredOptions>
        <signatureProviderRequiredOption>
          <requiredSignatureProviderOptionIds>
            <string>sample string 1</string>
          </requiredSignatureProviderOptionIds>
          <signerType>sample string 1</signerType>
        </signatureProviderRequiredOption>
      </signatureProviderRequiredOptions>
    </accountSignatureProvider>
  </signatureProviders>
</accountSignatureProviders> 
}} />