Status Fields
Overview of the status fields in the API.
| Field | Description |
|---|---|
| status | Autohost verification status. |
| supervised | Manual override status set by the user. |
| pms_status | Reservation status on the OTA/PMS. |
Status field
Field name: status
Refers to the Autohost verification status. This status is automatically determined by Autohost and is solely dependent on the Screening AI processing all risk factors, available data and the custom business rules on the account.
The possible values are:
| Value | Meaning |
|---|---|
pending | Reservation is in the system but has yet to go through analysis for final status determination. Waiting for additional data/verification results, as per account configuration. |
verified | All configured verifications were successfully processed with no specific test or rule flagged for review. Guest has been verified, no further action is required. |
review | Upon analyzing all verifications, one (or more) tests or business rules were flagged for attention. Reservation requires manual review. |
null | N/A (temporary status. Reservation entered the system but preliminary screening risk analysis hasn’t been run yet) |
The status is initially set to null when the reservation is first created. Once the Screening AI has processed all risk factors, the status will be updated to either verified or review. If the status is review, the reservation will be flagged for manual review and the user will be required to set a supervised status (see below).
Supervised field
Field name: supervised
Refers to the manual override status set by the user. For every reservation, users have the ability to set a supervised status, the value of which should precede the value of the Autohost Status. This can either be done manually through the dashboard, programmatically using business rules, or via the API. Normally, a supervised status will be required when a reservation is flagged for review (i.e status=review) and a judgement call is required from the user on whether to proceed with the booking or not.
The possible values are:
| Value | Meaning |
|---|---|
approve | Reservation set to be ‘approve’ by the manager, either manually, via the API, or through automated business rules. |
decline | Reservation set to be ‘decline’ by the manager, either manually, via the API, or through automated business rules. |
null | No manual action was taken. The supervised status is null. |
The supervised is initially set to null when the reservation is first created. When the user manually accepts or declines the reservation, the supervised status will be updated to either approve or decline. If the user does not take any action, the supervised status will remain null.
PMS Status field
Field name: pms_status
Refers to the reservation status on the OTA/PMS and affects whether verification tests are to be processed or not, depending on account settings.
The possible values are:
| Value | Meaning |
|---|---|
CONFIRMED | Reservation is currently confirmed. It will show on the reservations tab inside the dashboard and qualify to go through the Screening AI risk analysis. |
CANCELED | Reservation has been canceled. Screening AI will not run again and the reservation will no longer appear on the dashboard. Note that the reservation will still exist on the account and details can be retrieved if needed. |
INQUIRY | This only applies to reservations from OTAs that allow inquiries. The reservation will not show on the dashboard but details can be retrieved if needed. Unless configured otherwise, Screening AI will run preliminary analysis before additional data becomes available (usually upon PMS Status changing to ‘Confirmed’). |
Most PMS integrations will initially set the PMS Status to INQUIRY when a reservation is first created. Once the reservation is confirmed, the PMS Status will be updated to CONFIRMED. If the reservation is canceled, the PMS Status will be updated to CANCELED.
Status field vs PMS Status field
The status field is the Autohost verification status, whereas the pms_status field is the reservation status on the OTA/PMS. The status field is automatically determined by Autohost and is solely dependent on the Screening AI processing all risk factors, available data and the custom business rules on the account. The pms_status field is set by the PMS and is dependent on the OTA/PMS reservation status.
