Request

HTTP request

GET /v2/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

isRequiredstring

prioritystring

signatureProviderDisplayNamestring

signatureProviderIdstring

signatureProviderNamestring

The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. The current provider list.

signatureProviderOptionsMetadata[accountSignatureProviderOption]

signatureProviderRequiredOptions[signatureProviderRequiredOption]

accountSignatureProviderOption

signatureProviderOptionDisplayNamestring

signatureProviderOptionIdstring

signatureProviderOptionNamestring

errorDetails

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

errorCodestring

An error code associated with the error.

messagestring

A short error message.

signatureProviderRequiredOption

requiredSignatureProviderOptionIds[array]

signerTypestring

AccountSignatureProviders

Account SBS Signature Providers

signatureProviders[accountSignatureProvider]

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> 
}} />