Partner API
Connect your platform to Vivestay
For property-management systems, hospitality platforms and integration partners who work with Vivestay customers. Your platform keeps running the booking; Vivestay takes care of the guest registration — and lets your platform know when it is done.
What your platform can do
From booking to registered guest
-
Create registrations from bookings
Send a booking to Vivestay and it becomes a guest registration for the right property, identified by your own booking reference.
-
Issue the guest link
Receive a secure check-in link for the guest when the registration is created, and issue a fresh one whenever it is needed again.
-
Keep bookings in step
Pass on changes to dates, arrival time or party size. A registration the guest has already completed is never overwritten.
-
Check where things stand
Look up any registration by your booking reference to see its status and whether everything required has been provided.
-
Hear when a guest completes
Vivestay notifies your platform when a guest completes registration. Notifications are signed so you can verify them, retried if your platform is briefly unavailable, and recorded so every delivery can be reviewed.
-
Follow authority reporting
Where the customer reports stays to the authorities through Vivestay, your platform can see how each report is progressing.
Information flow
What goes in, what comes back
-
What your platform sends
Your booking reference, the Vivestay property, arrival and departure dates, and — where you have them — the arrival time, party size and the booking holder’s name and contact details.
-
What Vivestay returns
The registration’s status, whether its requirements are met and, when you ask for it, the secure guest link.
-
Identity stays with the guest
Guests provide their identity details to Vivestay directly, through their own secure link. Your platform never has to collect passports or ID documents.
-
One booking, one registration
Each booking reference maps to exactly one registration, so sending the same booking twice never creates a duplicate.
Typical integrations
How partners use it
-
Check-in link at booking
A property-management system creates the registration as soon as a booking is confirmed and includes the guest link in its own booking messages.
-
Registered status beside each arrival
A hospitality platform shows which arrivals are already registered, updated the moment a guest completes.
-
A check before arrival day
An integration partner reviews upcoming stays and follows up on the registrations that are still open.
Connect your booking software
Ready-made connections, no development
Vivestay customers can also connect their booking software directly in Vivestay, without any integration work.
-
OwnerRez
Bookings, changes and cancellations flow in from OwnerRez automatically once the customer connects their account.
-
iCal calendars
Any calendar that publishes an iCal feed can be synced in, so its bookings appear in Vivestay.
Access and prerequisites
The Partner API works on behalf of a Vivestay customer. The customer’s administrator gives your platform its own access from the Vivestay console, limited to integration work, and can revoke it at any time. There is no separate developer sign-up.
The customer’s properties are set up in Vivestay, and bookings are connected to them; the Partner API does not create properties from bookings. Reporting to the authorities remains the customer’s own action inside Vivestay.
Technical integration documentation is available to integration partners: contact us and choose “Partnership or integration”.
Planning an integration?
Tell us about your platform and the customers you serve, and we will share the technical documentation and help you get connected.