Skip to main content
POST
Submit a redaction job

Authorizations

Authorization
string
header
required

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

Body

application/json
matterId
string<uuid>
required

Matter identifier the redaction job belongs to. You must have read access to the matter.

fileId
string<uuid>
required

Source file to redact (must already exist under the matter)

rules
object[]

Custom-string rules. Default rules derived from the matter (account-number base, spaced, and hyphenated variants, plus SSN hyphenated and digits-only forms) are merged in when omitted; explicit rules append to those defaults.

labeling
object

Optional exhibit labeling. Omit (or send {mode: none, ranges: []}) for no labels. Overlapping ranges or none with non-empty ranges return 400.

configuration
object

Optional per-job redaction settings (OCR). Omitted means text-only redaction with no OCR.

Response

Redaction job accepted

id
string<uuid>
required

Identifier of the created redaction job

status
enum<string>
required

Current status of an asynchronous redaction job

Available options:
pending,
processing,
completed,
failed
pollUrl
string
required

Path to the detail endpoint for status polling