Check which obligations potentially apply to an entity profile

curl --request POST \
  --url https://api.esheria.ai/api/v1/domain-packs/{pack_id}/applicability-check \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "activities": [
    "personal_data_processing"
  ],
  "entity_profile": {
    "data_categories": [
      "customer_personal_data"
    ],
    "entity_types": [
      "company",
      "data_controller"
    ],
    "existing_controls": [],
    "jurisdictions": [
      "UK"
    ],
    "licences": [],
    "regulated_activities": [
      "personal_data_processing"
    ],
    "risk_flags": []
  },
  "entity_roles": [
    "data_controller"
  ],
  "limit": 100,
  "publication_mode": "published",
  "sector_tags": [
    "financial_services"
  ]
}
'

import requests

url = "https://api.esheria.ai/api/v1/domain-packs/{pack_id}/applicability-check"

payload = {
    "activities": ["personal_data_processing"],
    "entity_profile": {
        "data_categories": ["customer_personal_data"],
        "entity_types": ["company", "data_controller"],
        "existing_controls": [],
        "jurisdictions": ["UK"],
        "licences": [],
        "regulated_activities": ["personal_data_processing"],
        "risk_flags": []
    },
    "entity_roles": ["data_controller"],
    "limit": 100,
    "publication_mode": "published",
    "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: {
      data_categories: ['customer_personal_data'],
      entity_types: ['company', 'data_controller'],
      existing_controls: [],
      jurisdictions: ['UK'],
      licences: [],
      regulated_activities: ['personal_data_processing'],
      risk_flags: []
    },
    entity_roles: ['data_controller'],
    limit: 100,
    publication_mode: 'published',
    sector_tags: ['financial_services']
  })
};

fetch('https://api.esheria.ai/api/v1/domain-packs/{pack_id}/applicability-check', 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/domain-packs/{pack_id}/applicability-check",
  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' => [
        'data_categories' => [
                'customer_personal_data'
        ],
        'entity_types' => [
                'company',
                'data_controller'
        ],
        'existing_controls' => [
                
        ],
        'jurisdictions' => [
                'UK'
        ],
        'licences' => [
                
        ],
        'regulated_activities' => [
                'personal_data_processing'
        ],
        'risk_flags' => [
                
        ]
    ],
    'entity_roles' => [
        'data_controller'
    ],
    'limit' => 100,
    'publication_mode' => 'published',
    '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/domain-packs/{pack_id}/applicability-check"

	payload := strings.NewReader("{\n  \"activities\": [\n    \"personal_data_processing\"\n  ],\n  \"entity_profile\": {\n    \"data_categories\": [\n      \"customer_personal_data\"\n    ],\n    \"entity_types\": [\n      \"company\",\n      \"data_controller\"\n    ],\n    \"existing_controls\": [],\n    \"jurisdictions\": [\n      \"UK\"\n    ],\n    \"licences\": [],\n    \"regulated_activities\": [\n      \"personal_data_processing\"\n    ],\n    \"risk_flags\": []\n  },\n  \"entity_roles\": [\n    \"data_controller\"\n  ],\n  \"limit\": 100,\n  \"publication_mode\": \"published\",\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/domain-packs/{pack_id}/applicability-check")
  .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    \"data_categories\": [\n      \"customer_personal_data\"\n    ],\n    \"entity_types\": [\n      \"company\",\n      \"data_controller\"\n    ],\n    \"existing_controls\": [],\n    \"jurisdictions\": [\n      \"UK\"\n    ],\n    \"licences\": [],\n    \"regulated_activities\": [\n      \"personal_data_processing\"\n    ],\n    \"risk_flags\": []\n  },\n  \"entity_roles\": [\n    \"data_controller\"\n  ],\n  \"limit\": 100,\n  \"publication_mode\": \"published\",\n  \"sector_tags\": [\n    \"financial_services\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.esheria.ai/api/v1/domain-packs/{pack_id}/applicability-check")

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    \"data_categories\": [\n      \"customer_personal_data\"\n    ],\n    \"entity_types\": [\n      \"company\",\n      \"data_controller\"\n    ],\n    \"existing_controls\": [],\n    \"jurisdictions\": [\n      \"UK\"\n    ],\n    \"licences\": [],\n    \"regulated_activities\": [\n      \"personal_data_processing\"\n    ],\n    \"risk_flags\": []\n  },\n  \"entity_roles\": [\n    \"data_controller\"\n  ],\n  \"limit\": 100,\n  \"publication_mode\": \"published\",\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"
}