Retrieves the list of identity verification workflows available to an account

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 ID Verification workflow

defaultNamestring

Name of the ID Verification workflow

signatureProvideraccountSignatureProvider

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

workflowResourceKeystring

Key for translated resources

accountSignatureProvider

Signature provider associated with the identity verification workflow. If empty, then this specific workflow is not intended for signers

signatureProviderNamestring

The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. The current provider list.

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

IdentityVerifications

Identity verification workflows 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> 
}} />