Submit a redaction job
Create a new redaction job with status pending and start the asynchronous redaction process.
curl --request POST \
--url https://api.slate.inc/files/v1/redactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rules": [
{
"match": {
"type": "literal",
"value": "<string>"
},
"transform": {
"type": "mask"
}
}
],
"configuration": {}
}
'import requests
url = "https://api.slate.inc/files/v1/redactions"
payload = {
"matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rules": [
{
"match": {
"type": "literal",
"value": "<string>"
},
"transform": { "type": "mask" }
}
],
"configuration": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
matterId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
rules: [{match: {type: 'literal', value: '<string>'}, transform: {type: 'mask'}}],
configuration: {}
})
};
fetch('https://api.slate.inc/files/v1/redactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.slate.inc/files/v1/redactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'matterId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'fileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'rules' => [
[
'match' => [
'type' => 'literal',
'value' => '<string>'
],
'transform' => [
'type' => 'mask'
]
]
],
'configuration' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.slate.inc/files/v1/redactions"
payload := strings.NewReader("{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rules\": [\n {\n \"match\": {\n \"type\": \"literal\",\n \"value\": \"<string>\"\n },\n \"transform\": {\n \"type\": \"mask\"\n }\n }\n ],\n \"configuration\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.slate.inc/files/v1/redactions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rules\": [\n {\n \"match\": {\n \"type\": \"literal\",\n \"value\": \"<string>\"\n },\n \"transform\": {\n \"type\": \"mask\"\n }\n }\n ],\n \"configuration\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.slate.inc/files/v1/redactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rules\": [\n {\n \"match\": {\n \"type\": \"literal\",\n \"value\": \"<string>\"\n },\n \"transform\": {\n \"type\": \"mask\"\n }\n }\n ],\n \"configuration\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"pollUrl": "<string>"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}Authorizations
Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.
Body
Matter identifier the redaction job belongs to. You must have read access to the matter.
Source file to redact (must already exist under the matter)
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.
Show child attributes
Show child attributes
Optional exhibit labeling. Omit (or send {mode: none, ranges: []}) for no labels. Overlapping ranges or none with non-empty ranges return 400.
Show child attributes
Show child attributes
Optional per-job redaction settings (OCR). Omitted means text-only redaction with no OCR.
Show child attributes
Show child attributes
curl --request POST \
--url https://api.slate.inc/files/v1/redactions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rules": [
{
"match": {
"type": "literal",
"value": "<string>"
},
"transform": {
"type": "mask"
}
}
],
"configuration": {}
}
'import requests
url = "https://api.slate.inc/files/v1/redactions"
payload = {
"matterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rules": [
{
"match": {
"type": "literal",
"value": "<string>"
},
"transform": { "type": "mask" }
}
],
"configuration": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
matterId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
rules: [{match: {type: 'literal', value: '<string>'}, transform: {type: 'mask'}}],
configuration: {}
})
};
fetch('https://api.slate.inc/files/v1/redactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.slate.inc/files/v1/redactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'matterId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'fileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'rules' => [
[
'match' => [
'type' => 'literal',
'value' => '<string>'
],
'transform' => [
'type' => 'mask'
]
]
],
'configuration' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.slate.inc/files/v1/redactions"
payload := strings.NewReader("{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rules\": [\n {\n \"match\": {\n \"type\": \"literal\",\n \"value\": \"<string>\"\n },\n \"transform\": {\n \"type\": \"mask\"\n }\n }\n ],\n \"configuration\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.slate.inc/files/v1/redactions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rules\": [\n {\n \"match\": {\n \"type\": \"literal\",\n \"value\": \"<string>\"\n },\n \"transform\": {\n \"type\": \"mask\"\n }\n }\n ],\n \"configuration\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.slate.inc/files/v1/redactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"matterId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rules\": [\n {\n \"match\": {\n \"type\": \"literal\",\n \"value\": \"<string>\"\n },\n \"transform\": {\n \"type\": \"mask\"\n }\n }\n ],\n \"configuration\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"pollUrl": "<string>"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}