How to implement real-time auto-redaction within PrizmDoc Viewer without immediately burning the redactions into the document. This approach allows users to preview redactions before finalizing them.


  1. Backend Redaction Creation:

    • A frontend button triggers a call to the backend.
    • The backend then utilizes the PrizmDoc Server /v2/redactionCreators endpoint.
    • This endpoint initiates a redaction creator process on the server, searching the document for text matching specified regex and generating a JSON markup document containing redaction information.
    • The /v2/redactionCreators/{processId} endpoint returns a workFileId referencing this newly created redaction JSON markup document.

  2. Retrieving Redaction Markup:

    • The backend uses the returned workFileId to call the /PCCIS/V1/WorkFile/$workFileId endpoint.
    • This retrieves the content of the redaction JSON markup document.

  3. Applying Redactions in the Viewer:

    • The backend sends the JSON markup data to the frontend.
    • The ViewerControl API can be used to add the desired marks to apply the redactions as marks in the currently active markup layer within the PrizmDoc Viewer. Preview the results and burn the redactions if they are correct.


To get the state and results of an in-progress or completed redaction creator process use the

 GET /v2/redactionCreators/{processId} URL.