API reference
Systems and policies
Declare your systems (use cases) and read them, with the calls that ran outside what one was approved for; read the regulatory policy packs and the data policy the SDK applies.
Route summaries and field names are written in English, here and in the file.
/api/v1/usecases
GET /api/v1/usecases
The workspace's declared systems (use cases) and their flags
Authentication
API key
Key scope
usecases:readAnswers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_errorPOST /api/v1/usecases
Declare a system (use case)
Authentication
API key
Key scope
usecases:writeBody
name (required) · description · purpose · legal_basis · data_categories · affected_population · ai_act_classification · automated_decision · provider · data_leaves_euAnswers
201 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error · 503 service_unavailableGET /api/v1/usecases/{id}
One declared system (use case)
Authentication
API key
Key scope
usecases:readParameters
id (required)Answers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailablePATCH /api/v1/usecases/{id}
Always refused — a person reviews a use case, from the dashboard
Authentication
API key
Key scope
usecases:writeParameters
id (required)Answers
GET /api/v1/usecases/{id}/divergences
The sealed calls that ran outside what a use case was approved for
Authentication
API key
Key scope
usecases:readParameters
id (required)Answers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error/api/v1/policy
GET /api/v1/policy/packs
The regulatory policy packs, or one pack in full
Authentication
API key
Key scope
policy:readModule
Served where the deployment runs
FEATURE_POLICY_PACKS.Parameters
idAnswers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 not_found · 429 · 500 internal_error · 501 feature_disabled/api/v1/governance
GET /api/v1/governance/config
The workspace's data policy, as the SDK applies it in your process
Authentication
API key
Key scope
policy:readParameters
connector · environmentAnswers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error