Skip to content

Recognise person

POST
/v1/actions/hospitality.action.recognise_person/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.recognise_person/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "new_local_status": "not_local", "person_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "recognised_at": "2026-04-15T12:00:00Z", "recogniser": "example", "venue_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Move a person up the four-rung local_status ladder (not_local → observed_local → known_regular → named_recognised). The status overwrites the existing relationship_context.local_status; the companion local_status_computed_at records the transition time. When venue_id is provided, a temporal person_frequents_venue link is created for the cross-property recognition handoff.

Effects: modify hospitality.person; link hospitality.link.person_frequents_venue.

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
new_local_status
required
New local status
string
Allowed values: not_local observed_local known_regular named_recognised
person_id
required
Person being recognised
string format: uuid
recognised_at
required
Recognition timestamp
string format: date-time
recogniser
required
Recogniser principal identifier
string
venue_id
Venue (when recognition is venue-scoped)
string format: uuid
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
target
required
object
id
required
string format: uuid
object_type
required
Allowed value: hospitality.property

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
link_type
required
Allowed values: hospitality.link.person_frequents_venue
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: modified
object_type
required
Allowed values: hospitality.person
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",
"link_type": "hospitality.link.person_frequents_venue"
}
],
"modified_objects": [
{
"kind": "modified",
"object_type": "hospitality.person"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.