DocuSign: Retrieves the Identity Verification workflows available to an account
DocuSign esignature.esignatureAccountIdentityVerificationGetAccountIdentityVerification: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_accountidentityverification_getaccountidentityverification
Provider route: GET /restapi/v2.1/accounts/{accountId}/identity_verification. 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"]["esignatureAccountIdentityVerificationGetAccountIdentityVerification"]>[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.esignatureAccountIdentityVerificationGetAccountIdentityVerification(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_identity_verification_get_account_identity_verification(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 | |
query | object | Optional | Additional keys: not allowed |
query.identity_verification_workflow_status | string | Optional |
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 Retrieves the Identity Verification workflows available to an account — response body |
Referenced models: Retrieves the Identity Verification workflows available to an account — response body
Schemas
Section titled “Schemas”Retrieves the Identity Verification workflows available to an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
identityVerification | array | Optional | Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). |
identityVerification[] | Model | Each item | Expand Gets account settings information — response body — identity Verification item |
Referenced models: Gets account settings information — response body — identity Verification item
Gets account settings information — response body — identity Verification item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies an Identity Verification workflow. |
defaultDescription | string | Optional | Text describing the purpose of the Identity Verification workflow. |
defaultName | string | Optional | The name of the Identity Verification workflow. |
displayOrder | string | Optional | The position on the page where the display section appears. Format: int32 |
inputOptions | array | Optional | |
inputOptions[] | Model | Each item | Expand Gets account settings information — response body — identity Verification item input Options item |
isDisabled | string | Optional | When **true,** the workflow is disabled. |
ownerType | string | Optional | |
signatureProvider | Model | Optional | Expand Gets the available signature providers for an account — response body — signature Providers item The signature provider associated with the Identity Verification workflow. |
workflowId | string | Optional | Workflow unique ID</br>This is the ID you must specify when setting ID Verification in an envelope using the `identityVerification` [core recipient parameter](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#core-recipient-parameters) |
workflowLabel | string | Optional | |
workflowResourceKey | string | Optional | Reserved for Docusign. |
Referenced models: Gets account settings information — response body — identity Verification item input Options item, Gets the available signature providers for an account — response body — signature Providers item
Gets account settings information — response body — identity Verification item input Options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
isRequired | boolean | Optional | |
optionName | string | Optional | |
valueType | string | Optional |
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_accountidentityverification_getaccountidentityverification. Catalog operation: esignature:AccountIdentityVerification_GetAccountIdentityVerification. 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.