Understanding the Check-in API

The Check-in API enables you to let properties manage online check-ins together with Booking.com. A check-in request is created when a guest makes a reservation. Which information is legally required for a guest to check in depends on the country.

→ To onboard or add properties to enable them to use the online check-in flow, you must add them first using the onboarding endpoint

What is possible with the Check-in API?

You can retrieve check-in requests as soon as they are created. The API also makes the following possible:

  • Retrieve all existing check-in requests by status: CREATED, DATA_REQUIRED, REQUESTED, SUCCESS, and DENIED.
  • Require more information of a guest to check in by updating the check-in request: This triggers an email to be sent to the guest by Booking.com to check in online.
  • Accept (SUCCESS) or reject (DENIED) an online check-in by the guest.
  • Send information to the guest on how to access the property (or room).

How does the Check-in API work?

You must choose to work with one of the following flows:

  • Control flow: The property can decide which guests (reservations) are eligible to do an online check-in. For example, property wants to only enable guests with pre-paid reservations to check in online.
  • Automated flow: The property automates the check-in flow by enabling all guests with a reservation to do an online check-in. If needed, the property can still reject an online check-in.

The automated flow is the default flow. If you want to change to the control flow, contact the Connectivity support team.

Control flow

To understand how the control flow works on a high level, see:

  1. A guest makes a reservation.
  2. Eligible reservations trigger a check-in request to be created.
  3. You retrieve available check-in requests by querying /properties/{property_id}/checkins using status CREATED.
  4. The property wants to enable online check-in, but requires more information from the guest. Therefore, you update the specific check-in requests with status DATA_REQUIRED.
  5. The guest receives an email with prompts for information, such as address, passport info, and other personal information details. These (legal) details depend on the country of the property.
  6. You retrieve the check-in requests again using status REQUESTED.
  7. The property can now choose to approve or deny the check-in.
  8. You update the check-in request with either status SUCCESS to approve the check-in or DENY to cancel. In case of SUCCESS, you must provide instructions to access the accommodation (unit).
  9. The guest receives email with information on how to access accommodation (unit).

Automated flow

To understand how the automated flow works on a high level, see:

  1. A guest makes a reservation.
  2. The guest receives an email with prompts for information, such as address, passport info, and other personal information details. These (legal) details depend on the country of the property.
  3. You retrieve the check-in requests using status REQUESTED.
  4. The property can now choose to approve or deny the check-in.
  5. You update the check-in request with either status SUCCESS to approve the check-in or DENY to cancel. In case of SUCCESS, you must provide instructions to access the accommodation (unit).
  6. The guest receives email with information on how to access accommodation (unit).

Main URL and use of shortened endpoint paths

The Online Check-in API's main URL is https://supply-xml.booking.com/online-checkin-api. All shortened endpoint paths imply that you must add the main URL. For example: /properties/{Property_id}/checkins becomes https://supply-xml.booking.com/online-checkin-api/properties/{Property_id}/checkins in an actual request.

Authentication

The Online Check-in API uses the same authentication methods as other APIs.