Request

HTTP request

GET /v2/accounts/{accountId}/signatureProviders

Parameters

Parameter name Value Description
Path parameters
accountId string

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

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Accounts::listSignatureProviders

Definitions Expand All | Collapse All

AccountSignatureProviders

Account SBS Signature Providers

signatureProviders
[accountSignatureProvider]

accountSignatureProvider

isRequired string
priority string
signatureProviderDisplayName string
signatureProviderId string
signatureProviderName string

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

signatureProviderOptionDisplayName string
signatureProviderOptionId string
signatureProviderOptionName string

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

signatureProviderRequiredOption

requiredSignatureProviderOptionIds
[string]
signerType string

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>