Redaction Result Check
Poll this endpoint to check status of a Redaction request. The redacted PDF is returned when available, together with the verification verdict and failed checks.
Authorizations
Path Parameters
Response
Successful Response
Result of a redaction request.
An available PDF is returned even when verification checks fail. Inspect
verdict and failing_checks to determine whether it needs review.
withheld indicates that no PDF is available.
The status of the request. Should be 'complete' when the request is done.
Signed URL for downloading the completed result JSON when direct result download is required.
Number of seconds until result_url expires.
True only when every blocking check passed and the redacted document is returned.
Why verification failed or no PDF is available.
'PASS' when every blocking check passed, otherwise 'FAIL'.
True when no redacted PDF is available. A failed verification alone does not withhold it.
Base64-encoded PDF when available, including outputs that failed verification. Inspect verdict before using it.
Number of distinct removed targets. Removed text is never included in the report.
Number of targets that could not be located. Target text is not included.
Identifiers of failed blocking checks; document-derived details are omitted.
Number of redaction boxes applied.
0-indexed pages that were rewritten. Other pages are unchanged.
Rewritten pages that got no searchable text layer back, because their script cannot be encoded in it.
Processing time in seconds.
Number of pages processed.
A dictionary of the cost breakdown of this request.
A dictionary of the versions of the libraries used in the request.