FoyerDevelopers

Generated · Live registry

checkin tools

18 tools in this domain, generated from the running registry.

All tool domains

checkin.activeForStay

read-only

Stay-detail UI affordance: number of currently valid portal links for a stay (`pending`/`submitted`/`verified`, effective expiry — the later of `expires_at` and check-out + 10 days — still ahead, booking neither cancelled nor on hold), when they were last blocked (`gesperrtAm`, ISO, `null` if never) and when the youngest valid session was created (`juengsteGueltigeAm`) — a block is current only while it is younger. RLS-scoped via the surrounding protectedProcedure, so the operator cannot probe… Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
activeCountintegeryes
gesperrtAmstring · nullableyes
juengsteGueltigeAmstring · nullableyes

checkin.clear_waiver

writes

Clear a guest's Meldeschein waiver on a pending check-in session — e.g. after the ID-OCR contradiction warning shows the guest is not domestic after all. The portal then asks the nationality question again on the guest's next visit. Only works while the session is still pending.

Input parameters

FieldTypeRequiredNotes
sessionIdstringyesUUID of the checkin_session to clear the waiver on.

Output fields

FieldTypeRequiredNotes
okbooleanyes

checkin.create

writes

Start a new online check-in session for a stay.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tokenstringyes
urlstringyes

checkin.extract_id_ocr

writes

Extract OCR data from a guest ID photo front side using Claude Haiku 4.5 vision. Returns a structured IdOcrResult (vorname, nachname, geburtsdatum, staatsangehoerigkeit, ausweisnummer, address fields, confidence) cached in guest_id_uploads.ocr_data_json. Re-calling returns the cached result without incurring a new Haiku call. Requires a valid 64-char portal token (guest-auth surface). Returns { ok: false, error } for photo_not_found | not_image | cap_exceeded | ocr_failed.

Input parameters

FieldTypeRequiredNotes
tokenstringyes64-char portal token identifying the guest session.
guestIndexintegeryesGuest slot index: 0 = primary booker, 1–5 = co-travelers.

Output fields

One of 2 shapes, depending on the outcome:

Shape 1

FieldTypeRequiredNotes
okliteralyesOne of: true
dataobjectyesIdOcrResult — structured OCR fields.
cachedbooleanyesTrue when result came from DB cache, false when freshly extracted.

Shape 2

FieldTypeRequiredNotes
okliteralyesOne of: false
errorstringyesOne of: invalid_token | token_expired | photo_not_found | not_image | cap_exceeded | ocr_failed

checkin.get

read-only

Get a single check-in session's detail.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
sessionobjectyes
session.idstringyes
session.tenantIdstringyes
session.stayIdstringyes
session.tokenstringyes
session.statusstringyes
session.createdAtstringyes
session.expiresAtstringyes
session.submittedAtstring · nullableyes
session.verifiedAtstring · nullableyes
session.verifiedByUserIdstring · nullableyes
session.refreshedFromTokenstring · nullableyes
session.preArrivalMailSentAtstring · nullableyes
session.allGuestsDomesticboolean · nullableyes
session.meldescheinWaivedAtstring · nullableyes
session.erstmalsGeoeffnetAtstring · nullableyes
guestIdUploadsarray of objectyes
guestIdUploads.uploadIdstringyes
guestIdUploads.guestIndexintegeryes
guestIdUploads.guestNamestringyes
guestIdUploads.hasFrontbooleanyes
guestIdUploads.hasBackbooleanyes
meldescheinobject · nullableyes
meldeschein.idstringyes
meldeschein.sessionIdstringyes
meldeschein.vornamestringyes
meldeschein.nachnamestringyes
meldeschein.geburtsdatumstringyes
meldeschein.geburtsortstring · nullableyes
meldeschein.staatsangehoerigkeitstringyes
meldeschein.ausweisartstringyes
meldeschein.ausweisnummerstring · nullableyes
meldeschein.anschriftStrassestringyes
meldeschein.anschriftPlzstringyes
meldeschein.anschriftOrtstringyes
meldeschein.anschriftLandstringyes
meldeschein.ankunftstringyes
meldeschein.abreisestringyes
meldeschein.mitreisendeJsonarray of objectyes
meldeschein.signatureSvgstring · nullableyes
meldeschein.idPhotoPathstring · nullableyes
meldeschein.createdAtstringyes
stayobject · nullableyes
stay.idstringyes
stay.tenantIdstringyes
stay.guestIdstringyes
stay.externalRefstring · nullableyes
stay.externalCodestring · nullableyes
stay.sourceChannelenum · nullableyesOne of: whatsapp, email, hospitable, voice, channex, beds24
stay.checkInstring · nullableyes
stay.checkOutstring · nullableyes
stay.roomstring · nullableyes
stay.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
stay.otaStatusstring · nullableyes
stay.bookingDatestring · nullableyes
stay.issueAlertstring · nullableyes
stay.stayTypestring · nullableyes
stay.notesstring · nullableyes
stay.createdAtstringyes
stay.paymentIntentIdstring · nullableyes
stay.paymentStatusstring · nullableyes
stay.bookingTotalCentsinteger · nullableyes
stay.currencyCodestring · nullableyes
stay.expectedArrivalAtstring · nullableyes
stay.folioClosedstring · nullableyes
stay.holdExpiresAtstring · nullableyes
stay.sourcestring · nullableyes
stay.guestsCountinteger · nullableyes
stay.adultsinteger · nullableyes
stay.childreninteger · nullableyes
stay.infantsinteger · nullableyes
stay.petsinteger · nullableyes
stay.nightsinteger · nullableyes
stay.otaSourcestring · nullableyes
stay.otaReservationIdstring · nullableyes
guestobject · nullableyes
guest.idstringyes
guest.tenantIdstringyes
guest.canonicalEmailstring · nullableyes
guest.canonicalPhonestring · nullableyes
guest.nameHintstring · nullableyes
guest.localestring · nullableyes
guest.createdAtstringyes
ocrNationalityMismatchbooleanyes
rezeptionsNamenobject · nullableyes
rezeptionsNamen.vornamestringyes
rezeptionsNamen.nachnamestringyes

checkin.getMeldescheinEntry

read-only

Load the operator-finalized Meldeschein entry for a stay. Returns null if no entry exists yet. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
stayIdstringyes
vornamestringyes
nachnamestringyes
geburtsdatumstring · nullableyes
staatsangehoerigkeitstring · nullableyes
ausweisartstring · nullableyes
ausweisnummerstring · nullableyes
anschriftStrassestring · nullableyes
anschriftPlzstring · nullableyes
anschriftOrtstring · nullableyes
anschriftLandstring · nullableyes
ankunftstringyes
abreisestringyes
bundeslandstringyes
finalizedBystring · nullableyes
finalizedAtstring · nullableyes
createdAtstringyes

checkin.getPortalMeldeschein

read-only

Load the guest-portal submitted Meldeschein for a stay. Looks up the most-recent `submitted` or `verified` checkin_session for the stay, then returns its meldeschein row. Returns null when no portal submission exists. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
idstringyes
sessionIdstringyes
vornamestringyes
nachnamestringyes
geburtsdatumstringyes
geburtsortstring · nullableyes
staatsangehoerigkeitstringyes
ausweisartstringyes
ausweisnummerstring · nullableyes
anschriftStrassestringyes
anschriftPlzstringyes
anschriftOrtstringyes
anschriftLandstringyes
ankunftstringyes
abreisestringyes
mitreisendeJsonarray of objectyes
mitreisendeJson.vornamestringyes
mitreisendeJson.nachnamestringyes
mitreisendeJson.geburtsdatumstringyes
signatureSvgstring · nullableyes
idPhotoPathstring · nullableyes
createdAtstringyes

checkin.get_meldeschein

read-only

Get the finalized operator Meldeschein entry for a stay, or the guest-portal submitted data if no operator entry exists. Returns null when neither source has data for the stay. Prefers the operator-finalized entry (meldeschein_entries) over the guest-portal submission (meldescheine) when both exist.

Input parameters

FieldTypeRequiredNotes
stayIdstringyesUUID of the stay to get the Meldeschein for.

Output fields

One of 3 shapes, depending on the outcome:

Shape 1

FieldTypeRequiredNotes
sourceliteralyesOperator-finalized entry (meldeschein_entries). — One of: operator
dataobjectyes
data.idstringyes
data.tenantIdstringyes
data.stayIdstringyes
data.vornamestringyes
data.nachnamestringyes
data.geburtsdatumstring · nullableyesISO date, YYYY-MM-DD.
data.staatsangehoerigkeitstring · nullableyes
data.ausweisartstring · nullableyesperso | reisepass | sonstiges
data.ausweisnummerstring · nullableyes
data.anschriftStrassestring · nullableyes
data.anschriftPlzstring · nullableyes
data.anschriftOrtstring · nullableyes
data.anschriftLandstring · nullableyes
data.ankunftstringyesISO date, YYYY-MM-DD.
data.abreisestringyesISO date, YYYY-MM-DD.
data.bundeslandstringyesFederal state whose Meldeschein rules apply, e.g. 'nrw'.
data.finalizedBystring · nullableyesUser id who finalized, or null.
data.finalizedAtany · nullableyes
data.createdAtanyyes

Shape 2

FieldTypeRequiredNotes
sourceliteralyesGuest-portal submission (meldescheine). — One of: portal
dataobjectyes
data.idstringyes
data.sessionIdstringyes
data.vornamestringyes
data.nachnamestringyes
data.geburtsdatumstringyesISO date, YYYY-MM-DD.
data.geburtsortstring · nullableyes
data.staatsangehoerigkeitstringyes
data.ausweisartstringyesperso | reisepass | sonstiges
data.ausweisnummerstring · nullableyes
data.anschriftStrassestringyes
data.anschriftPlzstringyes
data.anschriftOrtstringyes
data.anschriftLandstringyes
data.ankunftstringyesISO date, YYYY-MM-DD.
data.abreisestringyesISO date, YYYY-MM-DD.
data.mitreisendeJsonarray of objectyesAccompanying guests. Empty array when the guest travelled alone.
data.signatureSvgstring · nullableyesSVG path data from the signature pad.
data.idPhotoPathstring · nullableyesStorage path of the uploaded ID photo.
data.createdAtanyyes

Shape 3

FieldTypeRequiredNotes
sourceliteralyesNeither source holds data for this stay. — One of: none
datanullyes

checkin.list

read-only

List check-in sessions, optionally filtered by stay/status.

Input parameters

FieldTypeRequiredNotes
statusenumnoOne of: pending, submitted, verified, expired
limitintegernoDefault: 50

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
stayIdstringyes
statusstringyes
createdAtstringyes
submittedAtstring · nullableyes
verifiedAtstring · nullableyes
tokenstringyes
meldescheinWaivedAtstring · nullableyes
checkInstring · nullableyes
checkOutstring · nullableyes
roomstring · nullableyes
guestNamestring · nullableyes
exConversationIdstring · nullableyes
externalRefstring · nullableyes

checkin.list_guest_id_uploads

read-only

List all guest ID document uploads for a given stay. Returns metadata including guest name, index (0 = primary booker, 1+ = co-travelers), photo URLs for the photo-serve endpoint, and upload timestamps. Only owner and staff roles may call this tool.

Input parameters

FieldTypeRequiredNotes
stayIdstringyesUUID of the stay to list uploads for.

Output fields

FieldTypeRequiredNotes
uploadsarray of objectyes
uploads.uploadIdstringyes
uploads.guestIndexintegeryes
uploads.guestNamestringyes
uploads.frontUrlstringyes
uploads.backUrlstring · nullableyes
uploads.uploadedAtstringyesISO 8601 UTC timestamp.

checkin.markVerified

writes

Mark a guest's submitted check-in / ID as operator-verified.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okbooleanyes
read-only

“Copy link” in the click window of the timeline: the guest's portal link as the guest receives it — an existing short link (`<origin>/g/<code>`), otherwise the long URL. READ ONLY: `null` without a live session; creates neither a session nor a short link (that is what “send link again” does). Operator roles.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
urlstring · nullableyes

checkin.portalTrichter

read-only

Portal funnel: how far do guests get from “Link verschickt” (link sent) to “Ausweis hochgeladen” (ID uploaded)? Basis is the stays with arrival in the period (default: last 30 days and next 7), excluding cancelled stays, voice holds and mere inquiries. Stages: sent, opened (by humans only, never by link previews), started (any guest action in the portal), registration form (Meldeschein) submitted or waived, ID uploaded — each with count and share. Per stage, the stays that are stuck there… Read-only query.

Input parameters

FieldTypeRequiredNotes
tageZurueckintegernoDefault: 30
tageVorausintegernoDefault: 7

Output fields

FieldTypeRequiredNotes
vonstringyes
bisstringyes
gesamtintegeryes
fertigintegeryes
basisobjectyes
basis.anzahlintegeryes
basis.anteilnumberyes
basis.haengenarray of objectyes
stufenarray of objectyes
stufen.stufeenumyesOne of: verschickt, geoeffnet, angefangen, meldeschein, ausweis
stufen.anzahlintegeryes
stufen.anteilnumberyes
stufen.ohneSignalintegeryes
stufen.haengenarray of objectyes

checkin.revokeForStay

writesconfirm

Revoke the online check-in session for a stay. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

FieldTypeRequiredNotes
revokedCountintegeryes
abgelaufenintegeryes
gedrehtintegeryes
bearbeiteteNachrichtenMitAltemLinkintegeryes

checkin.rotateIdPhoto

writes

Rotates an ID photo by 90° and SAVES the rotation. Only the EXIF Orientation entry is written, losslessly — afterwards the preview, enlarged view, new tab, registration form (Meldeschein) printout and OCR all show the photo the right way up. Staff only; the row is read RLS-bound AND with an explicit property filter, and the path comes from the database, never from the input. Every rotation is recorded in the stay's change history. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
uploadIdstringyes
sideenumyesOne of: front, back
richtungenumyesOne of: links, rechts

Output fields

FieldTypeRequiredNotes
orientierungintegeryes

checkin.saveGuestPhone

writes

PUBLIC — no auth. The guest enters a phone number in the portal (arrival time section). Reason, 2026-10-09: since 28 September 2026, Booking.com no longer passes phone numbers on to channel managers. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
tokenstringyes
telefonstringyes
zweckenumnoOne of: whatsapp, rueckfrage

Output fields

FieldTypeRequiredNotes
okbooleanyes

checkin.upcoming_without_session

read-only

List stays arriving in the next 14 days that have no checkin_session yet — i.e. guests who have not received a portal link. Use this to identify who needs a Pre-Arrival link sent before their arrival. Returns up to 50 rows ordered by check-in date ascending.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
staysarray of objectyes
stays.stayIdstringyes
stays.guestNamestring · nullableyes
stays.roomstring · nullableyes
stays.checkInstringyesISO 8601 date of arrival.
stays.checkOutstring · nullableyes

checkin.upsertMeldescheinEntry

writes

Create or update a guest's Meldeschein (German registration) entry.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
vornamestringyes
nachnamestringyes
geburtsdatumstringno
staatsangehoerigkeitstringno
ausweisartenumnoOne of: perso, reisepass, sonstiges
ausweisnummerstringno
anschriftStrassestringno
anschriftPlzstringno
anschriftOrtstringno
anschriftLandstringno
ankunftstringyes
abreisestringyes
bundeslandstringno

Output fields

The whole object may be null.

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
stayIdstringyes
vornamestringyes
nachnamestringyes
geburtsdatumstring · nullableyes
staatsangehoerigkeitstring · nullableyes
ausweisartstring · nullableyes
ausweisnummerstring · nullableyes
anschriftStrassestring · nullableyes
anschriftPlzstring · nullableyes
anschriftOrtstring · nullableyes
anschriftLandstring · nullableyes
ankunftstringyes
abreisestringyes
bundeslandstringyes
finalizedBystring · nullableyes
finalizedAtstring · nullableyes
createdAtstringyes