Customer Applicability API

Create a workspace-scoped customer regulatory profile

post/api/v1/customer-profiles

Request

  • Base URL: https://api.esheria.ai
  • URL: https://api.esheria.ai/api/v1/customer-profiles
  • Auth: API key in header x-api-key

Headers

idempotency-keystring required

Unique key for mutating request replay protection.

Request body

profile_namestring required
default_pack_idsstring[]
entity_profileobject
profile_factsobject[]
metadataobject

Example request

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

Response

Successful Response

unknown required

Changes

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