Skip to main content
GET
Get a redaction job

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Path Parameters

redactionId
string<uuid>
required

Response

Redaction job detail

id
string<uuid>
required
owner
string
required

Creditor that owns this redaction job

matterId
string<uuid>
required

Matter identifier.

fileId
string<uuid>
required

Source file UUID

status
enum<string>
required

Current status of an asynchronous redaction job

Available options:
pending,
processing,
completed,
failed
createdOn
string<date-time>
required
createdBy
string
required
rules
object[]
labeling
object

Exhibit labeling configuration for a redaction job. mode is the labeling style applied across every range; per-range mode is not supported. When mode is none, ranges must be empty. Otherwise ranges must contain at least one non-overlapping range.

completedOn
string<date-time> | null
redactionDuration
string | null

Total redaction processing time, formatted as a Go duration string (e.g. 350ms, 5s, 1h30s). Populated once the job is completed.

errorMessage
string | null

Failure reason when status=failed. Populated when processing fails; null in every other status.

crid
string | null

Creditor reference ID (file number) of the source file; null if the source file was deleted. Read-only; list responses only.

fileName
string | null

Source file's filename. Read-only; list responses only.

fileDescription
string | null

Source file's description (e.g. "Affidavit of Indebtedness"). Read-only; list responses only.

summary
object | null

Per-rule redaction counts and OCR signals. Null until the job completes.