Skip to main content
Yardo Docs home page
Search...
⌘K
Support
Dashboard
Dashboard
Search...
Navigation
Public Check-In
Get status/instructions for a kiosk exception
Documentation
API Reference
Carrier Portal
GET
List carrier appointments
POST
Create a carrier appointment request
GET
List past carrier appointments
GET
Get carrier appointment details
GET
List documents for an appointment
POST
Upload a document for an appointment
DEL
Delete a document for an appointment
POST
Submit carrier claim request
GET
Get carrier profile
GET
List current user's carrier claims (v2)
POST
Submit a carrier claim (v2)
GET
List pending carrier member requests for carrier admins
GET
List carrier team members for carrier admins
GET
List carrier team invitations for carrier admins
POST
Invite a user to the carrier team
DEL
Cancel a carrier team invitation
POST
Resend a carrier team invitation
GET
Get carrier claim details (v2)
POST
Update claim contact email and restart automatic verification
POST
Request carrier claim email verification (v2)
POST
Upload a carrier claim verification document (v2)
DEL
Delete current carrier claim verification document (v2)
POST
Respond to carrier claim info request (v2)
POST
Approve pending carrier member claim (carrier admin)
POST
Accept carrier team invitation
GET
Complete carrier claim email verification (v2)
POST
Upload a document for a booking (tracking ID)
GET
List carrier portal appointments (by email or approved carrier claim)
GET
Get carrier portal appointment details
PATCH
Update permitted appointment fields
POST
Cancel appointment (hybrid)
GET
Get carrier portal appointment status history
GET
List carrier portal appointment cancellation requests
GET
List appointment documents
POST
Upload appointment document
DEL
Delete appointment document
GET
List appointment document requirements and status
GET
List reschedule requests for an appointment
POST
Create reschedule request (facility-reviewed)
GET
Get appointment message thread
POST
Mint a realtime ticket for appointment thread updates
POST
Post message to appointment thread
GET
Browse discoverable facilities
POST
Request access/invite for a facility
GET
List carriers linked to the portal user
POST
Create a carrier profile for the portal user
GET
Get selected carrier profile settings
PATCH
Update selected carrier profile settings
GET
Get the active view preference for the current portal user
PATCH
Update the last-used view preference for the current portal user
GET
List saved views for the current portal user
POST
Create a saved view for the current portal user
DEL
Delete a saved view for the current portal user
PATCH
Update a saved view for the current portal user
GET
List carrier fleet drivers
POST
Create carrier fleet driver
PATCH
Update carrier fleet driver
GET
List carrier fleet assets
POST
Create carrier fleet asset
PATCH
Update carrier fleet asset
PATCH
Assign or clear appointment resources
GET
Get driver SMS consent status during assignment
POST
Request or resend driver SMS consent during assignment
POST
Bulk assign or clear appointment resources
AnonymousBooking
POST
Post portalbookings
POST
Post portalbookingsauthenticated
POST
Post portalbookingsotprequest
POST
Post portalbookingsotpverify
GET
Get portalbookings
GET
Get portallocations booking settings
POST
Post portallocations carrier verification
GET
Get portallocations allowlist status
POST
Post portallocations carrier access requests
GET
Get portallocations carrier access requestsstatus
POST
Post portallocations invite requests
GET
Get portallocations invite requestsstatus
GET
Get portallocations availability
EmailVerification
GET
Get portalverify
InviteLink
GET
Get portalinvite
Public Check-In
GET
Validate check-in token and get appointment details
POST
Confirm driver arrival
GET
Get appointment status for a driver session
POST
Renew a driver session token
POST
Issue a driver session token using a check-in token (view-only)
GET
Get location context for kiosk check-in
POST
Lookup an appointment (no operational side effects on failure)
POST
Confirm driver intent (creates or updates a single exception)
POST
Upload an optional attachment for a kiosk help request
GET
Get status/instructions for a kiosk exception
Get status/instructions for a kiosk exception
cURL
Copy
curl
--request
GET
\
--url
https://api.example.com/checkin/kiosk/exceptions/{exceptionId}
Public Check-In
Get status/instructions for a kiosk exception
Copy page
Copy page
GET
/
checkin
/
kiosk
/
exceptions
/
{exceptionId}
Try it
Get status/instructions for a kiosk exception
cURL
Copy
curl
--request
GET
\
--url
https://api.example.com/checkin/kiosk/exceptions/{exceptionId}
Path Parameters
exceptionId
string
required
Response
200 - undefined
Upload an optional attachment for a kiosk help request
⌘I