This method returns a list of Identity Verification workflows that are available to an account.

Note: To use this method, you must either be an account administrator or a sender.

Request

HTTP request

GET /v2.1/accounts/{accountId}/identity_verification

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
200

Successful response.

IdentityVerifications
400

Error encountered.

errorDetails

SDK Method

Accounts::getAccountIdentityVerification

Definitions

accountIdentityVerificationWorkflow

Specifies an Identity Verification workflow.

defaultDescriptionstring

Text describing the purpose of the Identity Verification workflow.

defaultNamestring

The name of the Identity Verification workflow.

signatureProvideraccountSignatureProvider

The signature provider associated with the Identity Verification workflow.

workflowIdstring

Workflow unique ID
This is the ID you must specify when setting ID Verification in an envelope using the identityVerification core recipient parameter

workflowResourceKeystring

Reserved for DocuSign.

accountSignatureProvider

Contains information abotu the signature provider associated with the Identity Verification workflow. If empty, then this specific workflow is not intended for signers.

isRequiredstring

Reserved for DocuSign.

prioritystring

Reserved for DocuSign.

signatureProviderDisplayNamestring

Reserved for DocuSign.

signatureProviderIdstring

Reserved for DocuSign.

signatureProviderNamestring

The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see the current provider list. You can also retrieve the list by using the AccountSignatureProviders::List method.

Example: universalsignaturepen_default

signatureProviderOptionsMetadata[accountSignatureProviderOption]

Reserved for DocuSign.

signatureProviderRequiredOptions[signatureProviderRequiredOption]

Reserved for DocuSign.

accountSignatureProviderOption

Reserved for DocuSign.

signatureProviderOptionDisplayNamestring

Reserved for DocuSign.

signatureProviderOptionIdstring

Reserved for DocuSign.

signatureProviderOptionNamestring

Reserved for DocuSign.

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

signatureProviderRequiredOption

Contains additional information that a specific signature provider requires.

requiredSignatureProviderOptionIds[array]

Reserved for DocuSign.

signerTypestring

Reserved for DocuSign.

IdentityVerifications

Identity Verification enables you to verify a signer's identity before they can access a document. The IdentityVerifications resource provides a method that enables you to list the workflows that are available to an account.

identityVerification[accountIdentityVerificationWorkflow]

Examples

Generic JSON Response

Response
{
  "identityVerification": [
    {
      "workflowId": "sample string 1",
      "defaultName": "sample string 2",
      "steps": [
        {
          "name": "sample string 1",
          "type": "sample string 2"
        }
      ]
    }
  ]
}
Generic XML Response

Response
<accountIdentityVerificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <identityVerification>
    <accountIdentityVerificationWorkflow>
      <defaultName>sample string 2</defaultName>
      <steps>
        <accountIdentityVerificationStep>
          <name>sample string 1</name>
          <type>sample string 2</type>
        </accountIdentityVerificationStep>
      </steps>
      <workflowId>sample string 1</workflowId>
    </accountIdentityVerificationWorkflow>
  </identityVerification>
</accountIdentityVerificationResponse> 
}} />