Welcome to CheKin’s API integration guide for guest registration + Legal compliance.
Connecting your API with Chekin API will allow your company to send each guest required information automatically to the legal authorities.
The overall results after successfully integrate Chekin APIs within your system will result in:
- Being able to provide a web app formulary to your guests so they can register themselves and even offer them an Optical Character Reader (OCR) for quick and easy capture of documents information.
- Let your property managers use a “PM dashboard” to check the status of each reservation and fix any errors while registering their guests into security forces.
- Learn how your company can monitor everything that is going on while registering all the property owners guests, at a country and at a client level using a web dashboard to better support property owners.
To start, choose how would you like to integrate our API, if you prefer to do it natively in your system or just let us connect your APIs with Chekin APIs and use our default User Interfaces and products so you don’t need to build any of those products within your system
First, you would have to choose one of the 2 integration methods:
1.- Chekin API Native integration
2.- Chekin API + User Interfaces/Products
So let’s get started!
We provide a set of REST APIs that you can use to extract guests data (OCR service) from personal documents and to send it to the authorities of each region/country.
The integration is natively built within your system, with your own UI/UX to provide the best user experience.
Solutions Available on the API:
- Police/Stats + Legal compliance
- API service to be 100% legal compliance
- See also: integration guide
- OCR web and mobile
- API service to capture Guest IDs from a photo (Passport, ID cards..)
- See also: integration guide
- Tourist Taxes calculator
- API service to calculate tourist taxes on every EU country/region
- See also: CheKin Taxes API
- See also: integration guide
- Biometric Matching
- API service for self check-ins
- See also: integration guide
- Online Check In
- Built-in product to capture guests data
- Share a link with your guests. They open a web form and complete their data.
- OCR is included to allow guests scanning their document
- See also: integration guide
CheKin APIs
The CheKin API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application.
CheKin API accepts data as JSON or also as multipart/form-data. JSON is returned by all API responses, including errors.
The base url for CheKin API endpoints is https://a.chekin.io/api/v3/
You can see more details in CheKin API Documentation
CheKin API + CheKin User Interfaces integrated with your PMS API:
We integrate with your API and provide all the UI/UX needed, to collect guests data, and to monitor police registration status.
Using your API and webhooks, we detect new reservations and we send an email to the main Guest.
Chekin Online
The flow starts when a new reservation is created. CheKin uses PMS webhooks to detect it and get reservation details like check-in date, number of guests, and the email of the main guest. After that CheKin sends an email to the guest with a linked button inside. If you want to send the email yourself, you can do it too. You can get the chekin online link related to a reservation using our API, and disable the automatic email sending at Chekin.
When the guest clicks on the button the guest is redirected to CheKin Online web app and he is asked to enter the required data like document number, birth date, and so on. After the guest enters his data CheKin sends it to the required authorities, on time, to accomplish legal compliance. Finally, Chekin notifies back the PMS about the status. Webhooks are available too.
The final integration flow between both systems is defined and agreed with you.