PHphilterd
Redaction Ledger

Verify a document's ledger chain.

Changed on

Returns whether the hash chain for the document's ledger verifies (no entry has been altered and every link is intact). A chain that cannot be validated returns valid false with a validationError. Requires the ledger:read scope.

get/api/ledger/{documentId}/valid

Request

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

Path parameters

documentIdstring required

Query parameters

ownerstring

Headers

Authorizationstring required

Response

OK

documentIdstring
hashChainValidboolean
signaturesValidboolean
signedEntriesinteger
totalinteger

How many entries the whole chain has, across every page. Left out with entries.

unsignedEntriesinteger
validboolean
validationErrorstring

Why the chain could not be validated. Present only then, with valid false and the hash, signature, and entry-count fields left out.

Changes

  • a80ec02d6633Revision changes
    • info

      added the optional property to the response with the status

  • c4f85daa9208Revision changes
    • 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

    • 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