Execute an account erasure
curl --request POST \
--url https://api.royalti.io/godmin/account-erasure/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userId": "3d5c9971-451e-4711-8874-ff498d55e601",
"confirmEmail": "subject@example.com",
"plan": {
"subjectUserId": "3d5c9971-451e-4711-8874-ff498d55e601",
"subjectTenantUserIds": [],
"subjectEmailHash": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"dispositions": [],
"conflicts": [],
"retained": [],
"scrubbed": [],
"externalSurfaces": {
"redisKeyPatterns": [],
"gcsPaths": [],
"apiKeyIds": []
},
"externalDeliveries": []
},
"verificationMethod": "email_ownership"
}
'import requests
url = "https://api.royalti.io/godmin/account-erasure/execute"
payload = {
"userId": "3d5c9971-451e-4711-8874-ff498d55e601",
"confirmEmail": "subject@example.com",
"plan": {
"subjectUserId": "3d5c9971-451e-4711-8874-ff498d55e601",
"subjectTenantUserIds": [],
"subjectEmailHash": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"dispositions": [],
"conflicts": [],
"retained": [],
"scrubbed": [],
"externalSurfaces": {
"redisKeyPatterns": [],
"gcsPaths": [],
"apiKeyIds": []
},
"externalDeliveries": []
},
"verificationMethod": "email_ownership"
}
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({
userId: '3d5c9971-451e-4711-8874-ff498d55e601',
confirmEmail: 'subject@example.com',
plan: {
subjectUserId: '3d5c9971-451e-4711-8874-ff498d55e601',
subjectTenantUserIds: [],
subjectEmailHash: 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff',
dispositions: [],
conflicts: [],
retained: [],
scrubbed: [],
externalSurfaces: {redisKeyPatterns: [], gcsPaths: [], apiKeyIds: []},
externalDeliveries: []
},
verificationMethod: 'email_ownership'
})
};
fetch('https://api.royalti.io/godmin/account-erasure/execute', 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.royalti.io/godmin/account-erasure/execute",
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([
'userId' => '3d5c9971-451e-4711-8874-ff498d55e601',
'confirmEmail' => 'subject@example.com',
'plan' => [
'subjectUserId' => '3d5c9971-451e-4711-8874-ff498d55e601',
'subjectTenantUserIds' => [
],
'subjectEmailHash' => 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff',
'dispositions' => [
],
'conflicts' => [
],
'retained' => [
],
'scrubbed' => [
],
'externalSurfaces' => [
'redisKeyPatterns' => [
],
'gcsPaths' => [
],
'apiKeyIds' => [
]
],
'externalDeliveries' => [
]
],
'verificationMethod' => 'email_ownership'
]),
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.royalti.io/godmin/account-erasure/execute"
payload := strings.NewReader("{\n \"userId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"confirmEmail\": \"subject@example.com\",\n \"plan\": {\n \"subjectUserId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"subjectTenantUserIds\": [],\n \"subjectEmailHash\": \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\",\n \"dispositions\": [],\n \"conflicts\": [],\n \"retained\": [],\n \"scrubbed\": [],\n \"externalSurfaces\": {\n \"redisKeyPatterns\": [],\n \"gcsPaths\": [],\n \"apiKeyIds\": []\n },\n \"externalDeliveries\": []\n },\n \"verificationMethod\": \"email_ownership\"\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.royalti.io/godmin/account-erasure/execute")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"confirmEmail\": \"subject@example.com\",\n \"plan\": {\n \"subjectUserId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"subjectTenantUserIds\": [],\n \"subjectEmailHash\": \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\",\n \"dispositions\": [],\n \"conflicts\": [],\n \"retained\": [],\n \"scrubbed\": [],\n \"externalSurfaces\": {\n \"redisKeyPatterns\": [],\n \"gcsPaths\": [],\n \"apiKeyIds\": []\n },\n \"externalDeliveries\": []\n },\n \"verificationMethod\": \"email_ownership\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/godmin/account-erasure/execute")
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 \"userId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"confirmEmail\": \"subject@example.com\",\n \"plan\": {\n \"subjectUserId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"subjectTenantUserIds\": [],\n \"subjectEmailHash\": \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\",\n \"dispositions\": [],\n \"conflicts\": [],\n \"retained\": [],\n \"scrubbed\": [],\n \"externalSurfaces\": {\n \"redisKeyPatterns\": [],\n \"gcsPaths\": [],\n \"apiKeyIds\": []\n },\n \"externalDeliveries\": []\n },\n \"verificationMethod\": \"email_ownership\"\n}"
response = http.request(request)
puts response.read_body{
"record": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectTenantUserIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subjectEmailHash": "<string>",
"requestSource": "self_serve",
"verificationMethod": "<string>",
"actorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actorType": "superadmin",
"manifest": {
"subjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectTenantUserIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subjectEmailHash": "<string>",
"dispositions": [
{
"table": "<string>",
"disposition": "purge",
"matchedBy": [
"<string>"
],
"rowCount": 1,
"columns": [
"<string>"
],
"reason": "<string>"
}
],
"conflicts": [
{
"kind": "sole_owner",
"message": "<string>",
"table": "<string>"
}
],
"retained": [
{
"table": "<string>",
"rowCount": 1,
"statutoryBasis": "<string>"
}
],
"scrubbed": [
{
"table": "<string>",
"rowCount": 1,
"replacements": {}
}
],
"externalSurfaces": {
"redisKeyPatterns": [
"<string>"
],
"gcsPaths": [
"<string>"
],
"apiKeyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"externalDeliveries": [
{
"kind": "ddex",
"table": "<string>",
"rowCount": 1,
"note": "<string>"
}
]
},
"retainedTables": {},
"externalSurfaces": {
"redisKeys": [
"<string>"
],
"gcsObjects": [
"<string>"
],
"apiKeyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"status": "completed",
"error": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"executedAt": "2023-11-07T05:31:56Z",
"retentionExpiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"record": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectTenantUserIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subjectEmailHash": "<string>",
"requestSource": "self_serve",
"verificationMethod": "<string>",
"actorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actorType": "superadmin",
"manifest": {
"subjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectTenantUserIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subjectEmailHash": "<string>",
"dispositions": [
{
"table": "<string>",
"disposition": "purge",
"matchedBy": [
"<string>"
],
"rowCount": 1,
"columns": [
"<string>"
],
"reason": "<string>"
}
],
"conflicts": [
{
"kind": "sole_owner",
"message": "<string>",
"table": "<string>"
}
],
"retained": [
{
"table": "<string>",
"rowCount": 1,
"statutoryBasis": "<string>"
}
],
"scrubbed": [
{
"table": "<string>",
"rowCount": 1,
"replacements": {}
}
],
"externalSurfaces": {
"redisKeyPatterns": [
"<string>"
],
"gcsPaths": [
"<string>"
],
"apiKeyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"externalDeliveries": [
{
"kind": "ddex",
"table": "<string>",
"rowCount": 1,
"note": "<string>"
}
]
},
"retainedTables": {},
"externalSurfaces": {
"redisKeys": [
"<string>"
],
"gcsObjects": [
"<string>"
],
"apiKeyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"status": "completed",
"error": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"executedAt": "2023-11-07T05:31:56Z",
"retentionExpiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Account Erasure
Execute an account erasure
Performs the irreversible erasure described by the submitted
POST
/
godmin
/
account-erasure
/
execute
Execute an account erasure
curl --request POST \
--url https://api.royalti.io/godmin/account-erasure/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userId": "3d5c9971-451e-4711-8874-ff498d55e601",
"confirmEmail": "subject@example.com",
"plan": {
"subjectUserId": "3d5c9971-451e-4711-8874-ff498d55e601",
"subjectTenantUserIds": [],
"subjectEmailHash": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"dispositions": [],
"conflicts": [],
"retained": [],
"scrubbed": [],
"externalSurfaces": {
"redisKeyPatterns": [],
"gcsPaths": [],
"apiKeyIds": []
},
"externalDeliveries": []
},
"verificationMethod": "email_ownership"
}
'import requests
url = "https://api.royalti.io/godmin/account-erasure/execute"
payload = {
"userId": "3d5c9971-451e-4711-8874-ff498d55e601",
"confirmEmail": "subject@example.com",
"plan": {
"subjectUserId": "3d5c9971-451e-4711-8874-ff498d55e601",
"subjectTenantUserIds": [],
"subjectEmailHash": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"dispositions": [],
"conflicts": [],
"retained": [],
"scrubbed": [],
"externalSurfaces": {
"redisKeyPatterns": [],
"gcsPaths": [],
"apiKeyIds": []
},
"externalDeliveries": []
},
"verificationMethod": "email_ownership"
}
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({
userId: '3d5c9971-451e-4711-8874-ff498d55e601',
confirmEmail: 'subject@example.com',
plan: {
subjectUserId: '3d5c9971-451e-4711-8874-ff498d55e601',
subjectTenantUserIds: [],
subjectEmailHash: 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff',
dispositions: [],
conflicts: [],
retained: [],
scrubbed: [],
externalSurfaces: {redisKeyPatterns: [], gcsPaths: [], apiKeyIds: []},
externalDeliveries: []
},
verificationMethod: 'email_ownership'
})
};
fetch('https://api.royalti.io/godmin/account-erasure/execute', 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.royalti.io/godmin/account-erasure/execute",
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([
'userId' => '3d5c9971-451e-4711-8874-ff498d55e601',
'confirmEmail' => 'subject@example.com',
'plan' => [
'subjectUserId' => '3d5c9971-451e-4711-8874-ff498d55e601',
'subjectTenantUserIds' => [
],
'subjectEmailHash' => 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff',
'dispositions' => [
],
'conflicts' => [
],
'retained' => [
],
'scrubbed' => [
],
'externalSurfaces' => [
'redisKeyPatterns' => [
],
'gcsPaths' => [
],
'apiKeyIds' => [
]
],
'externalDeliveries' => [
]
],
'verificationMethod' => 'email_ownership'
]),
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.royalti.io/godmin/account-erasure/execute"
payload := strings.NewReader("{\n \"userId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"confirmEmail\": \"subject@example.com\",\n \"plan\": {\n \"subjectUserId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"subjectTenantUserIds\": [],\n \"subjectEmailHash\": \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\",\n \"dispositions\": [],\n \"conflicts\": [],\n \"retained\": [],\n \"scrubbed\": [],\n \"externalSurfaces\": {\n \"redisKeyPatterns\": [],\n \"gcsPaths\": [],\n \"apiKeyIds\": []\n },\n \"externalDeliveries\": []\n },\n \"verificationMethod\": \"email_ownership\"\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.royalti.io/godmin/account-erasure/execute")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"confirmEmail\": \"subject@example.com\",\n \"plan\": {\n \"subjectUserId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"subjectTenantUserIds\": [],\n \"subjectEmailHash\": \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\",\n \"dispositions\": [],\n \"conflicts\": [],\n \"retained\": [],\n \"scrubbed\": [],\n \"externalSurfaces\": {\n \"redisKeyPatterns\": [],\n \"gcsPaths\": [],\n \"apiKeyIds\": []\n },\n \"externalDeliveries\": []\n },\n \"verificationMethod\": \"email_ownership\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/godmin/account-erasure/execute")
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 \"userId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"confirmEmail\": \"subject@example.com\",\n \"plan\": {\n \"subjectUserId\": \"3d5c9971-451e-4711-8874-ff498d55e601\",\n \"subjectTenantUserIds\": [],\n \"subjectEmailHash\": \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\",\n \"dispositions\": [],\n \"conflicts\": [],\n \"retained\": [],\n \"scrubbed\": [],\n \"externalSurfaces\": {\n \"redisKeyPatterns\": [],\n \"gcsPaths\": [],\n \"apiKeyIds\": []\n },\n \"externalDeliveries\": []\n },\n \"verificationMethod\": \"email_ownership\"\n}"
response = http.request(request)
puts response.read_body{
"record": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectTenantUserIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subjectEmailHash": "<string>",
"requestSource": "self_serve",
"verificationMethod": "<string>",
"actorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actorType": "superadmin",
"manifest": {
"subjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectTenantUserIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subjectEmailHash": "<string>",
"dispositions": [
{
"table": "<string>",
"disposition": "purge",
"matchedBy": [
"<string>"
],
"rowCount": 1,
"columns": [
"<string>"
],
"reason": "<string>"
}
],
"conflicts": [
{
"kind": "sole_owner",
"message": "<string>",
"table": "<string>"
}
],
"retained": [
{
"table": "<string>",
"rowCount": 1,
"statutoryBasis": "<string>"
}
],
"scrubbed": [
{
"table": "<string>",
"rowCount": 1,
"replacements": {}
}
],
"externalSurfaces": {
"redisKeyPatterns": [
"<string>"
],
"gcsPaths": [
"<string>"
],
"apiKeyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"externalDeliveries": [
{
"kind": "ddex",
"table": "<string>",
"rowCount": 1,
"note": "<string>"
}
]
},
"retainedTables": {},
"externalSurfaces": {
"redisKeys": [
"<string>"
],
"gcsObjects": [
"<string>"
],
"apiKeyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"status": "completed",
"error": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"executedAt": "2023-11-07T05:31:56Z",
"retentionExpiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"record": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectTenantUserIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subjectEmailHash": "<string>",
"requestSource": "self_serve",
"verificationMethod": "<string>",
"actorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actorType": "superadmin",
"manifest": {
"subjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectTenantUserIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subjectEmailHash": "<string>",
"dispositions": [
{
"table": "<string>",
"disposition": "purge",
"matchedBy": [
"<string>"
],
"rowCount": 1,
"columns": [
"<string>"
],
"reason": "<string>"
}
],
"conflicts": [
{
"kind": "sole_owner",
"message": "<string>",
"table": "<string>"
}
],
"retained": [
{
"table": "<string>",
"rowCount": 1,
"statutoryBasis": "<string>"
}
],
"scrubbed": [
{
"table": "<string>",
"rowCount": 1,
"replacements": {}
}
],
"externalSurfaces": {
"redisKeyPatterns": [
"<string>"
],
"gcsPaths": [
"<string>"
],
"apiKeyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"externalDeliveries": [
{
"kind": "ddex",
"table": "<string>",
"rowCount": 1,
"note": "<string>"
}
]
},
"retainedTables": {},
"externalSurfaces": {
"redisKeys": [
"<string>"
],
"gcsObjects": [
"<string>"
],
"apiKeyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"status": "completed",
"error": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"executedAt": "2023-11-07T05:31:56Z",
"retentionExpiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Description
ErasurePlan. Before writing, the service:
- Re-derives the plan and compares it to the submitted plan (deep, canonicalised equality). Drift returns 409.
- Confirms
userIdandconfirmEmailboth identify the plan’s subject. - Refuses if any conflict (e.g.
sole_owner) is present. - Runs purge/scrub/tombstone inside a transaction with audit hooks suppressed.
201 when all external surfaces were purged, 207 when the
database erasure succeeded but Redis or GCS cleanup partially failed.
Requires main_super_admin role.
Authorization:
- Required role: Main Super Admin (system)
Code Examples
const response = await fetch('https://api.royalti.io/godmin/account-erasure/execute', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
"ref": "#/components/schemas/AccountErasureExecuteRequest"
})
});
const data = await response.json();
console.log(data);
import requests
response = requests.post(
'https://api.royalti.io/godmin/account-erasure/execute',
json={"ref":"#/components/schemas/AccountErasureExecuteRequest"}
)
data = response.json()
print(data)
curl -X POST https://api.royalti.io/godmin/account-erasure/execute \
-H "Content-Type: application/json" \
-d '{"ref":"#/components/schemas/AccountErasureExecuteRequest"}'
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Body
application/json
Subject Users.id — the caller's confirmation of who is being erased.
Subject's email, echoed by the operator. Hashed and matched against the plan.
Show child attributes
Show child attributes
How the subject/requester was verified (e.g. email_ownership, support_ticket).
Compliance classification for the ErasureRecord.
Available options:
self_serve, support_request, regulator, operator When the subject asked. Drives retentionExpiresAt; must not be in
the future.
Response
Erasure completed (all external surfaces purged)
Show child attributes
Show child attributes