Skip to content

Grant consent

POST
/v1/actions/hospitality.action.grant_consent/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.grant_consent/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "default_scope": {}, "effective_from": "2026-04-15T12:00:00Z", "effective_until": "2026-04-15T12:00:00Z", "min_cohort_size": 1, "policy_text_uri": "example", "purposes_grantable": [ "operational" ], "regulatory_basis": "example", "verified_by": "example" }, "return_modified": false }'

Write the next monotonic version of the tenant’s consent_policy. The first grant creates the policy at version 1; each subsequent grant supersedes it with a strictly greater version (the prior version stays in the object’s event history). default_scope is the deny-by-omission ConsentScope applied to objects that carry none; purposes_grantable bounds what any scope under this policy may grant. Emits consent.policy_granted.

Effects: create hospitality.consent_policy; modify hospitality.consent_policy.

Media typeapplication/json
object
branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid
params
required
object
default_scope
required
Default ConsentScope applied to objects without their own scope
object
key
additional properties
any
effective_from
required
When this policy version takes effect
string format: date-time
effective_until
When this policy version is superseded
string format: date-time
min_cohort_size
Kernel-level k-anonymity floor (default 5)
integer
policy_text_uri
Opaque pointer to the human-readable policy document
string
purposes_grantable
required
Purposes this policy may grant
Array<string>
Allowed values: operational benchmark_aggregate federated_query federated_training model_distillation fraud_network
regulatory_basis
required
Regulatory regime this policy is written under (GDPR / CCPA / UK DUA …)
string
verified_by
Principal::stable_id() of the DPO sign-off, when verified
string
return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json
ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object
correlation_id
required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid
modified_links
required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>
object
from_id
required
string format: uuid
from_type
required
string
kind
required
Allowed values: linked unlinked properties_updated end_dated
link_type
required
string
to_id
required
string format: uuid
to_type
required
string
modified_objects
required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>
object
id
required
string format: uuid
kind
required
Allowed values: created modified
object_type
required
Allowed values: hospitality.consent_policy
warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>
object
message
required

Human-readable summary, suitable for logging or operator-UI surfacing.

string
object_type
required

Object type the warning was raised against.

string
property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string
rule
required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string
Example
{
"modified_links": [
{
"kind": "linked"
}
],
"modified_objects": [
{
"kind": "created",
"object_type": "hospitality.consent_policy"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.