Request

HTTP request

GET /v2/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

accountIdentityVerificationStep

namestring

typestring

Type of the user. Valid values: type_owner, type_participant.

accountIdentityVerificationWorkflow

defaultNamestring

steps[accountIdentityVerificationStep]

workflowIdstring

errorDetails

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

errorCodestring

An error code associated with the error.

messagestring

A short error message.

IdentityVerifications

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> 
}} />