PHphilterd
Redaction Ledger

Export a document's ledger chain.

Changed on

Returns the full ledger chain for a document as a portable JSON document that can be archived and later re-verified. The export contains the decrypted token and replacement values, so treat it as sensitive. A chain with an entry that cannot be read is not exported, even in part. Requires the ledger:export scope.

get/api/ledger/{documentId}/export

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/ledger/{documentId}/export
  • Auth
    HTTP bearer

Path parameters

documentIdstring required

Query parameters

ownerstring

Headers

Authorizationstring required

Response

OK

versioninteger
countinteger
documentIdstring
signingKeysobject

Changes

  • c4f85daa9208Revision changes
    • breaking

      the response's body type changed from string to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 7e2a081486e0Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status