Documents

Fetch Document Properties

This endpoint allows you to fetch properties of a document including its title, information about password-protection, SHA256 hash of the content, and the storage mechanism used for the underlying PDF file. All of them are set by Document Engine when a document is uploaded.

get/api/documents/{documentId}/properties

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/properties
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

documentIdstring required

The document ID

Response

Document Engine returned the document properties.

Example response

{
  "data": {
    "passwordProtected": true,
    "sourcePdfSha256": "1defd934dbbf77587eb9b7f45d162d2a3aea16c840a9e7cfa190fb2ea1f40a76",
    "title": "Nutrient Document Engine API Specification",
    "byteSize": 192000,
    "createdAt": "2019-09-16T15:05:03.712909Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.