Capture guest ID

POST

/v1/actions/hospitality.action.capture_guest_id/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.capture_guest_id/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "document_number_last4": "example", "document_type": "passport", "expiry_date": "2026-04-15", "external_record_reference_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "holder_name": "example", "issuing_country": "example", "retain_until": "2026-04-15", "verification_method": "manual_visual", "verification_status": "unverified" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.person" } }'

• Production API

Record a minimal government-ID document for a guest (statutory registration). Stores only typed facts + a verification result; the raw number / scan is never stored — pass external_record_reference_id pointing at an identity-domain external record for the vault-held artifact. retain_until is the storage-limitation clock.

Effects: create hospitality.guest_id_document; link hospitality.link.guest_id_document_for_person; link hospitality.link.guest_id_document_references_external_record.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.capture_guest_id:apply

Request Body^required

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

document_number_last4

Last 4 glyphs of the document number (never the full number)

string

document_type

required

Document type

string

Allowed values: passport visa national_id drivers_licence residence_permit

expiry_date

Document expiry date

string format: date

external_record_reference_id

Optional pointer to the identity-domain external vault record

string format: uuid

holder_name

Holder name as printed

string

issuing_country

required

Issuing country (ISO 3166-1 alpha-2)

string

retain_until

required

Retain-until date (storage-limitation clock; set per jurisdiction)

string format: date

verification_method

Verification method

string

Allowed values: manual_visual document_scan nfc_chip third_party_idv government_registry

verification_status

Verification status (default unverified)

string

Allowed values: unverified verified failed expired

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.person

Responses

200

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.guest_id_document_for_person hospitality.link.guest_id_document_references_external_record

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

object_type

required

Allowed values: hospitality.guest_id_document

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.guest_id_document_for_person"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.guest_id_document"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.