request_booking
Submit a booking request — a lead, NOT a confirmed appointment; the notary follows up. Use when ready to book AND the customer is not signed in; a signed-in customer goes through book_appointment instead. Requires: service (e.g. office, mobile, loan), the FULL LEGAL NAME as on government ID, and an email or phone (collect both). Pass the chosen startUnix from search_availability as desired_time_unix; to modify an open request pass existing_reference, never a duplicate. Returns a reference for check_request_status; fails if the name or a valid contact is missing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The customer's FULL LEGAL NAME exactly as on their government-issued ID (never a nickname or chat display name) — notarial records and apostille filings print it. Ask if you only know a first name. | |
| No | Email. Collect BOTH an email AND a phone in one question when possible; at least one is required. | ||
| notes | No | Anything else the notary should know. | |
| phone | No | Phone with country code (e.g. +1...). The notary confirms fastest by phone/SMS — ask for it even when an email is known. | |
| address | No | Meeting address — MOBILE ONLY. Office and apostille visits automatically use our Bothell office; omit this for them. | |
| service | Yes | Service: office | mobile | apostille | loan. | |
| desired_time | No | The wanted time in plain words, when no exact slot was chosen (rides the notes; the notary confirms a real time). | |
| document_count | No | Number of documents. Default 1. | |
| desired_time_unix | No | The chosen slot's `startUnix` from search_availability (Unix seconds). Pass it so the request carries the exact wanted time — still a request, never a hold. | |
| existing_reference | No | To ADD to or change an EXISTING request instead of creating a second one (e.g. "also apostille it", "make it 3 documents"), pass that request's reference id here — the same email/phone must be provided so we can verify it's the same customer. Nothing new is created. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| status | No | Account tools: the booking's status after this call (Pending after book_appointment). | |
| message | Yes | Customer-facing outcome; relay it as written — bookings are requests until the notary confirms. | |
| manageUrl | No | Guest requests: the emailed confirm/cancel link, when one was minted (null otherwise). | |
| onAccount | No | True when the request was filed on the signed-in customer's own account — they can then list it with my_bookings and change it with reschedule_booking / cancel_booking. Absent or false means a guest request, managed through the emailed link. | |
| reference | No | Request / order reference for check_request_status (guest tools) or my_bookings (account tools). | |
| appendedToExisting | No | True when existing_reference was given and the request was extended, not duplicated. | |
| ourComparableQuoteCents | No | request_price_match only, when computable. |