Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Identity Verifications

Retrieves the Identity Verification workflows available to an account

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

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.

Related topics

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Query Parameters

identity_verification_workflow_status?string

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 Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/identity_verification"
{  "identityVerification": [    {      "defaultDescription": "string",      "defaultName": "string",      "displayOrder": "string",      "inputOptions": [        {          "isRequired": true,          "optionName": "string",          "valueType": "string"        }      ],      "isDisabled": "string",      "ownerType": "string",      "signatureProvider": {        "isRequired": "string",        "priority": "string",        "signatureProviderDisplayName": "string",        "signatureProviderId": "string",        "signatureProviderName": "string",        "signatureProviderOptionsMetadata": [          {            "signatureProviderOptionDisplayName": "string",            "signatureProviderOptionHintOverrideValue": "string",            "signatureProviderOptionId": "string",            "signatureProviderOptionName": "string",            "signatureProviderOptionRegexValidationPattern": "string"          }        ],        "signatureProviderRequiredOptions": [          {            "requiredSignatureProviderOptionIds": [              "string"            ],            "signerType": "string"          }        ]      },      "workflowId": "string",      "workflowLabel": "string",      "workflowResourceKey": "string"    }  ]}

Gets notary jurisdictions for a user GET

Gets notary jurisdictions for a user.

Retrieves the HTML definition used to generate a dynamically sized responsive document GET

Retrieves the HTML definition used to generate a dynamically sized responsive document. If the document was not created as a signable HTML document, this endpoint will return a 200-OK response and an empty JSON body. **Note:** The `documentId` query parameter is a GUID value, not an integer document ID. If an invalid document ID is provided, this endpoint will return a 200-OK response and an empty JSON body. ### Related topics - [Responsive signing](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/responsive/)