Get identity verification workflows

GET

/v2.1/accounts/:accountId/identity_verification

GET

/restapi/v2.1/accounts/:accountId/identity_verification

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/identity_verification \
     -H "Authorization: Bearer <apiKey>"

{
  "identityVerification": [
    {
      "defaultDescription": "sample string 1",
      "defaultName": "sample string 2",
      "displayOrder": "sample string 3",
      "inputOptions": [
        {
          "isRequired": true,
          "optionName": "sample string 1",
          "valueType": "sample string 2"
        }
      ],
      "isDisabled": "sample string 4",
      "ownerType": "sample string 5",
      "signatureProvider": {
        "isRequired": "sample string 1",
        "priority": "sample string 2",
        "signatureProviderDisplayName": "sample string 3",
        "signatureProviderId": "sample string 4",
        "signatureProviderName": "sample string 5",
        "signatureProviderOptionsMetadata": [
          {
            "signatureProviderOptionDisplayName": "sample string 1",
            "signatureProviderOptionHintOverrideValue": "sample string 2",
            "signatureProviderOptionId": "sample string 3",
            "signatureProviderOptionName": "sample string 4",
            "signatureProviderOptionRegexValidationPattern": "sample string 5"
          }
        ],
        "signatureProviderRequiredOptions": [
          {
            "requiredSignatureProviderOptionIds": [
              "sample string 1"
            ],
            "signerType": "sample string 1"
          }
        ]
      },
      "steps": [
        {
          "name": "sample string 1",
          "type": "sample string 2"
        }
      ],
      "workflowId": "sample string 6",
      "workflowLabel": "sample string 7",
      "workflowResourceKey": "sample string 8"
    }
  ]
}

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.

How to require ID Verification (IDV) for a recipient

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

Query parameters

identity_verification_workflow_statusstringOptional

Filters the workflows returned according to status. Valid values:

active: Only active workflows are returned. This is the default.
deactivated: Only deactivated workflows are returned.
all: All workflows are returned.

Response

Successful response.

identityVerificationlist of objectsOptional

Specifies the ID Verification workflow applied on an envelope by workflow ID. See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other recipient authentication methods. 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).

Errors

400

Bad Request Error

Related topics

Authentication

Path parameters

Query parameters

Response

Errors