Skip to content
aerandil.com
GitHub

Read Registration card

GET
/v1/object-types/hospitality.registration_card/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.registration_card/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

The registration card a guest signed at the desk on check-in: the house’s terms as they were shown, verbatim, who signed and when, and the signature’s strokes as SVG path data. A chargeback’s evidence packet attaches the current card as customer_signature. One current card per stay; signing again supersedes it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “Query Parameters”
branch
string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.registration_card
properties
required
object
captured_by
The desk principal that recorded the card (`principal.stable_id()`)
string
device_label
The desk device the guest signed on, as the desk names it
string
id
required
Card id
string
signature_height
The height of the pad the strokes were drawn on, in the strokes' units
integer
signature_svg_paths
The signature's strokes as SVG path data (`M x y L x y …`, in the pad's own units; at most 64 KB)
string
signature_width
The width of the pad the strokes were drawn on, in the strokes' units
integer
signed_at
required
When the guest signed (the kernel's clock at the desk's write)
string format: date-time
signer_name
The name the guest signed under, as the desk confirmed it
string
status
required
Status
string
Allowed values: current superseded
superseded_at
When a later signing on the same stay replaced this card
string format: date-time
terms_text
required
The terms the guest was shown above the signature, verbatim
string
terms_version
required
Which version of the house's terms was shown — a label or a hash of the text, so two cards signed under the same wording say so
string
provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object
pins
object
key
additional properties
object
pinned_at
string format: date-time
pinned_by
object
reason
required
string
properties
object
key
additional properties
object
external_id
string
recorded_at
required
string format: date-time
source
required
string
source_updated_at
string format: date-time
stream
string
scope
required
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer
>= 1
Example
{
  "object_type": "hospitality.registration_card",
  "properties": {
    "status": "current"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “Headers”
ETag
string
/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

Section titled “404”

No object with that id (or soft-deleted).