Key Collection API - Check-In Methods Description
This section describes the available check-in methods and information about them.
additional_info structure
The actual structure of additional_info depends on the name the of check-in method. See structures below for each type.
Method names: reception, someone_will_meet, secret_spot
Structure for above 3 methods is the same
| Field | Subfield | Type | Description | Example |
|---|---|---|---|---|
| other_text | Object | Object containing additional text. | { "lang": "en", "text": "The reception is open 24/7." } | |
| lang | String | Language Code from table BCL | en | |
| text | String | The text field | The reception is open 24/7. | |
| location | Object | Object containing additional information about check-in location. Depending in method name, location might refer to: reception location, place to meet someone or secret spot with the keys. | { "lang": "en", "text": "The reception is open 24/7." } | |
| off_location | Flag (0, 1) | A flag indicating that check-in must be done somewhere outside of property | 1 | |
| address | String | Address of the check-in location. Only provided if off_location = 1. | Herengracht 597 | |
| city | String | City of the check-in location. Only provided if off_location = 1. | Amsterdam | |
| zip | String | Zip code of the check-in location. Only provided if off_location = 1. | 1017CE | |
| place_id | String | The Google Maps Id of the check-in location. Only provided if off_location = 1. | The reception is open 24/7. |
Method name: door_code
Method-specific fields
| Field | Subfield | Type | Description | Example |
|---|---|---|---|---|
| other_text | Object | Object containing additional text. | { "lang": "en", "text": "The reception is open 24/7." } | |
| lang | String | Language Code from table BCL | en | |
| text | String | The text field | The reception is open 24/7. | |
| brand_name | String | The brand name of the lock box or door code device that you’re using | The Forever Lock |
Method name: lock_box
Method-specific fields
| Field | Subfield | Type | Description | Example |
|---|---|---|---|---|
| other_text | Object | Object containing additional text. | { "lang": "en", "text": "The reception is open 24/7." } | |
| lang | String | Language Code from table BCL | en | |
| text | String | The text field | The reception is open 24/7. | |
| brand_name | String | The brand name of the lock box or door code device that you’re using | The Forever Lock | |
| location | Object | Object containing additional text. | { "lang": "en", "text": "Access to the lock box is open 24/7." } | |
| off_location | Flag (0, 1) | A flag indicating that check-in must be done somewhere outside of property | 1 | |
| address | String | Address of the check-in location. Only provided if off_location = 1. | Herengracht 597 | |
| city | String | City of the check-in location. Only provided if off_location = 1. | Amsterdam | |
| zip | String | Zip code of the check-in location. Only provided if off_location = 1. | 1017CE | |
| place_id | String | The Google Maps Id of the check-in location. Only provided if off_location = 1. | The reception is open 24/7. |
Method name: instruction_will_send
Method-specific fields
| Field | Subfield | Type | Description | Example |
|---|---|---|---|---|
| instruction | Object | Object describing how the instructions will be sent | { "lang": "en", "text": "The reception is open 24/7." } | |
| how | String | How will you send instructions to your guests? Possible values: phone, email, sms, other. | phone | |
| when | String | When will you send instructions. Possible values: immediate, month_before, week_before, day_of_arrival | immediate | |
| other | String | Free text instructions when the value of how = "other" | Instructions will be sent by the pigeon post |
Method name: instruction_contact_us
Method-specific fields
| Field | Subfield | Type | Description | Example |
|---|---|---|---|---|
| instruction | Object | Object describing how the instructions will be sent | { "lang": "en", "text": "The reception is open 24/7." } | |
| how | String | How should your guests contact you? Possible values: phone, email, sms, other. | phone | |
| identifier | String | Contact details (email, phone number) provided in case the guest needs to contact the property. | +31612345678 | |
| other | String | Free text instructions when the value of how = "other" |