Skip to content
aerandil.com
GitHub

Validate Capture guest ID (dry-run)

POST
/v1/actions/hospitality.action.capture_guest_id/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.capture_guest_id/validate \
  --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" } }'

Dry-run of apply_hospitality_action_capture_guest_id’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}