Autohost API (1)
Download OpenAPI specification:Download
Private API for Autohost customers.
Contact Sales to open an account.
My account
Return current user account information. This is often used to validate authentication.
header Parameters
x-api-key required | string API Authentication Key |
Responses
Response samples
- 200
- 400
{- "id": "string",
- "name": "string",
- "email": "user@example.com",
- "phone": "string",
- "is_active": true,
- "is_suspended": true,
- "last_login": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "company": {
- "name": "string",
- "email": "user@example.com",
- "phone": "string"
}, - "billing": {
- "parent_account": "string"
}
}
Reseller accounts list
Paginated list of user accounts belonging to a reseller profile.
query Parameters
from | number Pagination control |
size | number Number of items to return |
header Parameters
x-api-key required | string API Authentication Key |
Responses
Response samples
- 200
- 400
{- "from": 0,
- "size": 0,
- "total": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "email": "user@example.com",
- "phone": "string"
}
]
}
Reseller new account
Register a new account under a channel profile. This is used by resellers and channel partners to create Autohost user accounts.
header Parameters
x-api-key | string API Authentication Key |
Request Body schema: application/json
JSON object with user account details
name | string |
string <email> | |
phone | string |
password | string |
object |
Responses
Request samples
- Payload
{- "name": "string",
- "email": "user@example.com",
- "phone": "string",
- "password": "string",
- "company": {
- "name": "string",
- "email": "user@example.com",
- "phone": "string"
}
}
Response samples
- 200
- 400
{- "id": "string",
- "name": "string",
- "email": "user@example.com",
- "phone": "string",
- "is_active": true,
- "is_suspended": true,
- "last_login": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "company": {
- "name": "string",
- "email": "user@example.com",
- "phone": "string"
}, - "billing": {
- "parent_account": "string"
}
}
Reseller update account
Update a channel account. This is used by resellers and channel partners to update Autohost user accounts.
path Parameters
id required | string Autohost user ID |
query Parameters
suspended | string Enum: "true" "false" Suspend or unsuspend the account |
status | string Enum: "active" "disabled" Enable or disable the account |
header Parameters
x-api-key | string API Authentication Key |
Request Body schema: application/json
JSON object with user account details
name | string |
string <email> | |
phone | string |
password | string |
object |
Responses
Request samples
- Payload
{- "name": "string",
- "email": "user@example.com",
- "phone": "string",
- "password": "string",
- "company": {
- "name": "string",
- "email": "user@example.com",
- "phone": "string"
}
}
Response samples
- 200
- 400
{- "id": "string",
- "name": "string",
- "email": "user@example.com",
- "phone": "string",
- "is_active": true,
- "is_suspended": true,
- "last_login": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "company": {
- "name": "string",
- "email": "user@example.com",
- "phone": "string"
}, - "billing": {
- "parent_account": "string"
}
}
Reseller signup link
Generate a self-signup link for a given PMS. This is used by resellers and channel partners to create registration links they can send to their customers.
query Parameters
pms required | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name |
redirect | string URL to redirect to after signup |
hidepw | string Hide password screen during user signup |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 400
{- "expiry": "2019-08-24T14:15:22Z"
}
Account create webhook
Register a new webhook. This is used by platforms such as Zapier to register webhooks.
header Parameters
x-api-key required | string API Authentication Key |
Request Body schema: application/json
JSON object with webhook details
webhook_url | string <uri> |
webhook_key | string Enum: "guest_portal_webhook_url" "screening_webhook_url" "stargate_webhook_url" "reservation_webhook_url" "listing_webhook_url" "account_webhook_url" |
Responses
Request samples
- Payload
{- "webhook_key": "guest_portal_webhook_url"
}
Response samples
- 200
- 400
{- "message": "string"
}
Account remove webhook
Delete an existing webhook. This is used by platforms such as Zapier to unregister webhooks.
header Parameters
x-api-key required | string API Authentication Key |
Request Body schema: application/json
JSON object with webhook details
webhook_url | string <uri> |
webhook_key | string Enum: "guest_portal_webhook_url" "screening_webhook_url" "stargate_webhook_url" "reservation_webhook_url" "listing_webhook_url" "account_webhook_url" |
Responses
Request samples
- Payload
{- "webhook_key": "guest_portal_webhook_url"
}
Response samples
- 200
- 400
{- "message": "string"
}
Background Check - Submit
Start a background check
query Parameters
type required | string Value: "globalcheck" Background check type |
header Parameters
x-api-key required | string API Authentication Key |
Request Body schema: application/json
JSON object with candidate details
first_name | string First name |
last_name | string Last name |
middle_name | string Middle name (optional) |
country | string = 2 characters ISO 3166-1 alpha-2 country code |
state | string >= 2 characters ISO 3166-2 state code (e.g. US-NY) |
city | string City |
gender | string Enum: "M" "F" "X" Gender type (optional) |
phone | string E.164 phone number (e.g. +15555555555) |
string <email> Email address | |
year_of_birth | integer [ 1900 .. 2100 ] Year of birth (e.g. 1990) |
date_of_birth | string <date> ISO 8601 date (e.g. 1990-01-01) |
Responses
Request samples
- Payload
{- "first_name": "John",
- "last_name": "Doe",
- "middle_name": "Smith",
- "country": "US",
- "state": "CA",
- "city": "Los Angeles",
- "email": "user@example.com",
- "phone": "+14155555555",
- "year_of_birth": 1985
}
Response samples
- 200
- 500
{- "id": "98efb578c68591e90f8a05d0d52224a7c70df4fbd3faabc92bb011ab28ac5e7d",
- "start_date": "2023-07-30T18:25:56.536Z",
- "status": "PENDING",
- "type": "globalcheck"
}
Background Check - Results
Get background check results
path Parameters
id required | string Background check report ID |
header Parameters
x-api-key required | string API Authentication Key |
Responses
Response samples
- 200
- 500
{- "id": "98efb578c68591e90f8a05d0d52224a7c70df4fbd3faabc92bb011ab28ac5e7d",
- "start_date": "2023-07-30T18:25:56.536Z",
- "stop_date": "2023-07-30T18:29:56.536Z",
- "status": "FINISHED",
- "risk_status": "CLEARED",
- "type": "globalcheck",
- "report_items": [
- {
- "name": "Social Accounts",
- "status": "FINISHED",
- "items": [
- {
- "title": "Found 10 registered accounts",
- "description": "List of registered accounts:\\n- Apple\\n- Booking\\n- Facebook\\n- Github\\n- Google\\n- Instagram\\n- Spotify\\n- Telegram\\n- Whatsapp\\n- Yahoo",
- "tags": [
- "social"
]
}
]
}, - {
- "name": "Phone Verification",
- "status": "FINISHED",
- "items": [
- {
- "title": "Phone number is valid",
- "subtitle": "054-000-0000",
- "description": "- Country: Israel\\n- Carrier: HOT Telecom\\n- Line Type: mobile",
- "tags": [
- "phone"
]
}
]
}, - {
- "name": "Avatars",
- "status": "FINISHED",
- "items": [
- {
- "title": "Found 7 profile pictures",
- "subtitle": "Review to see if any of these are the same person",
- "tags": [
- "avatar"
]
}
]
}
]
}
Global Watchlist search
Search entities in the Global Watchlist list by name, date of birth and aliases
query Parameters
image | string Base64-encoded image for facial recognition (uploaded images are not stored) |
name required | string Full name or alias |
dob | string Date of birth (YYYY-MM-DD) |
yob | string Year of birth (YYYY) |
country_code | string Country code (e.g. US) |
sources | string Comma-separated list of sources to search (default: all) |
source_country_code | string Limit results to specific watchlists from a country (e.g. US) |
from | number Pagination start (default: 0) |
header Parameters
x-api-key required | string API Authentication Key |
Responses
Response samples
- 200
- 500
{- "dob": [
- "1961-04-25"
], - "yob": [
- 1961
], - "full_name": "maria soledad iparraguirre guenechea",
- "first_name": "maria",
- "last_name": "iparraguirre guenechea",
- "middle_name": "soledad",
- "description": "Member ETA.",
- "aliases": [
- "maria soledad iparraguirre guenechea"
]
}
ID verification upload
Upload base64-encoded photo for analysis and verification
path Parameters
id required | string Autohost reservation ID |
step required | string Document side (front, back, selfie) |
type required | string Document type (drivers, passport, id) |
query Parameters
pms | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name. If supplied, the API will assume the path parameter |
header Parameters
x-api-key | string API Authentication Key |
Request Body schema: application/json
JSON object with DataURL or base64-encoded image
imageBase64 | string |
Responses
Request samples
- Payload
{- "imageBase64": "data:image/jpeg;base64,<base64-encoded image>"
}
Response samples
- 200
- 500
{- "code": "string",
- "error": "string",
- "card": {
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "birth_date": "string",
- "expiry_date": "string"
}
}
ID verification status
Get verification results for photos that you uploaded
path Parameters
id required | string Autohost reservation ID |
query Parameters
pms | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name. If supplied, the API will assume the path parameter |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
{- "status": "passed"
}
ID verification image
Get uploaded image for identification document on a reservation
path Parameters
id required | string Autohost reservation ID |
step required | string Document side (front, back, selfie) |
query Parameters
pms | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name. If supplied, the API will assume the path parameter |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
{- "base64Image": "data:image/jpeg;base64,<base64-encoded image>"
}
Listing details
Get details object for a given listing.
path Parameters
id required | string Autohost listing ID |
query Parameters
pms | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name. If supplied, the API will perform a lookup using the PMS listing ID or the identifier supplied in |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 400
{- "id": "string",
- "my_id": "string",
- "user_id": "string",
- "status": "string",
- "name": "string",
- "nickname": "string",
- "property_type": "string",
- "accommodates": 0,
- "bedrooms": 0,
- "bathrooms": 0,
- "beds": 0,
- "check_in_time": 0,
- "check_out_time": 0,
- "location": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "time_zone_name": "string",
- "building": "string"
}, - "created_at": "string",
- "updated_at": "string"
}
Listing update
Update a given listing in your account.
path Parameters
id required | string Autohost listing ID |
query Parameters
callback | string (QueryParamCallback) Webhook URL to POST the list object. |
header Parameters
x-api-key | string API Authentication Key |
Request Body schema: application/json
JSON object with listing details
id | string |
my_id required | string |
status required | string Enum: "ACTIVE" "INACTIVE" |
name required | string |
nickname required | string |
property_type required | string Enum: "Apartment" "Cottage" "Condominium" "House" "Serviced Apartment" "Boat" "Camper/RV" "Chalet" "Bed&Breakfast" "Villa" "Tent" "Other" "Cabin" "Townhouse" "Bungalow" "Hut" "Dorm" "Plane" "Treehouse" "Yurt" "Tipi" "Igloo" "Earth House" "Island" "Cave" "Castle" "Studio" |
accommodates required | number |
bedrooms | number |
bathrooms | number |
beds | number |
check_in_time | number |
check_out_time | number |
object | |
object |
Responses
Request samples
- Payload
{- "status": "ACTIVE",
- "name": "Beautiful Downtown View for Two",
- "nickname": "DT PH 100",
- "property_type": "Condominium",
- "accommodates": 2,
- "bedrooms": 1,
- "bathrooms": 1,
- "beds": 1,
- "check_in_time": 15,
- "check_out_time": 10,
- "location": {
- "street": "100 King West",
- "city": "Toronto",
- "country": "Canada",
- "state": "ON",
- "zipcode": "xxxxx"
}
}
Response samples
- 200
- 400
{- "id": "string",
- "my_id": "string",
- "user_id": "string",
- "status": "string",
- "name": "string",
- "nickname": "string",
- "property_type": "string",
- "accommodates": 0,
- "bedrooms": 0,
- "bathrooms": 0,
- "beds": 0,
- "check_in_time": 0,
- "check_out_time": 0,
- "location": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "time_zone_name": "string",
- "building": "string"
}, - "created_at": "string",
- "updated_at": "string"
}
Listing search
Return paginated list of listings matching the search criteria.
query Parameters
status | string (QueryParamListingStatus) Enum: "ACTIVE" "INACTIVE" Listing status |
search | string String search |
building | string Building name |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 400
{- "total": 0,
- "from": 0,
- "size": 0,
- "count": 0,
- "items": [
- {
- "id": "string",
- "status": "string"
}
]
}
Listing create
Create a new listing in your account.
query Parameters
callback | string (QueryParamCallback) Webhook URL to POST the list object. |
header Parameters
x-api-key | string API Authentication Key |
Request Body schema: application/json
JSON object with listing details
id | string |
my_id required | string |
status required | string Enum: "ACTIVE" "INACTIVE" |
name required | string |
nickname required | string |
property_type required | string Enum: "Apartment" "Cottage" "Condominium" "House" "Serviced Apartment" "Boat" "Camper/RV" "Chalet" "Bed&Breakfast" "Villa" "Tent" "Other" "Cabin" "Townhouse" "Bungalow" "Hut" "Dorm" "Plane" "Treehouse" "Yurt" "Tipi" "Igloo" "Earth House" "Island" "Cave" "Castle" "Studio" |
accommodates required | number |
bedrooms | number |
bathrooms | number |
beds | number |
check_in_time | number |
check_out_time | number |
object | |
object |
Responses
Request samples
- Payload
{- "status": "ACTIVE",
- "name": "Beautiful Downtown View for Two",
- "nickname": "DT PH 100",
- "property_type": "Condominium",
- "accommodates": 2,
- "bedrooms": 1,
- "bathrooms": 1,
- "beds": 1,
- "check_in_time": 15,
- "check_out_time": 10,
- "location": {
- "street": "100 King West",
- "city": "Toronto",
- "country": "Canada",
- "state": "ON",
- "zipcode": "xxxxx"
}
}
Response samples
- 200
- 400
{- "id": "string",
- "my_id": "string",
- "user_id": "string",
- "status": "string",
- "name": "string",
- "nickname": "string",
- "property_type": "string",
- "accommodates": 0,
- "bedrooms": 0,
- "bathrooms": 0,
- "beds": 0,
- "check_in_time": 0,
- "check_out_time": 0,
- "location": {
- "street": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "time_zone_name": "string",
- "building": "string"
}, - "created_at": "string",
- "updated_at": "string"
}
Listing property types
Return a static list of supported property types. This list is used to populate the property_type
field when creating a new listing object.
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
[- "Apartment",
- "Cottage",
- "Condominium",
- "House",
- "Serviced Apartment",
- "Boat",
- "Camper/RV",
- "Chalet",
- "Bed&Breakfast",
- "Villa",
- "Tent",
- "Other",
- "Cabin",
- "Townhouse",
- "Bungalow",
- "Hut",
- "Dorm",
- "Plane",
- "Treehouse",
- "Yurt",
- "Tipi",
- "Igloo",
- "Earth House",
- "Island",
- "Cave",
- "Castle",
- "Studio"
]
Listing manage SuperHog connection
Connect or disconnect your listings from SuperHog.
path Parameters
id required | string Autohost listing ID |
header Parameters
x-api-key | string API Authentication Key |
Request Body schema: application/json
JSON object with listing details
action | string Enum: "connect" "disconnect" |
Responses
Request samples
- Payload
{- "action": "connect"
}
Response samples
- 200
- 400
{- "autohost_id": "xyxyxyxyxyxyx",
- "superhog_id": "abcd1234"
}
Reservation details
Get reservation details object.
path Parameters
id required | string Autohost reservation ID |
query Parameters
pms | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name. If supplied, the API will assume the path parameter |
usepmsid | string Assume |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 400
{- "id": "string",
- "user_id": "string",
- "confirmation_code": "string",
- "status": "string",
- "source": "string",
- "listing_id": "string",
- "listing_nickname": "string",
- "listing_timezone_name": "string",
- "number_of_guests": 0,
- "nights": 0,
- "total_price": 0,
- "average_daily_rate": 0,
- "check_in_date": "string",
- "check_out_date": "string",
- "guest_portal_url": "string",
- "guest": {
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "phone": "string",
- "email": "user@example.com",
- "location": "string"
}, - "identification": {
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "document_number": "string",
- "document_type": "string",
- "nationality": "string",
- "sex": "string",
- "address": "string",
- "birth_date": "string",
- "expiry_date": "string",
- "issue_date": "string"
}, - "created_at": "string",
- "updated_at": "string"
}
Reservation update
Update reservation object
path Parameters
id required | string Autohost reservation ID |
query Parameters
callback | string (QueryParamCallback) Webhook URL to post data back to once Screening AI finished analyzing the reservation. |
sync | boolean (QueryParamSync) Enum: 1 true Execution is asynchronous by default and the response, including reservation ID, will be returned via webhook when you supply the |
skip_gp | boolean (QueryParamSkipGP) Enum: 1 true Verification analysis to proceed without dependence on Guest Portal completion. To be included for all reservations where the guest is not expected to complete the portal. |
header Parameters
x-api-key | string API Authentication Key |
Request Body schema: application/json
JSON object with reservation details
status required | string Enum: "CONFIRMED" "CANCELED" "INQUIRY" |
source required | string |
listing_id required | string |
confirmation_code required | string |
number_of_guests required | number |
nights | number |
total_price required | number |
check_in_date required | string |
check_out_date required | string |
object | |
object |
Responses
Request samples
- Payload
{- "guest": {
- "first_name": "John",
- "last_name": "Doe"
}
}
Response samples
- 200
- 400
{- "id": "string",
- "user_id": "string",
- "confirmation_code": "string",
- "status": "string",
- "source": "string",
- "listing_id": "string",
- "listing_nickname": "string",
- "listing_timezone_name": "string",
- "number_of_guests": 0,
- "nights": 0,
- "total_price": 0,
- "average_daily_rate": 0,
- "check_in_date": "string",
- "check_out_date": "string",
- "guest_portal_url": "string",
- "guest": {
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "phone": "string",
- "email": "user@example.com",
- "location": "string"
}, - "identification": {
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "document_number": "string",
- "document_type": "string",
- "nationality": "string",
- "sex": "string",
- "address": "string",
- "birth_date": "string",
- "expiry_date": "string",
- "issue_date": "string"
}, - "created_at": "string",
- "updated_at": "string"
}
Reservation summary
Get reservation verifications summary and details
path Parameters
id required | string Autohost reservation ID |
query Parameters
pms | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name. If supplied, the API will assume the path parameter |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
{- "guest_portal_status": "COMPLETED",
- "guest_portal_last_screen": "IDCheck",
- "verification_composite_status": "review",
- "verification_status": "review",
- "verification_status_reason": "ID Check, Fraud Detection and Business Rules require your attention",
- "risk_color": "yellow",
- "top_risks": [
- "High risk potential for fraud detected. You should only allow the guest to enter if you've spoken to the guest over the phone and have met them in person",
- "Some fraud signals detected. Make sure to treat it carefully and manually review other information collected",
- "Guest location was detected to be within 50 KM (30 miles) of the listing",
- "Guest name does not match the name on the reservation",
- "There are 1 reports for this user IP on Autohost Threat Intelligence with the following tags: 'spam' and 'suspicious'"
], - "top_recommendations": [
- "Proceed to confirm the accuracy of all reservation details",
- "Collect additional information about the guests, and the trip, that may have been unclear or undisclosed",
- "Make sure the guests receive and acknowledge the house rules",
- "For security purposes, make sure you have the guest's ID for your records"
], - "details": {
- "general_risk": {
- "status": "PASS",
- "value": "YELLOW"
}, - "background_check": {
- "status": "DISABLED",
- "value": ""
}, - "credit_check": {
- "status": "DISABLED",
- "value": ""
}, - "blacklist": {
- "status": "INCOMPLETE",
- "value": ""
}, - "payment_verification": {
- "status": "INCOMPLETE",
- "value": ""
}, - "identification_document": {
- "status": "REVIEW",
- "value": "review",
- "help": "Guest name does not match the name on the reservation"
}, - "fraud_detection": {
- "status": "REVIEW",
- "value": "REVIEW",
- "findings": [
- "Email address appears on breach reports and leaked data dumps online. This could indicate other malicious parties are using this account to impersonate legitimate users.",
- "Email address seems to belong to a disposable provider. These providers are often used to create fake accounts and bypass email validation.",
- "The phone number does not seem to be registered at all. Check for typos, otherwise this may be a bogus number."
], - "help": "Manual review suggested"
}, - "adverse_media": {
- "status": "REVIEW",
- "value": "REVIEW",
- "findings": [
- "Fraud or Financial Crime",
- "Harassment",
- "Discrimination"
], - "help": "Manual review suggested"
}, - "social_verification": {
- "status": "PASS",
- "value": "13 accounts found"
}, - "sanctions": {
- "status": "INCOMPLETE",
- "value": ""
}, - "house_rules": {
- "status": "INCOMPLETE"
}
}, - "supervised_status": null
}
Reservation status
Get reservation status and verification details
path Parameters
id required | string Autohost reservation ID |
query Parameters
pms | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name. If supplied, the API will assume the path parameter |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
{- "status": "verified",
- "pms_status": "CONFIRMED",
- "supervised": "approve",
- "reason": "string",
- "guestportal_completed": true,
- "business_rules": [
- "string"
]
}
Reservation status change
Approve or decline a reservation manually
path Parameters
id required | string Autohost reservation ID |
header Parameters
x-api-key | string API Authentication Key |
Request Body schema: application/json
JSON object with verification details
supervised | string Enum: "approve" "decline" |
notes | string |
Responses
Request samples
- Payload
{- "supervised": "decline"
}
Response samples
- 200
{- "status": "verified",
- "pms_status": "CONFIRMED",
- "supervised": "approve",
- "reason": "string",
- "guestportal_completed": true,
- "business_rules": [
- "string"
]
}
Reservation Guest Portal Screens
Guest Portal screens configuration for a specific reservation.
path Parameters
id required | string Autohost reservation ID |
query Parameters
pms | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name. If supplied, the API will assume the path parameter |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 400
{- "AboutYou": "disabled",
- "AuthorityReporting": "disabled",
- "BuildingScreen": "disabled",
- "BackgroundCheck": "disabled",
- "CreditCheck": "disabled",
- "IDVerification": "disabled",
- "IDCollection": "disabled",
- "SecurityDeposit": "disabled",
- "UsageAgreement": "disabled",
- "Coronavirus": "disabled",
- "CustomScreen": "disabled",
- "FileUpload": "disabled",
- "GuestList": "disabled",
- "HouseRules": "disabled",
- "LongTerm": "disabled",
- "PurposeOfStay": "disabled",
- "TimeInfoEdit": "disabled",
- "SexOffendersAddon": "disabled",
- "SocialVerificationAddon": "disabled",
- "SanctionsSearchAddon": "disabled",
- "FraudDetectionAddon": "disabled",
- "AdverseMediaSearchAddon": "disabled"
}
Reservation embed link
Generate a temporary link to embed reservation details on your web page
path Parameters
id required | string Autohost reservation ID |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
{- "expires": "2021-09-05T16:18:39.808Z"
}
Reservation notes
Get list of notes for a reservation
path Parameters
id required | string Autohost reservation ID |
query Parameters
pms | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name. If supplied, the API will assume the path parameter |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
[- {
- "text": "string",
- "author_id": "string",
- "author_name": "string",
- "author_type": "string",
- "timestamp": "string"
}
]
Reservation payments
Payment details for a reservation. Includes Security Deposit, Damage Waiver and Payment Validation.
path Parameters
id required | string Autohost reservation ID |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
{- "security_deposit": {
- "successful_authorizations": [
- {
- "currency": "string",
- "amount": 0,
- "receipt_url": "string",
- "card_brand": "string",
- "timestamp": "string"
}
], - "charge_failures": [
- {
- "message": "string",
- "timestamp": "string"
}
], - "refunds": [
- {
- "currency": "string",
- "amount": 0,
- "receipt_url": "string",
- "timestamp": "string"
}
], - "deposit_captures": [
- {
- "currency": "string",
- "amount": 0,
- "receipt_url": "string",
- "card_brand": "string",
- "timestamp": "string"
}
]
}, - "payment_validation": {
- "receipt_url": "string",
- "name_on_card": "string",
- "funding_type": "string",
- "card_brand": "string",
- "card_country": "string",
- "status": "string",
- "errors": [
- {
- "title": "string",
- "description": "string"
}
]
}, - "damage_waiver": {
- "amount": 0,
- "currency": "string",
- "timestamp": "string",
- "receipt_url": "string"
}, - "extra_services": {
- "amount": 0,
- "receipt_url": "string",
- "products": [
- {
- "name": "string",
- "price": 0
}
]
}
}
Reservation messages
List of queued and sent Stargate messages for a given reservation.
path Parameters
id required | string Autohost reservation ID |
header Parameters
x-api-key required | string API Authentication Key |
Responses
Response samples
- 200
- 404
[- {
- "email": "user@example.com",
- "phone": "string",
- "tag": "string",
- "method": "string",
- "via": "string",
- "sendAfter": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "reservation_id": "string",
- "listing_id": "string",
- "confirmation_code": "string",
- "message": {
- "subject": "string",
- "text": "string",
- "html": "string"
}
}
]
Reservation Guest Portal
Guest Portal details for a reservation
path Parameters
id required | string Autohost reservation ID |
query Parameters
pms | string (QueryParamPMS) Enum: "api" "apaleo" "beds24" "booking" "cloudbeds" "guesty" "hostaway" "hostfully" "inforhms" "impala" "lavanda" "myvr" "opera" "smartbnb" "stayntouch" "streamline" "trackhs" PMS integration name. If supplied, the API will assume the path parameter |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
{- "full_name": "string",
- "phone": "string",
- "email": "user@example.com",
- "name_on_card": "string",
- "security_deposit": true,
- "last_step": "string",
- "completed": true,
- "completed_at": "string",
- "updated_at": "string",
- "guests": [
- {
- "name": "string",
- "email": "user@example.com"
}
]
}
Reservation search
Return paginated list of reservations matching the search criteria.
query Parameters
from | number Pagination control |
size | number Number of items to return |
status | string (QueryParamReservationStatus) Enum: "CONFIRMED" "CANCELED" "INQUIRY" "any" Reservation OTA status |
search | string String search |
listings | string Autohost listing ID. Use commas for multiple IDs. |
guestportal_completed | string Filter by Guest Portal completion status (true|false). |
active | number Filter by active reservations. |
pending_review | string Return reservations that require a manual review (true|false) |
emails | string Search reservations by guest email. Use commas for multiple addresses. |
source | string Filter reservation by booking source name. |
startDate | string Filter reservation from the specified start date (YYYY-MM-DD). |
endDate | string Filter reservation from the specified end date (YYYY-MM-DD). |
dateField | string Check-in date is used by default, but it can be changed (check_in_date|check_out_date|created_at|updated_at). |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 400
{- "id": "string",
- "user_id": "string",
- "confirmation_code": "string",
- "status": "string",
- "source": "string",
- "listing_id": "string",
- "listing_nickname": "string",
- "listing_timezone_name": "string",
- "number_of_guests": 0,
- "nights": 0,
- "total_price": 0,
- "average_daily_rate": 0,
- "check_in_date": "string",
- "check_out_date": "string",
- "guest_portal_url": "string",
- "guest": {
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "phone": "string",
- "email": "user@example.com",
- "location": "string"
}, - "identification": {
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "document_number": "string",
- "document_type": "string",
- "nationality": "string",
- "sex": "string",
- "address": "string",
- "birth_date": "string",
- "expiry_date": "string",
- "issue_date": "string"
}, - "created_at": "string",
- "updated_at": "string"
}
Reservation creation
Create new reservation object
query Parameters
callback | string (QueryParamCallback) Webhook URL to post data back to once Screening AI finished analyzing the reservation. |
sync | boolean (QueryParamSync) Enum: 1 true Execution is asynchronous by default and the response, including reservation ID, will be returned via webhook when you supply the |
skip_gp | boolean (QueryParamSkipGP) Enum: 1 true Verification analysis to proceed without dependence on Guest Portal completion. To be included for all reservations where the guest is not expected to complete the portal. |
header Parameters
x-api-key | string API Authentication Key |
Request Body schema: application/json
JSON object with reservation details
status required | string Enum: "CONFIRMED" "CANCELED" "INQUIRY" |
source required | string |
listing_id required | string |
confirmation_code required | string |
number_of_guests required | number |
nights | number |
total_price required | number |
check_in_date required | string |
check_out_date required | string |
object | |
object |
Responses
Request samples
- Payload
{- "guest": {
- "first_name": "John",
- "last_name": "Doe"
}
}
Response samples
- 200
- 400
{- "id": "string",
- "user_id": "string",
- "confirmation_code": "string",
- "status": "string",
- "source": "string",
- "listing_id": "string",
- "listing_nickname": "string",
- "listing_timezone_name": "string",
- "number_of_guests": 0,
- "nights": 0,
- "total_price": 0,
- "average_daily_rate": 0,
- "check_in_date": "string",
- "check_out_date": "string",
- "guest_portal_url": "string",
- "guest": {
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "phone": "string",
- "email": "user@example.com",
- "location": "string"
}, - "identification": {
- "first_name": "string",
- "last_name": "string",
- "middle_name": "string",
- "document_number": "string",
- "document_type": "string",
- "nationality": "string",
- "sex": "string",
- "address": "string",
- "birth_date": "string",
- "expiry_date": "string",
- "issue_date": "string"
}, - "created_at": "string",
- "updated_at": "string"
}
Reservation payment event
Record a payment event belonging to a reservation for fraud analysis
path Parameters
id required | string Autohost reservation ID |
header Parameters
x-api-key required | string API Authentication Key |
Request Body schema: application/json
JSON object with payment event details
reservation_id required | string |
event_source required | string Enum: "adyen" "stripe" |
event_id required | string |
event_type required | string Enum: "authorization" "charge" "refund" "dispute" "chargeback" |
event_status required | string Enum: "info" "warning" "success" "failure" |
customer_id | string |
processor_status_code | string |
processor_message | string |
network_status_code | string |
amount | number >= 0 |
currency | string = 3 characters |
charge_descriptor | string |
name_on_card | string |
payment_method | string Enum: "card" "ach" |
card_type | string Enum: "credit" "debit" "prepaid" |
card_provider | string Enum: "visa" "mastercard" "amex" "discover" "jcb" "diners" "maestro" "unionpay" "other" |
card_iin | string [ 4 .. 6 ] characters |
card_last4 | string = 4 characters |
card_expiry_month | string = 2 characters |
card_expiry_year | string = 4 characters |
card_fingerprint | string |
billing_country_code | string = 2 characters |
billing_address | string |
billing_city | string |
billing_state_code | string |
billing_postal_code | string |
billing_phone | string |
billing_email | string <email> |
billing_name | string |
ip_address | string <ipv4> |
user_agent | string |
timestamp | string <date-time> |
Responses
Request samples
- Payload
{- "event_source": "adyen",
- "event_id": "123456789",
- "event_type": "charge",
- "event_status": "failure",
- "customer_id": "123456789",
- "processor_status_code": "111",
- "processor_message": "Invalid BankCountryCode specified",
- "amount": 101.5,
- "currency": "usd",
- "charge_descriptor": "PRE-AUTH Security Deposit",
- "name_on_card": "John Doe",
- "payment_method": "card",
- "card_type": "credit",
- "card_provider": "visa",
- "card_iin": "41111",
- "card_last4": "1111",
- "card_expiry_month": "12",
- "card_expiry_year": "2025",
- "billing_country_code": "US",
- "billing_address": "123 Main St",
- "billing_city": "New York",
- "billing_state_code": "NY",
- "billing_postal_code": "10001",
- "billing_phone": "+15555555555",
- "billing_email": "user@example.com",
- "billing_name": "John Doe",
- "ip_address": "8.8.8.8",
- "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36",
- "timestamp": "2022-05-22T18:06:20.352Z"
}
Response samples
- 200
- 400
{- "message": "string"
}
Lookup phone number
Lookup line type and carrier
path Parameters
number required | string URL-encoded phone number in international format (e.g. +441234567890) |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
{- "countryCode": "US",
- "phoneNumber": "+1234567890",
- "nationalFormat": "(123) 456-7890",
- "carrier": {
- "name": "Verizon",
- "type": "mobile"
}
}
Lookup breaches by email
Discover how many times a user has been compromised
path Parameters
email required | string URL encoded email address |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
[- {
- "Name": "string",
- "Domain": "string",
- "BreachDate": "string"
}
]
Lookup whois records by domain
Discover who owns a domain
path Parameters
domain required | string domain name (e.g. google.com) |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
[- {
- "server": "string",
- "data": {
- "domainName": "string",
- "registrar": "string",
- "creationDate": "string",
- "expirationDate": "string"
}
}
]
Lookup company details by domain
Find company details by domain
path Parameters
domain required | string domain name (e.g. oracle.com) |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
[- {
- "name": "Google",
- "country": "US",
- "industry": "Internet",
- "size": "1000+ employees",
- "founded": "1998"
}
]
Lookup geo-location by IP
Find location details by IP address
path Parameters
ip required | string IP Address |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
{- "country_code": "US",
- "country_name": "United States",
- "city": "Mountain View",
- "postal_code": "94043",
- "time_zone_name": "America/Los_Angeles",
- "latitude": 37.4192,
- "longitude": -122.0574
}
Lookup sex offenders
Search sex offenders in the USA
query Parameters
fname required | string First name |
lname required | string Last name |
dob required | string Date of birth (YYYY-MM-DD) |
state required | string State (e.g. CA) |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
{- "items": [
- {
- "id": "string",
- "name": "string",
- "fname": "string",
- "lname": "string",
- "city": "string",
- "county": "string",
- "state": "string",
- "zip": "string",
- "dob": "2019-08-24",
- "timestamp": "2019-08-24T14:15:22Z",
- "charge": [
- "string"
], - "aliases": [
- "string"
]
}
]
}
Lookup postal address
Lookup or verify billing and shipping addresses
path Parameters
address required | string Street or mailing address (URL-encoded) |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
{- "address": "123 Main St",
- "street": "123 Main St",
- "city": "Mountain View",
- "state": "CA",
- "country": "US",
- "country_code": "US",
- "zipcode": "94043",
- "timezone": "America/Los_Angeles",
- "geo": {
- "lat": 37.4192,
- "lon": -122.0574
}
}
Lookup IP Threats
Lookup threat reports associated with an IP address
path Parameters
ip required | string IP Address |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
[- {
- "ip": "5.167.66.39",
- "title": "IP reported on blocklist.de feed",
- "timestamp": "2016-01-01T00:00:00Z",
- "source": "blocklist",
- "tags": [
- "attack",
- "suspicious"
], - "reasons": [
- "The IP is blacklisted on blocklist.de"
]
}
]
Adverse Media Search
Initiate an adverse media search for a person or company
query Parameters
first_name required | string First name or alias |
middle_name | string Middle name |
last_name required | string Last name or alias |
year_of_birth | string Year of birth (YYYY) |
country required | string Country code (e.g. US) |
city | string City |
state | string State code (e.g. CA) |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 400
{- "id": "ab48405329f526a3f43f6e9c711466f503395f86a18110641ae246df544e56f1",
- "status": "PENDING",
- "startDate": "2023-01-01T00:00:00.000Z"
}
Adverse Media Report
View results of an adverse media search for a person or company
path Parameters
id required | string Report ID |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 400
{- "id": "ab48405329f526a3f43f6e9c711466f503395f86a18110641ae246df544e56f1",
- "status": "FINISHED",
- "startDate": "2023-01-01T00:00:00.000Z",
- "stopDate": "2023-01-01T00:10:00.000Z",
- "riskCategories": [
- "Discrimination",
- "Fraud or Financial Crime",
- "Harassment",
- "Violence",
- "Conflicts or Litigation",
- "Other News"
], - "findings": [
- {
- "title": "Title of the news article",
- "snippet": "Snippet of the news article",
- "summary": "Summary of the news article",
- "displayLink": "example.com",
- "riskCategories": [
- "Discrimination"
]
}, - {
- "title": "Title of the news article",
- "snippet": "Snippet of the news article",
- "summary": "Summary of the news article",
- "displayLink": "example.com",
- "riskCategories": [
- "Fraud or Financial Crime",
- "Harassment"
]
}
]
}
Validate phone number
Ensure that the phone number is valid
path Parameters
number required | string URL-encoded phone number in international format (e.g. +441234567890) |
query Parameters
country | string (QueryParamCountry) ISO country code (two letters) |
header Parameters
x-api-key | string API Authentication Key |
Responses
Response samples
- 200
- 500
{- "countryCode": "US",
- "phoneNumber": "+1234567890",
- "nationalFormat": "(123) 456-7890"
}
Analyze a transaction for fraud
Send object with transaction parameters to the fraud endpoint
header Parameters
x-api-key | string API Authentication Key |
Request Body schema: application/json
Transaction details object
sessionToken | string |
productToken | string |
string <email> | |
phoneNumber | string |
phoneCountry | string |
ipAddress | string |
billingCountry | string |
billingZip | string |
Responses
Request samples
- Payload
{- "sessionToken": "string",
- "productToken": "string",
- "email": "user@example.com",
- "phoneNumber": "string",
- "phoneCountry": "string",
- "ipAddress": "string",
- "billingCountry": "string",
- "billingZip": "string"
}
Response samples
- 200
- 500
{- "score": 0,
- "status": "pass",
- "cacheKey": "string"
}