DocuSign: Gets the available signature providers for an account
DocuSign esignature.esignatureAccountSignatureProvidersGetSignatureProviders: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_accountsignatureproviders_getsignatureproviders
Provider route: GET /restapi/v2.1/accounts/{accountId}/signatureProviders. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureAccountSignatureProvidersGetSignatureProviders"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureAccountSignatureProvidersGetSignatureProviders(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_account_signature_providers_get_signature_providers(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Gets the available signature providers for an account — response body |
Referenced models: Gets the available signature providers for an account — response body
Schemas
Section titled “Schemas”Gets the available signature providers for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
signatureProviders | array | Optional | Names of electronic or digital signature providers that can be used. |
signatureProviders[] | Model | Each item | Expand Gets the available signature providers for an account — response body — signature Providers item |
Referenced models: Gets the available signature providers for an account — response body — signature Providers item
Gets the available signature providers for an account — response body — signature Providers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the signature provider associated with the Identity Verification workflow. If empty, then this specific workflow is not intended for signers. |
isRequired | string | Optional | Reserved for Docusign. |
priority | string | Optional | Reserved for Docusign. |
signatureProviderDisplayName | string | Optional | Reserved for Docusign. |
signatureProviderId | string | Optional | Reserved for Docusign. |
signatureProviderName | string | Optional | The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). You can also retrieve the list by using the [AccountSignatureProviders: List](/docs/esign-rest-api/reference/accounts/accountsignatureproviders/list/) method. Example: `universalsignaturepen_default` |
signatureProviderOptionsMetadata | array | Optional | Reserved for Docusign. |
signatureProviderOptionsMetadata[] | Model | Each item | Expand Gets the available signature providers for an account — response body — signature Providers item signature Provider Options Metadata item |
signatureProviderRequiredOptions | array | Optional | Reserved for Docusign. |
signatureProviderRequiredOptions[] | Model | Each item | Expand Gets the available signature providers for an account — response body — signature Providers item signature Provider Required Options item |
Referenced models: Gets the available signature providers for an account — response body — signature Providers item signature Provider Options Metadata item, Gets the available signature providers for an account — response body — signature Providers item signature Provider Required Options item
Gets the available signature providers for an account — response body — signature Providers item signature Provider Options Metadata item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reserved for Docusign. |
signatureProviderOptionDisplayName | string | Optional | Reserved for Docusign. |
signatureProviderOptionHintOverrideValue | string | Optional | |
signatureProviderOptionId | string | Optional | Reserved for Docusign. |
signatureProviderOptionName | string | Optional | Reserved for Docusign. |
signatureProviderOptionRegexValidationPattern | string | Optional |
Gets the available signature providers for an account — response body — signature Providers item signature Provider Required Options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains additional information that a specific signature provider requires. |
requiredSignatureProviderOptionIds | array | Optional | Reserved for Docusign. |
requiredSignatureProviderOptionIds[] | string | Each item | |
signerType | string | Optional | Reserved for Docusign. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_accountsignatureproviders_getsignatureproviders. Catalog operation: esignature:AccountSignatureProviders_GetSignatureProviders. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.