Customer Applicability API
Preview customer applicability and change impacts without storing customer state
POST
/
api
/
v1
/
customer-lifecycle
/
preview
Preview customer applicability and change impacts without storing customer state
curl --request POST \
--url https://api.esheria.ai/api/v1/customer-lifecycle/preview \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"activities": [
"personal_data_processing"
],
"entity_profile": {
"entity_types": [
"data_controller"
],
"jurisdictions": [
"UK",
"EU"
],
"regulated_activities": [
"personal_data_processing"
]
},
"entity_roles": [
"data_controller"
],
"include_change_impacts": true,
"limit": 100,
"pack_ids": [
"UK-DATA-PROTECTION-PRIVACY",
"EU-GDPR-DATA-PROTECTION"
],
"sector_tags": [
"financial_services"
]
}
'import requests
url = "https://api.esheria.ai/api/v1/customer-lifecycle/preview"
payload = {
"activities": ["personal_data_processing"],
"entity_profile": {
"entity_types": ["data_controller"],
"jurisdictions": ["UK", "EU"],
"regulated_activities": ["personal_data_processing"]
},
"entity_roles": ["data_controller"],
"include_change_impacts": True,
"limit": 100,
"pack_ids": ["UK-DATA-PROTECTION-PRIVACY", "EU-GDPR-DATA-PROTECTION"],
"sector_tags": ["financial_services"]
}
headers = {
"idempotency-key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
activities: ['personal_data_processing'],
entity_profile: {
entity_types: ['data_controller'],
jurisdictions: ['UK', 'EU'],
regulated_activities: ['personal_data_processing']
},
entity_roles: ['data_controller'],
include_change_impacts: true,
limit: 100,
pack_ids: ['UK-DATA-PROTECTION-PRIVACY', 'EU-GDPR-DATA-PROTECTION'],
sector_tags: ['financial_services']
})
};
fetch('https://api.esheria.ai/api/v1/customer-lifecycle/preview', 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.esheria.ai/api/v1/customer-lifecycle/preview",
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([
'activities' => [
'personal_data_processing'
],
'entity_profile' => [
'entity_types' => [
'data_controller'
],
'jurisdictions' => [
'UK',
'EU'
],
'regulated_activities' => [
'personal_data_processing'
]
],
'entity_roles' => [
'data_controller'
],
'include_change_impacts' => true,
'limit' => 100,
'pack_ids' => [
'UK-DATA-PROTECTION-PRIVACY',
'EU-GDPR-DATA-PROTECTION'
],
'sector_tags' => [
'financial_services'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>",
"x-api-key: <api-key>"
],
]);
$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.esheria.ai/api/v1/customer-lifecycle/preview"
payload := strings.NewReader("{\n \"activities\": [\n \"personal_data_processing\"\n ],\n \"entity_profile\": {\n \"entity_types\": [\n \"data_controller\"\n ],\n \"jurisdictions\": [\n \"UK\",\n \"EU\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ]\n },\n \"entity_roles\": [\n \"data_controller\"\n ],\n \"include_change_impacts\": true,\n \"limit\": 100,\n \"pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
req.Header.Add("x-api-key", "<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.esheria.ai/api/v1/customer-lifecycle/preview")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"activities\": [\n \"personal_data_processing\"\n ],\n \"entity_profile\": {\n \"entity_types\": [\n \"data_controller\"\n ],\n \"jurisdictions\": [\n \"UK\",\n \"EU\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ]\n },\n \"entity_roles\": [\n \"data_controller\"\n ],\n \"include_change_impacts\": true,\n \"limit\": 100,\n \"pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.esheria.ai/api/v1/customer-lifecycle/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"activities\": [\n \"personal_data_processing\"\n ],\n \"entity_profile\": {\n \"entity_types\": [\n \"data_controller\"\n ],\n \"jurisdictions\": [\n \"UK\",\n \"EU\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ]\n },\n \"entity_roles\": [\n \"data_controller\"\n ],\n \"include_change_impacts\": true,\n \"limit\": 100,\n \"pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "error",
"errors": [
{
"code": "unauthorized",
"message": "Invalid API key"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "credits_exhausted",
"message": "API credits exhausted"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "duplicate_token_name",
"message": "An active data token already uses that name."
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "validation_error",
"message": "Invalid payload",
"field": "body.name"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "billing_unavailable",
"message": "Billing ledger is unavailable"
}
],
"trace_id": "trace-123"
}Authorizations
Client API key issued by Esheria.
Headers
Unique key for mutating request replay protection.
Body
application/json
Minimum array length:
1Show child attributes
Show child attributes
Maximum string length:
160Maximum string length:
160Required range:
1 <= x <= 500Response
Successful Response
List source or fact changes queued for regulatory pack recompile
Previous
List workspace-scoped customer regulatory profiles
Next
⌘I
Preview customer applicability and change impacts without storing customer state
curl --request POST \
--url https://api.esheria.ai/api/v1/customer-lifecycle/preview \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"activities": [
"personal_data_processing"
],
"entity_profile": {
"entity_types": [
"data_controller"
],
"jurisdictions": [
"UK",
"EU"
],
"regulated_activities": [
"personal_data_processing"
]
},
"entity_roles": [
"data_controller"
],
"include_change_impacts": true,
"limit": 100,
"pack_ids": [
"UK-DATA-PROTECTION-PRIVACY",
"EU-GDPR-DATA-PROTECTION"
],
"sector_tags": [
"financial_services"
]
}
'import requests
url = "https://api.esheria.ai/api/v1/customer-lifecycle/preview"
payload = {
"activities": ["personal_data_processing"],
"entity_profile": {
"entity_types": ["data_controller"],
"jurisdictions": ["UK", "EU"],
"regulated_activities": ["personal_data_processing"]
},
"entity_roles": ["data_controller"],
"include_change_impacts": True,
"limit": 100,
"pack_ids": ["UK-DATA-PROTECTION-PRIVACY", "EU-GDPR-DATA-PROTECTION"],
"sector_tags": ["financial_services"]
}
headers = {
"idempotency-key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
activities: ['personal_data_processing'],
entity_profile: {
entity_types: ['data_controller'],
jurisdictions: ['UK', 'EU'],
regulated_activities: ['personal_data_processing']
},
entity_roles: ['data_controller'],
include_change_impacts: true,
limit: 100,
pack_ids: ['UK-DATA-PROTECTION-PRIVACY', 'EU-GDPR-DATA-PROTECTION'],
sector_tags: ['financial_services']
})
};
fetch('https://api.esheria.ai/api/v1/customer-lifecycle/preview', 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.esheria.ai/api/v1/customer-lifecycle/preview",
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([
'activities' => [
'personal_data_processing'
],
'entity_profile' => [
'entity_types' => [
'data_controller'
],
'jurisdictions' => [
'UK',
'EU'
],
'regulated_activities' => [
'personal_data_processing'
]
],
'entity_roles' => [
'data_controller'
],
'include_change_impacts' => true,
'limit' => 100,
'pack_ids' => [
'UK-DATA-PROTECTION-PRIVACY',
'EU-GDPR-DATA-PROTECTION'
],
'sector_tags' => [
'financial_services'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>",
"x-api-key: <api-key>"
],
]);
$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.esheria.ai/api/v1/customer-lifecycle/preview"
payload := strings.NewReader("{\n \"activities\": [\n \"personal_data_processing\"\n ],\n \"entity_profile\": {\n \"entity_types\": [\n \"data_controller\"\n ],\n \"jurisdictions\": [\n \"UK\",\n \"EU\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ]\n },\n \"entity_roles\": [\n \"data_controller\"\n ],\n \"include_change_impacts\": true,\n \"limit\": 100,\n \"pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
req.Header.Add("x-api-key", "<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.esheria.ai/api/v1/customer-lifecycle/preview")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"activities\": [\n \"personal_data_processing\"\n ],\n \"entity_profile\": {\n \"entity_types\": [\n \"data_controller\"\n ],\n \"jurisdictions\": [\n \"UK\",\n \"EU\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ]\n },\n \"entity_roles\": [\n \"data_controller\"\n ],\n \"include_change_impacts\": true,\n \"limit\": 100,\n \"pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.esheria.ai/api/v1/customer-lifecycle/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"activities\": [\n \"personal_data_processing\"\n ],\n \"entity_profile\": {\n \"entity_types\": [\n \"data_controller\"\n ],\n \"jurisdictions\": [\n \"UK\",\n \"EU\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ]\n },\n \"entity_roles\": [\n \"data_controller\"\n ],\n \"include_change_impacts\": true,\n \"limit\": 100,\n \"pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "error",
"errors": [
{
"code": "unauthorized",
"message": "Invalid API key"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "credits_exhausted",
"message": "API credits exhausted"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "duplicate_token_name",
"message": "An active data token already uses that name."
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "validation_error",
"message": "Invalid payload",
"field": "body.name"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "billing_unavailable",
"message": "Billing ledger is unavailable"
}
],
"trace_id": "trace-123"
}