Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Envelope Document Html Definitions

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

GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions

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

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.

documentId*string

The GUID of the document.

Example: c671747c-xxxx-xxxx-xxxx-4a4a48e23744

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/documents/string/html_definitions"
{  "htmlDefinitions": [    {      "documentId": "string",      "documentIdGuid": "string",      "htmlDefinition": {        "displayAnchorPrefix": "string",        "displayAnchors": [          {            "caseSensitive": true,            "displaySettings": {              "cellStyle": "string",              "collapsibleSettings": {                "arrowClosed": "string",                "arrowColor": "string",                "arrowLocation": "string",                "arrowOpen": "string",                "arrowSize": "string",                "arrowStyle": "string",                "containerStyle": "string",                "labelStyle": "string",                "onlyArrowIsClickable": true,                "outerLabelAndArrowStyle": "string"              },              "display": "string",              "displayLabel": "string",              "displayOrder": 0,              "displayPageNumber": 0,              "hideLabelWhenOpened": true,              "inlineOuterStyle": "string",              "labelWhenOpened": "string",              "preLabel": "string",              "scrollToTopWhenOpened": true,              "tableStyle": "string"            },            "endAnchor": "string",            "removeEndAnchor": true,            "removeStartAnchor": true,            "startAnchor": "string"          }        ],        "displayOrder": "string",        "displayPageNumber": "string",        "documentGuid": "string",        "documentId": "string",        "headerLabel": "string",        "maxScreenWidth": "string",        "removeEmptyTags": "string",        "showMobileOptimizedToggle": "string",        "source": "string"      }    }  ]}

Retrieves the Identity Verification workflows available to an account GET

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 - [How to require ID Verification (IDV) for a recipient](https://developers.docusign.com/docs/esign-rest-api/how-to/id-verification/)

Creates a preview of the responsive version of a document POST

Creates a preview of the [responsive](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.