Skip to navigation

DocumentPreview Resource

View as Markdown

DocumentPreview resource

Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact Docusign Sales.

Methods supported

MethodDescription
GetDocumentPreviewGET /v2/{accountId}/documentPreviews/{id}
Gets the document preview.
GetDocumentPreviewPageImageStatusGET /v2/{accountId}/documentPreviews/{id}/pageImageStatuses
Gets the document preview page image statuses.
GetDocumentPreviewPagesGET /v2/{accountId}/documentPreviews/{id}/pages
Gets the document preview pages.

DocumentPreview properties

PropertyTypeDescription
DocumentDocumentGets or sets the document.
HrefstringUri where the object can be retrieved.
IsPreviewAvailablebooleanGets or sets a value indicating whether this instance is preview available.
PageImagesAvailabilityarrayGets or sets the page images availability.
PagesarrayGets or sets the pages.
PreviewReasonstringGets or sets the preview reason.