Create a redaction
Create a redaction for a customer. Personally identifiable fields on the customer and copied PII on invoices, applications, tenancies, payment methods and verification records are wiped asynchronously. IDs, amounts, dates, and relations are retained. The customer cannot be updated or deleted once redaction has started. Creating the same redaction again returns the existing object, or retries it if the previous attempt failed. Session users must be account admins.
curl --request POST \
--url https://api.yorlet.com/v1/redactions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"customer": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/redactions"
payload = { "customer": "<string>" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({customer: '<string>'})
};
fetch('https://api.yorlet.com/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.yorlet.com/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([
'customer' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.yorlet.com/v1/redactions"
payload := strings.NewReader("{\n \"customer\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.yorlet.com/v1/redactions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/redactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "redaction",
"customer": "<string>",
"error": "<string>",
"redacted_at": 123,
"redacted_objects": [
{
"id": "<string>",
"object": "<string>"
}
],
"status": "processing",
"account": "<string>",
"deleted": false
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The ID of the customer to redact.
Response
Returns the created redaction.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
redaction The ID of the customer this redaction applies to.
A human-readable error message when status is failed.
Time at which the redaction completed. Measured in seconds since the Unix epoch.
Objects whose personally identifiable information was wiped, such as customer, invoice, application, tenancy, payment_method, verification_session, and verification_report.
Show child attributes
Show child attributes
The status of the redaction. processing while PII is being wiped, redacted when complete, and failed when the job could not finish.
processing, redacted, failed The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Was this page helpful?
curl --request POST \
--url https://api.yorlet.com/v1/redactions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"customer": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/redactions"
payload = { "customer": "<string>" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({customer: '<string>'})
};
fetch('https://api.yorlet.com/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.yorlet.com/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([
'customer' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.yorlet.com/v1/redactions"
payload := strings.NewReader("{\n \"customer\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.yorlet.com/v1/redactions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/redactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "redaction",
"customer": "<string>",
"error": "<string>",
"redacted_at": 123,
"redacted_objects": [
{
"id": "<string>",
"object": "<string>"
}
],
"status": "processing",
"account": "<string>",
"deleted": false
}