Customer Applicability API
Create a workspace-scoped customer regulatory profile
POST
/
api
/
v1
/
customer-profiles
Create a workspace-scoped customer regulatory profile
curl --request POST \
--url https://api.esheria.ai/api/v1/customer-profiles \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"default_pack_ids": [
"UK-DATA-PROTECTION-PRIVACY",
"EU-GDPR-DATA-PROTECTION"
],
"entity_profile": {
"entity_roles": [
"data_controller",
"company"
],
"regulated_activities": [
"personal_data_processing"
],
"sector_tags": [
"financial_services"
]
},
"profile_facts": [
{
"confidence": 1,
"fact_type": "entity_role",
"source": "customer_attestation",
"value": "data_controller"
}
],
"profile_name": "Acme UK and EU fintech"
}
'import requests
url = "https://api.esheria.ai/api/v1/customer-profiles"
payload = {
"default_pack_ids": ["UK-DATA-PROTECTION-PRIVACY", "EU-GDPR-DATA-PROTECTION"],
"entity_profile": {
"entity_roles": ["data_controller", "company"],
"regulated_activities": ["personal_data_processing"],
"sector_tags": ["financial_services"]
},
"profile_facts": [
{
"confidence": 1,
"fact_type": "entity_role",
"source": "customer_attestation",
"value": "data_controller"
}
],
"profile_name": "Acme UK and EU fintech"
}
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({
default_pack_ids: ['UK-DATA-PROTECTION-PRIVACY', 'EU-GDPR-DATA-PROTECTION'],
entity_profile: {
entity_roles: ['data_controller', 'company'],
regulated_activities: ['personal_data_processing'],
sector_tags: ['financial_services']
},
profile_facts: [
{
confidence: 1,
fact_type: 'entity_role',
source: 'customer_attestation',
value: 'data_controller'
}
],
profile_name: 'Acme UK and EU fintech'
})
};
fetch('https://api.esheria.ai/api/v1/customer-profiles', 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-profiles",
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([
'default_pack_ids' => [
'UK-DATA-PROTECTION-PRIVACY',
'EU-GDPR-DATA-PROTECTION'
],
'entity_profile' => [
'entity_roles' => [
'data_controller',
'company'
],
'regulated_activities' => [
'personal_data_processing'
],
'sector_tags' => [
'financial_services'
]
],
'profile_facts' => [
[
'confidence' => 1,
'fact_type' => 'entity_role',
'source' => 'customer_attestation',
'value' => 'data_controller'
]
],
'profile_name' => 'Acme UK and EU fintech'
]),
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-profiles"
payload := strings.NewReader("{\n \"default_pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"entity_profile\": {\n \"entity_roles\": [\n \"data_controller\",\n \"company\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n },\n \"profile_facts\": [\n {\n \"confidence\": 1,\n \"fact_type\": \"entity_role\",\n \"source\": \"customer_attestation\",\n \"value\": \"data_controller\"\n }\n ],\n \"profile_name\": \"Acme UK and EU fintech\"\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-profiles")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"default_pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"entity_profile\": {\n \"entity_roles\": [\n \"data_controller\",\n \"company\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n },\n \"profile_facts\": [\n {\n \"confidence\": 1,\n \"fact_type\": \"entity_role\",\n \"source\": \"customer_attestation\",\n \"value\": \"data_controller\"\n }\n ],\n \"profile_name\": \"Acme UK and EU fintech\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.esheria.ai/api/v1/customer-profiles")
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 \"default_pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"entity_profile\": {\n \"entity_roles\": [\n \"data_controller\",\n \"company\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n },\n \"profile_facts\": [\n {\n \"confidence\": 1,\n \"fact_type\": \"entity_role\",\n \"source\": \"customer_attestation\",\n \"value\": \"data_controller\"\n }\n ],\n \"profile_name\": \"Acme UK and EU fintech\"\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
Response
Successful Response
List workspace-scoped customer regulatory profiles
Previous
Inspect a workspace-scoped customer regulatory profile
Next
⌘I
Create a workspace-scoped customer regulatory profile
curl --request POST \
--url https://api.esheria.ai/api/v1/customer-profiles \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"default_pack_ids": [
"UK-DATA-PROTECTION-PRIVACY",
"EU-GDPR-DATA-PROTECTION"
],
"entity_profile": {
"entity_roles": [
"data_controller",
"company"
],
"regulated_activities": [
"personal_data_processing"
],
"sector_tags": [
"financial_services"
]
},
"profile_facts": [
{
"confidence": 1,
"fact_type": "entity_role",
"source": "customer_attestation",
"value": "data_controller"
}
],
"profile_name": "Acme UK and EU fintech"
}
'import requests
url = "https://api.esheria.ai/api/v1/customer-profiles"
payload = {
"default_pack_ids": ["UK-DATA-PROTECTION-PRIVACY", "EU-GDPR-DATA-PROTECTION"],
"entity_profile": {
"entity_roles": ["data_controller", "company"],
"regulated_activities": ["personal_data_processing"],
"sector_tags": ["financial_services"]
},
"profile_facts": [
{
"confidence": 1,
"fact_type": "entity_role",
"source": "customer_attestation",
"value": "data_controller"
}
],
"profile_name": "Acme UK and EU fintech"
}
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({
default_pack_ids: ['UK-DATA-PROTECTION-PRIVACY', 'EU-GDPR-DATA-PROTECTION'],
entity_profile: {
entity_roles: ['data_controller', 'company'],
regulated_activities: ['personal_data_processing'],
sector_tags: ['financial_services']
},
profile_facts: [
{
confidence: 1,
fact_type: 'entity_role',
source: 'customer_attestation',
value: 'data_controller'
}
],
profile_name: 'Acme UK and EU fintech'
})
};
fetch('https://api.esheria.ai/api/v1/customer-profiles', 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-profiles",
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([
'default_pack_ids' => [
'UK-DATA-PROTECTION-PRIVACY',
'EU-GDPR-DATA-PROTECTION'
],
'entity_profile' => [
'entity_roles' => [
'data_controller',
'company'
],
'regulated_activities' => [
'personal_data_processing'
],
'sector_tags' => [
'financial_services'
]
],
'profile_facts' => [
[
'confidence' => 1,
'fact_type' => 'entity_role',
'source' => 'customer_attestation',
'value' => 'data_controller'
]
],
'profile_name' => 'Acme UK and EU fintech'
]),
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-profiles"
payload := strings.NewReader("{\n \"default_pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"entity_profile\": {\n \"entity_roles\": [\n \"data_controller\",\n \"company\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n },\n \"profile_facts\": [\n {\n \"confidence\": 1,\n \"fact_type\": \"entity_role\",\n \"source\": \"customer_attestation\",\n \"value\": \"data_controller\"\n }\n ],\n \"profile_name\": \"Acme UK and EU fintech\"\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-profiles")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"default_pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"entity_profile\": {\n \"entity_roles\": [\n \"data_controller\",\n \"company\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n },\n \"profile_facts\": [\n {\n \"confidence\": 1,\n \"fact_type\": \"entity_role\",\n \"source\": \"customer_attestation\",\n \"value\": \"data_controller\"\n }\n ],\n \"profile_name\": \"Acme UK and EU fintech\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.esheria.ai/api/v1/customer-profiles")
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 \"default_pack_ids\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ],\n \"entity_profile\": {\n \"entity_roles\": [\n \"data_controller\",\n \"company\"\n ],\n \"regulated_activities\": [\n \"personal_data_processing\"\n ],\n \"sector_tags\": [\n \"financial_services\"\n ]\n },\n \"profile_facts\": [\n {\n \"confidence\": 1,\n \"fact_type\": \"entity_role\",\n \"source\": \"customer_attestation\",\n \"value\": \"data_controller\"\n }\n ],\n \"profile_name\": \"Acme UK and EU fintech\"\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"
}