Skip to main content
GET
Redaction Result Check

Authorizations

X-API-Key
string
header
required

Path Parameters

request_id
string
required

Cookies

wos-session
string
datalab_active_team
string

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.

status
string
required

The status of the request. Should be 'complete' when the request is done.

result_url
string | null

Signed URL for downloading the completed result JSON when direct result download is required.

expires_in
integer | null

Number of seconds until result_url expires.

success
boolean | null

True only when every blocking check passed and the redacted document is returned.

error
string | null

Why verification failed or no PDF is available.

verdict
string | null

'PASS' when every blocking check passed, otherwise 'FAIL'.

withheld
boolean | null

True when no redacted PDF is available. A failed verification alone does not withhold it.

output_base64
string | null

Base64-encoded PDF when available, including outputs that failed verification. Inspect verdict before using it.

targets_removed_count
integer | null

Number of distinct removed targets. Removed text is never included in the report.

targets_not_found_count
integer | null

Number of targets that could not be located. Target text is not included.

failing_checks
Failing Checks · object[] | null

Identifiers of failed blocking checks; document-derived details are omitted.

boxes_applied
integer | null

Number of redaction boxes applied.

pages_rewritten
integer[] | null

0-indexed pages that were rewritten. Other pages are unchanged.

text_layer_skipped
integer[] | null

Rewritten pages that got no searchable text layer back, because their script cannot be encoded in it.

runtime
number | null

Processing time in seconds.

page_count
integer | null

Number of pages processed.

cost_breakdown
Cost Breakdown · object | null

A dictionary of the cost breakdown of this request.

versions

A dictionary of the versions of the libraries used in the request.