Customer Applicability API

Preview customer applicability and change impacts without storing customer state

post/api/v1/customer-lifecycle/preview

Request

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

Headers

idempotency-keystring required

Unique key for mutating request replay protection.

Request body

pack_idsstring[] required
locked_pack_versionsobject
entity_rolesstring[]
activitiesstring[]
sector_tagsstring[]
processing_characteristicsstring[]
entity_profileobject
profile_factsobject[]
include_change_impactsboolean
from_versionstring nullable
to_versionstring nullable
limitinteger

Example request

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

Response

Successful Response

unknown required

Changes

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