Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.identity_verification_workflow_statusstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieves the Identity Verification workflows available to an account — response body

Referenced models: Retrieves the Identity Verification workflows available to an account — response body

Retrieves the Identity Verification workflows available to an account — response body
FieldTypePresenceDescription and constraints
$objectRoot
identityVerificationarrayOptionalSpecifies 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[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootSpecifies an Identity Verification workflow.
defaultDescriptionstringOptionalText describing the purpose of the Identity Verification workflow.
defaultNamestringOptionalThe name of the Identity Verification workflow.
displayOrderstringOptionalThe position on the page where the display section appears.
Format: int32
inputOptionsarrayOptional
inputOptions[]ModelEach itemExpand Gets account settings information — response body — identity Verification item input Options item
isDisabledstringOptionalWhen **true,** the workflow is disabled.
ownerTypestringOptional
signatureProviderModelOptionalExpand Gets the available signature providers for an account — response body — signature Providers item
The signature provider associated with the Identity Verification workflow.
workflowIdstringOptionalWorkflow 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)
workflowLabelstringOptional
workflowResourceKeystringOptionalReserved 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
FieldTypePresenceDescription and constraints
$objectRoot
isRequiredbooleanOptional
optionNamestringOptional
valueTypestringOptional
Gets the available signature providers for an account — response body — signature Providers item
FieldTypePresenceDescription and constraints
$objectRootContains information about the signature provider associated with the Identity Verification workflow.
If empty, then this specific workflow is not intended for signers.
isRequiredstringOptionalReserved for Docusign.
prioritystringOptionalReserved for Docusign.
signatureProviderDisplayNamestringOptionalReserved for Docusign.
signatureProviderIdstringOptionalReserved for Docusign.
signatureProviderNamestringOptionalThe 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`

signatureProviderOptionsMetadataarrayOptionalReserved for Docusign.
signatureProviderOptionsMetadata[]ModelEach itemExpand Gets the available signature providers for an account — response body — signature Providers item signature Provider Options Metadata item
signatureProviderRequiredOptionsarrayOptionalReserved for Docusign.
signatureProviderRequiredOptions[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootReserved for Docusign.
signatureProviderOptionDisplayNamestringOptionalReserved for Docusign.
signatureProviderOptionHintOverrideValuestringOptional
signatureProviderOptionIdstringOptionalReserved for Docusign.
signatureProviderOptionNamestringOptionalReserved for Docusign.
signatureProviderOptionRegexValidationPatternstringOptional
Gets the available signature providers for an account — response body — signature Providers item signature Provider Required Options item
FieldTypePresenceDescription and constraints
$objectRootContains additional information that a specific signature provider requires.
requiredSignatureProviderOptionIdsarrayOptionalReserved for Docusign.
requiredSignatureProviderOptionIds[]stringEach item
signerTypestringOptionalReserved for Docusign.

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.