Home

Managing check-in requests

This section describes all the possible actions related to check-in requests for a property using the Online Check-in API.

A check-in request is created after a guest makes a reservation. It initially only contains basic data about the guest. The property can then decide whether to continue with the check-in online using the capabilities of this API.

Online check-in requests have the following restrictions:

  • [Coming soon] For properties in Spain, only solo guests reservations are eligible.
  • Multiple room reservations are not eligible.

Use case

To understand how you can use the check-in API, see the following high-level steps for its main usage:

  1. A guest makes a reservation.
  2. If the reservation is eligible, it triggers a check-in request to be created.
  3. You must 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 must update the specific check-in request with status DATA_REQUIRED.
  5. The guest receives an email with prompts for information, such as address, passport info, and other personal information details. (What these legal details are can change depending on the property's country.)
  6. You must retrieve the check-in requests again using status REQUESTED.
  7. The property can now choose to approve or deny the check-in.
  8. You must 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 confirmation email with information on how to access accommodation (unit).

Retrieving check-in requests per property

GET
https://supply-xml.booking.com/online-checkin-api/properties/{property_id}/checkins

The GET /properties/{property_id}/checkins request enables you to retrieve check-in requests per property. You can filter the results by status. If you do not specify status, you retrieve all check-in requests.

Requests disappear after two days

Two days after the check-in date the requests, regardless of status, will disappear. This means you can no longer retireve those via the API.

Path parameters

The following table describes what elements you must add in the request path:

Element Description Type Required/Optional Notes
property_id Specifies the id of the property you want to retrieve check-in requests for. string required

Query parameters

The following table describes what elements you can add as query parameters:

Element Description Type Required/Optional Notes
status Specifies the status of the check-in request. string optional Possible values are: CREATED, DATA_REQUIRED, REQUESTED, SUCCESS, and DENIED.
page Specifies the page you want to retrieve. string optional You must use the next_page value you retrieve in the first call.
page_size Specifies the amount of results you want to retrieve per page. integer optional The max amount is 100, while the default is 50.

Depending on the status, the response can look different. To understand what each status means and what the response looks like, see:

Response body example: CREATED

The following is a successful response body example:

{
    "meta": {
        "next_page": null,
        "ruid": "UmFuZG9tSVYkc2RlIyh9YZIKVTmyuvJEopiXyQsDmFd4J58SVMVHwtPNkOpmtbSps3LhEm/xZsY3mzqOf8oeYeEk0SNUIGXl"
    },
    "data": {
        "checkins": [
            {
                "checkout_date": "2021-01-06",
                "room_reservation_id": "3059621111",
                "reservation_id": "2459895331",
                "created_at": "2021-01-04T12:01:04Z",
                "status": "CREATED",
                "updated_at": "2021-01-04T12:01:04Z",
                "id": "a26137f65cc6da5fa188a1e4264e8951",
                "property_id": 6314570,
                "additional_guests": null,
                "room_access": null,
                "expected_arrival_time": null,
                "checkin_date": "2021-01-04",
                "main_guest": null
            }
        ]
    },
    "errors": [],
    "warnings": []
}

Response body elements: CREATED

The following table describes the response elements:

Element Description Type Notes
data Contains the response object. object
: checkins Contains the check-in requests. array
:: id Specifies the id of the check-in request. string You must use this id to retrieve or update a specific check-in request.
:: status Specifies the status of the check-in request. string Possible values are: CREATED, DATA_REQUIRED, REQUESTED, SUCCESS, and DENIED.
:: property_id Specifies the id of the property. string
:: reservation_id Specifies the id of the reservation. string
:: room_reservation_id Specifies the id of the room reservation. string
:: checkin_date Specifies the date that the guest checks in. string Follows the YYYY-MM-DD format.
:: checkout_date Specifies the date that the guest checks out. string Follows the YYYY-MM-DD format.
:: expected_arrival_time Specifies the time when the guest is estimated to arrive. string
:: main_guest Contains information on the main guest. object Value is null in status of CREATED.
:: additional_guests Contains information on guests other than the main guest . array Value is null in status of CREATED.
:: room_access Contains information on how to access the room. object Value is null in status of CREATED.
:: created_at Specifies the time the check-in request was created. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.
:: updated_at Specifies the time the check-in request was last updated. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.

Response body example: DATA_REQUIRED

The following is a successful response body example:

{
    "meta": {
        "next_page": null,
        "ruid": "UmFuZG9tSVYkc2RlIyh9YdHNYpIBVMRFymGkpUfNMKm8da8JWxrVQUijEHuN5PSvmX/YO9YR2EUD9ilhDr8nXe2X42P4iogW"
    },
    "warnings": [],
    "errors": [],
    "data": {
        "checkins": [
            {
                "room_access": null,
                "created_at": "2021-01-05T13:01:02Z",
                "reservation_id": "3169277768",
                "room_reservation_id": "3060341176",
                "additional_guests": null,
                "id": "3641359308ec7a0ce6ec69d4f5e63736",
                "expected_arrival_time": null,
                "status": "DATA_REQUIRED",
                "property_id": 6314570,
                "checkin_date": "2021-01-05",
                "main_guest": null,
                "checkout_date": "2021-01-06",
                "updated_at": "2021-01-05T13:02:26Z"
            }
        ]
    }
}

Response body elements: DATA_REQUIRED

The following table describes the response elements:

Element Description Type Notes
data Contains the response object. object
: checkins Contains the check-in requests. array
:: id Specifies the id of the check-in request. string You must use this id to retrieve or update a specific check-in request.
:: status Specifies the status of the check-in request. string Possible values are: CREATED, DATA_REQUIRED, REQUESTED, SUCCESS, and DENIED.
:: property_id Specifies the id of the property. string
:: reservation_id Specifies the id of the reservation. string
:: room_reservation_id Specifies the id of the room reservation. string
:: checkin_date Specifies the date that the guest checks in. string Follows the YYYY-MM-DD format.
:: checkout_date Specifies the date that the guest checks out. string Follows the YYYY-MM-DD format.
:: expected_arrival_time Specifies the time when the guest is estimated to arrive. string
:: main_guest Contains information on the main guest. object Value is null in status of DATA_REQUIRED.
:: additional_guests Contains information on guests other than the main guest . array Value is null in status of DATA_REQUIRED.
:: room_access Contains information on how to access the room. object Value is null in status of DATA_REQUIRED.
:: created_at Specifies the time the check-in request was created. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.
:: updated_at Specifies the time the check-in request was last updated. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.

Response body example: REQUESTED

The following is a successful response body example:

{
    "warnings": [],
    "meta": {
        "ruid": "UmFuZG9tSVYkc2RlIyh9YdHNYpIBVMRFqjAuCPAKsp1P6Z/tWWsCcSziB3Tme0yRNMb2fDk4E6qKopBzcnkhyT7FyinKDYrZ",
        "next_page": null
    },
    "data": {
        "checkins": [
            {
                "checkout_date": "2021-01-06",
                "room_reservation_id": "3060335333",
                "reservation_id": "2354460812",
                "property_id": 6314570,
                "additional_guests": [],
                "main_guest": {
                    "documents": [
                        {
                            "expiration_date": "2025-01-01",
                            "issuer_authority": null,
                            "issue_date": null,
                            "issue_city": null,
                            "identifier": "EN1111111",
                            "issue_country": null,
                            "type": "passport"
                        }
                    ],
                    "first_name": "John",
                    "birth_city": null,
                    "birthdate": "1995-05-05",
                    "signature": null,
                    "gender": "unknown",
                    "middle_name": null,
                    "last_name": "Doe",
                    "nationality": "ag",
                    "birth_country": null,
                    "email": "john.251501@guest.booking.com",
                    "address": {
                        "line2": "n.a.",
                        "city": "Amsterdam",
                        "line1": "Awesomestreet",
                        "zipcode": "1000AA",
                        "country": "nl"
                    }
                },
                "room_access": null,
                "status": "REQUESTED",
                "updated_at": "2021-01-05T12:57:23Z",
                "expected_arrival_time": null,
                "checkin_date": "2021-01-05",
                "created_at": "2021-01-05T12:48:59Z",
                "id": "af17b622ad618361346fee71ba25c0e5"
            }
        ]
    },
    "errors": []
}

Response body elements: REQUESTED

The following table describes the response elements:

Element Description Type Notes
data Contains the response object. object
: checkins Contains the check-in requests. array
:: id Specifies the id of the check-in request. string You must use this id to retrieve or update a specific check-in request.
:: status Specifies the status of the check-in request. string Possible values are: CREATED, DATA_REQUIRED, REQUESTED, SUCCESS, and DENIED.
:: property_id Specifies the id of the property. string
:: reservation_id Specifies the id of the reservation. string
:: room_reservation_id Specifies the id of the room reservation. string
:: checkin_date Specifies the date that the guest checks in. string Follows the YYYY-MM-DD format.
:: checkout_date Specifies the date that the guest checks out. string Follows the YYYY-MM-DD format.
:: expected_arrival_time Specifies the time when the guest is estimated to arrive. string
:: main_guest Contains information on the main guest. object
::: first_name Specifies the first name of the main guest. string
::: last_name Specifies the last name of the main guest. string
::: middle_name Specifies the middle name of the main guest. string
::: birthdate Specifies the birthdate of the main guest. string Follows the YYYY-MM-DD format.
::: birth_city Specifies the birth city of the main guest. string
::: nationality Specifies the nationality of the main guest. string Follows ISO 1366 country codes.
::: email Specifies the email of the main guest. string
::: address Contains the address information of the main guest. object
:::: city Specifies the city in which the main guest lives. string
:::: zipcode Specifies the zip code of the city in which the main guest lives. string
:::: country Specifies the country in which the main guest lives. string Follows ISO 1366 country codes.
:::: line1 Specifies the street in which the main guest lives. string
:::: line2 Specifies the secondary street information. string
::: documents Contains the travel document elements. array
:::: expiration_date Specifies the expiration date of the travel document. string
:::: identifier Specifies the id of the travel document. string
:::: type Specifies the type of the travel document. string
:::: issuer_authority Specifies the authority that issues the travel document. string
:::: issue_country Specifies the country that issues the travel document. string
:::: issue_date Specifies the date the travel document was issued. string
:::: issue_country Specifies the country that issues the travel document. string
:: additional_guests Contains information on guests other than the main guest . array
:: room_access Contains information on how to access the room. object Value is null in status of REQUESTED.
:: created_at Specifies the time the check-in request was created. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.
:: updated_at Specifies the time the check-in request was last updated. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.

Response body example: SUCCESS

The following is a successful response body example:

{
    "errors": [],
    "data": {
        "checkins": [
            {
                "room_access": {
                    "qrcode_content": null,
                    "premises_access_pin": "1234567890",
                    "additional_instructions": "2nd floor, go straight to the end, then turn left and find your room number.",
                    "front_desk_key_pickup": null,
                    "unit_access_pin": "12345",
                    "unit_label": "Room 550"
                },
                "main_guest": {
                    "documents": [
                        {
                            "issue_date": null,
                            "issue_country": null,
                            "type": "passport",
                            "issuer_authority": null,
                            "identifier": "EN1111111",
                            "expiration_date": "2024-01-01",
                            "issue_city": null
                        }
                    ],
                    "birth_country": null,
                    "email": "john.896623@guest.booking.com",
                    "birthdate": "1989-01-01",
                    "gender": "unknown",
                    "last_name": "Doe",
                    "nationality": "bz",
                    "first_name": "John",
                    "birth_city": null,
                    "address": {
                        "country": "be",
                        "line2": "n.a.",
                        "city": "Amsterdam",
                        "zipcode": "1000AA",
                        "line1": "Amsterdamweg 1"
                    },
                    "middle_name": null,
                    "signature": null
                },
                "created_at": "2021-01-04T10:15:57Z",
                "additional_guests": [],
                "room_reservation_id": "3059566484",
                "status": "SUCCESS",
                "updated_at": "2021-01-04T11:06:12Z",
                "reservation_id": "2439274132",
                "property_id": 6314570,
                "id": "3bc730645203599b704a53f4995ec89e",
                "expected_arrival_time": null,
                "checkout_date": "2021-01-05",
                "checkin_date": "2021-01-04"
            }
        ]
    },
    "meta": {
        "next_page": null,
        "ruid": "UmFuZG9tSVYkc2RlIyh9YYrCGLva4KjLLL+Q7nqOQ4gUQbRQnJY9kahtIhKsz/xd4S30MHTpyOTeHH5V3uuRMmpO7bBYUe2V"
    },
    "warnings": []
}

Response body elements: SUCCESS

The following table describes the response elements:

Element Description Type Notes
data Contains the response object. object
: checkins Contains the check-in requests. array
:: id Specifies the id of the check-in request. string You must use this id to retrieve or update a specific check-in request.
:: status Specifies the status of the check-in request. string Possible values are: CREATED, DATA_REQUIRED, REQUESTED, SUCCESS, and DENIED.
:: property_id Specifies the id of the property. string
:: reservation_id Specifies the id of the reservation. string
:: room_reservation_id Specifies the id of the room reservation. string
:: checkin_date Specifies the date that the guest checks in. string Follows the YYYY-MM-DD format.
:: checkout_date Specifies the date that the guest checks out. string Follows the YYYY-MM-DD format.
:: expected_arrival_time Specifies the time when the guest is estimated to arrive. string
:: main_guest Contains information on the main guest. object
::: first_name Specifies the first name of the main guest. string
::: last_name Specifies the last name of the main guest. string
::: middle_name Specifies the middle name of the main guest. string
::: birthdate Specifies the birthdate of the main guest. string Follows the YYYY-MM-DD format.
::: birth_city Specifies the birth city of the main guest. string
::: nationality Specifies the nationality of the main guest. string Follows ISO 1366 country codes.
::: email Specifies the email of the main guest. string
::: address Contains the address information of the main guest. object
:::: city Specifies the city in which the main guest lives. string
:::: zipcode Specifies the zip code of the city in which the main guest lives. string
:::: country Specifies the country in which the main guest lives. string Follows ISO 1366 country codes.
:::: line1 Specifies the street in which the main guest lives. string
:::: line2 Specifies the secondary street information. string
::: documents Contains the travel document elements. array
:::: expiration_date Specifies the expiration date of the travel document. string
:::: identifier Specifies the id of the travel document. string
:::: type Specifies the type of the travel document. string
:::: issuer_authority Specifies the authority that issues the travel document. string
:::: issue_country Specifies the country that issues the travel document. string
:::: issue_date Specifies the date the travel document was issued. string
:::: issue_country Specifies the country that issues the travel document. string
:: additional_guests Contains information on guests other than the main guest . array
:: room_access Contains information on how to access the room. object
:::: qrcode_content Specifies the QR code to enter the accommodation. string Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: premises_access_pin Specifies pin to access the accommodation. string Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: front_desk_key_pickup Inidicates whether the guest can pick up the key at the front desk. boolean Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: unit_access_pin Specifies pin to access the accommodation unit. string
:::: unit_label Specifies the label of the accommodation unit. string
:::: additional_instructions Specifies additional instruction regarding entering the accommodation (unit). string
:: created_at Specifies the time the check-in request was created. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.
:: updated_at Specifies the time the check-in request was last updated. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.

Response body example: DENIED

The following is a successful response body example:

{
    "errors": [],
    "data": {
        "checkins": [
            {
                "room_access": {
                    "qrcode_content": null,
                    "premises_access_pin": null,
                    "additional_instructions": null,
                    "front_desk_key_pickup": null,
                    "unit_access_pin": null,
                    "unit_label": null
                },
                "main_guest": {
                    "documents": [
                        {
                            "issue_date": null,
                            "issue_country": null,
                            "type": "passport",
                            "issuer_authority": null,
                            "identifier": "EN1111111",
                            "expiration_date": "2024-01-01",
                            "issue_city": null
                        }
                    ],
                    "birth_country": null,
                    "email": "john.896623@guest.booking.com",
                    "birthdate": "1989-01-01",
                    "gender": "unknown",
                    "last_name": "Doe",
                    "nationality": "bz",
                    "first_name": "John",
                    "birth_city": null,
                    "address": {
                        "country": "be",
                        "line2": "n.a.",
                        "city": "Amsterdam",
                        "zipcode": "1000AA",
                        "line1": "Amsterdamweg 1"
                    },
                    "middle_name": null,
                    "signature": null
                },
                "created_at": "2021-01-04T10:15:57Z",
                "additional_guests": [],
                "room_reservation_id": "3059566484",
                "status": "SUCCESS",
                "updated_at": "2021-01-04T11:06:12Z",
                "reservation_id": "2439274132",
                "property_id": 6314570,
                "id": "3bc730645203599b704a53f4995ec89e",
                "expected_arrival_time": null,
                "checkout_date": "2021-01-05",
                "checkin_date": "2021-01-04"
            }
        ]
    },
    "meta": {
        "next_page": null,
        "ruid": "UmFuZG9tSVYkc2RlIyh9YYrCGLva4KjLLL+Q7nqOQ4gUQbRQnJY9kahtIhKsz/xd4S30MHTpyOTeHH5V3uuRMmpO7bBYUe2V"
    },
    "warnings": []
}

Response body elements: DENIED

The following table describes the response elements:

Element Description Type Notes
data Contains the response object. object
: checkins Contains the check-in requests. array
:: id Specifies the id of the check-in request. string You must use this id to retrieve or update a specific check-in request.
:: status Specifies the status of the check-in request. string Possible values are: CREATED, DATA_REQUIRED, REQUESTED, SUCCESS, and DENIED.
:: property_id Specifies the id of the property. string
:: reservation_id Specifies the id of the reservation. string
:: room_reservation_id Specifies the id of the room reservation. string
:: checkin_date Specifies the date that the guest checks in. string Follows the YYYY-MM-DD format.
:: checkout_date Specifies the date that the guest checks out. string Follows the YYYY-MM-DD format.
:: expected_arrival_time Specifies the time when the guest is estimated to arrive. string
:: main_guest Contains information on the main guest. object
::: first_name Specifies the first name of the main guest. string
::: last_name Specifies the last name of the main guest. string
::: middle_name Specifies the middle name of the main guest. string
::: birthdate Specifies the birthdate of the main guest. string Follows the YYYY-MM-DD format.
::: birth_city Specifies the birth city of the main guest. string
::: nationality Specifies the nationality of the main guest. string Follows ISO 1366 country codes.
::: email Specifies the email of the main guest. string
::: address Contains the address information of the main guest. object
:::: city Specifies the city in which the main guest lives. string
:::: zipcode Specifies the zip code of the city in which the main guest lives. string
:::: country Specifies the country in which the main guest lives. string Follows ISO 1366 country codes.
:::: line1 Specifies the street in which the main guest lives. string
:::: line2 Specifies the secondary street information. string
::: documents Contains the travel document elements. array
:::: expiration_date Specifies the expiration date of the travel document. string
:::: identifier Specifies the id of the travel document. string
:::: type Specifies the type of the travel document. string
:::: issuer_authority Specifies the authority that issues the travel document. string
:::: issue_country Specifies the country that issues the travel document. string
:::: issue_date Specifies the date the travel document was issued. string
:::: issue_country Specifies the country that issues the travel document. string
:: additional_guests Contains information on guests other than the main guest . array
:: room_access Contains information on how to access the room. object
:::: qrcode_content Specifies the QR code to enter the accommodation. string Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: premises_access_pin Specifies pin to access the accommodation. string Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: front_desk_key_pickup Inidicates whether the guest can pick up the key at the front desk. boolean Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: unit_access_pin Specifies pin to access the accommodation unit. string
:::: unit_label Specifies the label of the accommodation unit. string
:::: additional_instructions Specifies additional instruction regarding entering the accommodation (unit). string
:: created_at Specifies the time the check-in request was created. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.
:: updated_at Specifies the time the check-in request was last updated. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.

Updating a check-in request

PUT
https://supply-xml.booking.com/online-checkin-api/properties/{property_id}/checkins/{check-in_id}

The PUT /properties/{property_id}/checkins/{check-in_id} request enables you to update check-in requests. You can update a check-in request in the following ways:

  • DATA_REQUIRED: Request currently has status CREATED, which means the property has a reservation for which online check-ins are possible. Setting this status triggers an email to be sent to the guest to retrieve the required information (dependent on country) by enabling the guest to check in online.

  • SUCCESS: Request currently has status REQUESTED, which mean the property approves the online check-in and optionally sends information on how to access the accommodation (unit).

  • DENIED: Request currently has status REQUESTED, which means the property denies the online check-in.

Path parameters

The following table describes what elements you must add in the request path:

Element Description Type Required/Optional Notes
property_id Specifies the id of the property you want to retrieve check-in requests for. string required

Body parameters

The following table describes what elements you can add as query parameters:

Element Description Type Required/Optional Notes
status Specifies the status of the check-in request. string required Possible values are: DATA_REQUIRED, SUCCESS, and DENIED. For DATA_REQUIRED and DENIED you must use only this body parameter.
room_access Contains the accommodation access elements. object required
: qrcode_content Specifies the QR code to enter the accommodation. string required* One of the following three values is required (more than one is not possible): qrcode_content, premises_access_pin, or front_desk_key_pickup.
: premises_access_pin Specifies pin to access the accommodation. string required* One of the following three values is required (more than one is not possible): qrcode_content, premises_access_pin, or front_desk_key_pickup.
: front_desk_key_pickup Inidicates whether the guest can pick up the key at the front desk. boolean required* One of the following three values is required (more than one is not possible): qrcode_content, premises_access_pin, or front_desk_key_pickup.
: unit_access_pin Specifies pin to access the accommodation unit. string
: unit_label Specifies the label of the accommodation unit. string
: additional_instructions Specifies additional instruction regarding entering the accommodation (unit). string

Request body example: DATA_REQUIRED

The following is a successful request body example:

{
    "status": "DATA_REQUIRED"
}

Request body example: SUCCESS

The following is a successful request body example:

{
    "status": "SUCCESS",
    "room_access": {
        "premises_access_pin": "1234567890",
        "unit_access_pin": "12345",
        "unit_label": "Room 550",
        "additional_instructions": "2nd floor, go straight to the end, then turn left and find your room number."
    }
}

Request body example: DENIED

The following is a successful request body example:

{
    "status": "DENIED"
}

Response body example: DATA_REQUIRED

The following is a successful response body example:

{
    "warnings": [],
    "data": {
        "expected_arrival_time": null,
        "additional_guests": null,
        "property_id": 6314570,
        "room_reservation_id": "3060335376",
        "room_access": null,
        "id": "5ca8d53a69267a6d383687df840439ab",
        "checkin_date": "2021-01-05",
        "status": "DATA_REQUIRED",
        "checkout_date": "2021-01-06",
        "created_at": "2021-01-05T12:49:00Z",
        "main_guest": null,
        "updated_at": "2021-01-05T12:49:00Z",
        "reservation_id": "2865149165"
    },
    "meta": {
        "ruid": "UmFuZG9tSVYkc2RlIyh9YYrCGLva4KjLpuUdyffqcDcRfAxi9pKPLbrRp5+FvYqtFU4X9l6hYqyL6aaxBT26pXRV5Iemv7+3"
    },
    "errors": []
}

Response body elements: DATA_REQUIRED

The following table describes the response elements:

Element Description Type Notes
data Contains the response object. object
: checkins Contains the check-in requests. array
:: id Specifies the id of the check-in request. string You must use this id to retrieve or update a specific check-in request.
:: status Specifies the status of the check-in request. string Possible values are: CREATED, DATA_REQUIRED, REQUESTED, SUCCESS, and DENIED.
:: property_id Specifies the id of the property. string
:: reservation_id Specifies the id of the reservation. string
:: room_reservation_id Specifies the id of the room reservation. string
:: checkin_date Specifies the date that the guest checks in. string Follows the YYYY-MM-DD format.
:: checkout_date Specifies the date that the guest checks out. string Follows the YYYY-MM-DD format.
:: expected_arrival_time Specifies the time when the guest is estimated to arrive. string
:: main_guest Contains information on the main guest. object Value is null in status of DATA_REQUIRED.
:: additional_guests Contains information on guests other than the main guest . array Value is null in status of DATA_REQUIRED.
:: room_access Contains information on how to access the room. object Value is null in status of DATA_REQUIRED.
:: created_at Specifies the time the check-in request was created. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.
:: updated_at Specifies the time the check-in request was last updated. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.

Response body example: SUCCESS

The following is a successful response body example:

{
    "meta": {
        "ruid": "UmFuZG9tSVYkc2RlIyh9YYrCGLva4KjLy4IJ0KBuafppRHkaFfW9UoTODRK75igo9NzEXVY6QUg3jTI2HVKP7whIbTJbx1Dk"
    },
    "data": {
        "checkin_date": "2021-01-05",
        "reservation_id": "2865149165",
        "room_reservation_id": "3060335376",
        "property_id": 6314570,
        "status": "SUCCESS",
        "updated_at": "2021-01-05T16:40:42Z",
        "created_at": "2021-01-05T12:49:00Z",
        "id": "5ca8d53a69267a6d383687df840439ab",
        "expected_arrival_time": null,
        "room_access": {
            "premises_access_pin": "1234567890",
            "unit_access_pin": "12345",
            "unit_label": "Room 550",
            "additional_instructions": "2nd floor, go straight to the end, then turn left and find your room number.",
            "qrcode_content": null,
            "front_desk_key_pickup": null
        },
        "main_guest": {
            "signature": null,
            "last_name": "Janssens",
            "birth_city": null,
            "birthdate": "1946-07-11",
            "first_name": "Luca",
            "birth_country": null,
            "nationality": "ai",
            "gender": "unknown",
            "middle_name": null,
            "documents": [],
            "address": {
                "line1": "H.J.E. Wenckebachweg, 6 V15",
                "country": "be",
                "city": "Amsterdam",
                "zipcode": "1096AN",
                "line2": "n.a."
            },
            "email": "ljanss.991164@guest.booking.com"
        },
        "checkout_date": "2021-01-06",
        "additional_guests": []
    },
    "warnings": [],
    "errors": []
}

Response body elements: SUCCESS

The following table describes the response elements:

Element Description Type Notes
data Contains the response object. object
: checkins Contains the check-in requests. array
:: id Specifies the id of the check-in request. string You must use this id to retrieve or update a specific check-in request.
:: status Specifies the status of the check-in request. string Possible values are: CREATED, DATA_REQUIRED, REQUESTED, SUCCESS, and DENIED.
:: property_id Specifies the id of the property. string
:: reservation_id Specifies the id of the reservation. string
:: room_reservation_id Specifies the id of the room reservation. string
:: checkin_date Specifies the date that the guest checks in. string Follows the YYYY-MM-DD format.
:: checkout_date Specifies the date that the guest checks out. string Follows the YYYY-MM-DD format.
:: expected_arrival_time Specifies the time when the guest is estimated to arrive. string
:: main_guest Contains information on the main guest. object
::: first_name Specifies the first name of the main guest. string
::: last_name Specifies the last name of the main guest. string
::: middle_name Specifies the middle name of the main guest. string
::: birthdate Specifies the birthdate of the main guest. string Follows the YYYY-MM-DD format.
::: birth_city Specifies the birth city of the main guest. string
::: nationality Specifies the nationality of the main guest. string Follows ISO 1366 country codes.
::: email Specifies the email of the main guest. string
::: address Contains the address information of the main guest. object
:::: city Specifies the city in which the main guest lives. string
:::: zipcode Specifies the zip code of the city in which the main guest lives. string
:::: country Specifies the country in which the main guest lives. string Follows ISO 1366 country codes.
:::: line1 Specifies the street in which the main guest lives. string
:::: line2 Specifies the secondary street information. string
::: documents Contains the travel document elements. array
:::: expiration_date Specifies the expiration date of the travel document. string
:::: identifier Specifies the id of the travel document. string
:::: type Specifies the type of the travel document. string
:::: issuer_authority Specifies the authority that issues the travel document. string
:::: issue_country Specifies the country that issues the travel document. string
:::: issue_date Specifies the date the travel document was issued. string
:::: issue_country Specifies the country that issues the travel document. string
:: additional_guests Contains information on guests other than the main guest . array
:: room_access Contains information on how to access the room. object
:::: qrcode_content Specifies the QR code to enter the accommodation. string Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: premises_access_pin Specifies pin to access the accommodation. string Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: front_desk_key_pickup Inidicates whether the guest can pick up the key at the front desk. boolean Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: unit_access_pin Specifies pin to access the accommodation unit. string
:::: unit_label Specifies the label of the accommodation unit. string
:::: additional_instructions Specifies additional instruction regarding entering the accommodation (unit). string
:: created_at Specifies the time the check-in request was created. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.
:: updated_at Specifies the time the check-in request was last updated. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.

Response body example: DENIED

The following is a successful response body example:

{
    "meta": {
        "ruid": "UmFuZG9tSVYkc2RlIyh9YYrCGLva4KjLy4IJ0KBuafppRHkaFfW9UoTODRK75igo9NzEXVY6QUg3jTI2HVKP7whIbTJbx1Dk"
    },
    "data": {
        "checkin_date": "2021-01-05",
        "reservation_id": "2865149165",
        "room_reservation_id": "3060335376",
        "property_id": 6314570,
        "status": "SUCCESS",
        "updated_at": "2021-01-05T16:40:42Z",
        "created_at": "2021-01-05T12:49:00Z",
        "id": "5ca8d53a69267a6d383687df840439ab",
        "expected_arrival_time": null,
        "room_access": {
            "premises_access_pin": null,
            "unit_access_pin": null,
            "unit_label": null,
            "additional_instructions": null,
            "qrcode_content": null,
            "front_desk_key_pickup": null
        },
        "main_guest": {
            "signature": null,
            "last_name": "Janssens",
            "birth_city": null,
            "birthdate": "1946-07-11",
            "first_name": "Luca",
            "birth_country": null,
            "nationality": "ai",
            "gender": "unknown",
            "middle_name": null,
            "documents": [],
            "address": {
                "line1": "H.J.E. Wenckebachweg, 6 V15",
                "country": "be",
                "city": "Amsterdam",
                "zipcode": "1096AN",
                "line2": "n.a."
            },
            "email": "ljanss.991164@guest.booking.com"
        },
        "checkout_date": "2021-01-06",
        "additional_guests": []
    },
    "warnings": [],
    "errors": []
}

Response body elements: DENIED

The following table describes the response elements:

Element Description Type Notes
data Contains the response object. object
: checkins Contains the check-in requests. array
:: id Specifies the id of the check-in request. string You must use this id to retrieve or update a specific check-in request.
:: status Specifies the status of the check-in request. string Possible values are: CREATED, DATA_REQUIRED, REQUESTED, SUCCESS, and DENIED.
:: property_id Specifies the id of the property. string
:: reservation_id Specifies the id of the reservation. string
:: room_reservation_id Specifies the id of the room reservation. string
:: checkin_date Specifies the date that the guest checks in. string Follows the YYYY-MM-DD format.
:: checkout_date Specifies the date that the guest checks out. string Follows the YYYY-MM-DD format.
:: expected_arrival_time Specifies the time when the guest is estimated to arrive. string
:: main_guest Contains information on the main guest. object
::: first_name Specifies the first name of the main guest. string
::: last_name Specifies the last name of the main guest. string
::: middle_name Specifies the middle name of the main guest. string
::: birthdate Specifies the birthdate of the main guest. string Follows the YYYY-MM-DD format.
::: birth_city Specifies the birth city of the main guest. string
::: nationality Specifies the nationality of the main guest. string Follows ISO 1366 country codes.
::: email Specifies the email of the main guest. string
::: address Contains the address information of the main guest. object
:::: city Specifies the city in which the main guest lives. string
:::: zipcode Specifies the zip code of the city in which the main guest lives. string
:::: country Specifies the country in which the main guest lives. string Follows ISO 1366 country codes.
:::: line1 Specifies the street in which the main guest lives. string
:::: line2 Specifies the secondary street information. string
::: documents Contains the travel document elements. array
:::: expiration_date Specifies the expiration date of the travel document. string
:::: identifier Specifies the id of the travel document. string
:::: type Specifies the type of the travel document. string
:::: issuer_authority Specifies the authority that issues the travel document. string
:::: issue_country Specifies the country that issues the travel document. string
:::: issue_date Specifies the date the travel document was issued. string
:::: issue_country Specifies the country that issues the travel document. string
:: additional_guests Contains information on guests other than the main guest . array
:: room_access Contains information on how to access the room. object
:::: qrcode_content Specifies the QR code to enter the accommodation. string Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: premises_access_pin Specifies pin to access the accommodation. string Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: front_desk_key_pickup Inidicates whether the guest can pick up the key at the front desk. boolean Entering the accommodation can happen in only one of the following ways: qrcode_content, premises_access_pin, or front_desk_key_pickup.
:::: unit_access_pin Specifies pin to access the accommodation unit. string
:::: unit_label Specifies the label of the accommodation unit. string
:::: additional_instructions Specifies additional instruction regarding entering the accommodation (unit). string
:: created_at Specifies the time the check-in request was created. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.
:: updated_at Specifies the time the check-in request was last updated. string Follows the ISO 8601 standard in UTC: YYYY-MM-DDThh:mm:ss.mmmZ.
Is this page helpful?    Yes   |    No