Regulatory Pack API

Check which obligations potentially apply to an entity profile

post/api/v1/domain-packs/{pack_id}/applicability-check

Request

  • Base URL: https://api.esheria.ai
  • URL: https://api.esheria.ai/api/v1/domain-packs/{pack_id}/applicability-check
  • Auth: API key in header x-api-key

Path parameters

pack_idstring required

Headers

idempotency-keystring required

Unique key for mutating request replay protection.

Request body

entity_rolesstring[]
activitiesstring[]
sector_tagsstring[]
processing_characteristicsstring[]
entity_profileobject
profile_factsobject[]
include_non_matchesboolean
publication_mode'published' | 'citation_verified' | 'draft' | 'semantic_draft' nullable
domain_pack_versionstring nullable
limitinteger

Example request

{
  "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"
  ]
}

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.