Comments

Gets a PDF transcript of all of the comments in an envelope

GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript

Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.

The response body of this method is the PDF file as a byte stream.

Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the accountSettingsInformation object, set the enableSigningExtensionComments property to true).

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.

envelopeId*string

The envelope's GUID.

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

Query Parameters

encoding?string

(Optional) The encoding to use for the file.

Response Body

application/pdf

application/pdf

curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/comments/transcript"
null