Skip to main content
API docs by Redocly

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

Content type
application/json
{
  • "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": {
    },
  • "billing": {
    }
}

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

Content type
application/json
{
  • "from": 0,
  • "size": 0,
  • "total": 0,
  • "items": [
    ]
}

Reseller API keys

List of API keys for all accounts owned by a reseller.

header Parameters
x-api-key
required
string

API Authentication Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new API key

Create a new API key for the authenticated user.

header Parameters
x-api-key
required
string

API Authentication Key

Request Body schema: application/json

API key creation request

description
string

Description for the API key

sdk
boolean
Default: false

Whether this is an SDK API key

Responses

Request samples

Content type
application/json
Example
{
  • "description": "My API Key",
  • "sdk": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "value": "string",
  • "enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sdk": true
}

Update API key

Update an existing API key's description.

path Parameters
key
required
string

The API key ID

header Parameters
x-api-key
required
string

API Authentication Key

Request Body schema: application/json

API key update request

description
required
string

New description for the API key

Responses

Request samples

Content type
application/json
{
  • "description": "Updated API Key Description"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "value": "string",
  • "enabled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sdk": true
}

Delete API key

Delete an existing API key.

path Parameters
key
required
string

The API key ID

header Parameters
x-api-key
required
string

API Authentication Key

Responses

Response samples

Content type
application/json
{
  • "message": "Key removed"
}

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
required
string

API Authentication Key

Request Body schema: application/json

JSON object with user account details

name
string
email
string <email>
phone
string
password
string
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "password": "string",
  • "company": {
    }
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "billing": {
    }
}

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
required
string

API Authentication Key

Request Body schema: application/json

JSON object with user account details

name
string
email
string <email>
phone
string
password
string
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "password": "string",
  • "company": {
    }
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "billing": {
    }
}

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
required
string

API Authentication Key

Responses

Response samples

Content type
application/json
{}

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

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "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

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "message": "string"
}

Update Guest Portal screen settings for an account

Update your own account settings, or update another user's account Guest Portal screen settings if you have the necessary permissions.

path Parameters
id
required
string

Autohost user ID (optional)

header Parameters
x-api-key
string

API Authentication Key

Request Body schema: application/json

JSON object with account settings

config_key
string
Enum: "guest_portal_screens_for_repeat_guests" "guest_portal_screens_by_source"

Configuration key

Array of items

Configuration data for each source

Responses

Request samples

Content type
application/json
Example
{
  • "config_key": "guest_portal_screens_for_repeat_guests",
  • "config_data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "config_key": "guest_portal_screens_for_repeat_guests",
  • "config_data": [
    ]
}

Update Guest Portal screen settings for an account

Update your own account settings, or update another user's account Guest Portal screen settings if you have the necessary permissions.

path Parameters
id
required
string

Autohost user ID (optional)

header Parameters
x-api-key
string

API Authentication Key

Request Body schema: application/json

JSON object with account settings

config_key
string
Enum: "guest_portal_screens_for_repeat_guests" "guest_portal_screens_by_source"

Configuration key

Array of items

Configuration data for each source

Responses

Request samples

Content type
application/json
Example
{
  • "config_key": "guest_portal_screens_for_repeat_guests",
  • "config_data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "config_key": "guest_portal_screens_for_repeat_guests",
  • "config_data": [
    ]
}

Update Guest Portal screen settings for an account

Update your own account settings, or update another user's account Guest Portal screen settings if you have the necessary permissions.

path Parameters
id
required
string

Autohost user ID (optional)

header Parameters
x-api-key
string

API Authentication Key

Request Body schema: application/json

JSON object with account settings

config_key
string
Enum: "guest_portal_screens_for_repeat_guests" "guest_portal_screens_by_source"

Configuration key

Array of items

Configuration data for each source

Responses

Request samples

Content type
application/json
Example
{
  • "config_key": "guest_portal_screens_for_repeat_guests",
  • "config_data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "config_key": "guest_portal_screens_for_repeat_guests",
  • "config_data": [
    ]
}

Update Guest Portal screen settings for an account

Update your own account settings, or update another user's account Guest Portal screen settings if you have the necessary permissions.

path Parameters
id
required
string

Autohost user ID (optional)

header Parameters
x-api-key
string

API Authentication Key

Request Body schema: application/json

JSON object with account settings

config_key
string
Enum: "guest_portal_screens_for_repeat_guests" "guest_portal_screens_by_source"

Configuration key

Array of items

Configuration data for each source

Responses

Request samples

Content type
application/json
Example
{
  • "config_key": "guest_portal_screens_for_repeat_guests",
  • "config_data": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "config_key": "guest_portal_screens_for_repeat_guests",
  • "config_data": [
    ]
}

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)

email
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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "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",
  • "pdf": "https://www.example.com/report.pdf",
  • "report_items": [
    ]
}

Global Watchlist sources

Retrieve a list of sources available in the Global Watchlist

header Parameters
x-api-key
required
string

API Authentication Key

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ]
}

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 id is a confirmation code.

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

Content type
application/json
Example
{
  • "imageBase64": "data:image/jpeg;base64,<base64-encoded image>"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "error": "string",
  • "card": {
    }
}

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 id is a confirmation code.

header Parameters
x-api-key
string

API Authentication Key

Responses

Response samples

Content type
application/json
Example
{
  • "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 id is a confirmation code.

header Parameters
x-api-key
string

API Authentication Key

Responses

Response samples

Content type
application/json
{
  • "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 my_id

header Parameters
x-api-key
string

API Authentication Key

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "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" "Hotel" "Boat" "Camper/RV" "Other"
accommodates
required
number
bedrooms
number
bathrooms
number
beds
number
check_in_time
number
check_out_time
number
object
object

Responses

Request samples

Content type
application/json
Example
{
  • "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": {
    }
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "created_at": "string",
  • "updated_at": "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" "Hotel" "Boat" "Camper/RV" "Other"
accommodates
required
number
bedrooms
number
bathrooms
number
beds
number
check_in_time
number
check_out_time
number
object
object

Responses

Request samples

Content type
application/json
Example
{
  • "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": {
    }
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "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

Content type
application/json
[
  • "Apartment",
  • "Cottage",
  • "Condominium",
  • "House",
  • "Hotel",
  • "Boat",
  • "Camper/RV",
  • "Other"
]

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

Content type
application/json
Example
{
  • "action": "connect"
}

Response samples

Content type
application/json
Example
{
  • "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 id is a confirmation code.

usepmsid
string

Assume id is the PMS reservation ID. Must be used with pms. (Default: false)

header Parameters
x-api-key
string

API Authentication Key

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "identification": {
    },
  • "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 callback parameter. You can enable synchronous execution by setting sync=1, but it is discouraged when sending large amounts of requests.

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 <date-time>
check_out_date
required
string <date-time>
created_at
string <date-time>
object
object

Responses

Request samples

Content type
application/json
Example
{
  • "guest": {
    }
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "identification": {
    },
  • "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 id is a confirmation code.

header Parameters
x-api-key
string

API Authentication Key

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "top_recommendations": [
    ],
  • "details": {
    },
  • "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 id is a confirmation code.

header Parameters
x-api-key
string

API Authentication Key

Responses

Response samples

Content type
application/json
{
  • "status": "verified",
  • "pms_status": "CONFIRMED",
  • "supervised": "approve",
  • "reason": "string",
  • "guestportal_completed": true,
  • "business_rules": [
    ]
}

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

Content type
application/json
Example
{
  • "supervised": "decline"
}

Response samples

Content type
application/json
{
  • "status": "verified",
  • "pms_status": "CONFIRMED",
  • "supervised": "approve",
  • "reason": "string",
  • "guestportal_completed": true,
  • "business_rules": [
    ]
}

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 id is a confirmation code.

header Parameters
x-api-key
string

API Authentication Key

Responses

Response samples

Content type
application/json
{
  • "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 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 id is a confirmation code.

header Parameters
x-api-key
string

API Authentication Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "security_deposit": {
    },
  • "payment_validation": {
    },
  • "damage_waiver": {
    },
  • "extra_services": {
    }
}

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

Content type
application/json
[
  • {
    }
]

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 id is a confirmation code.

header Parameters
x-api-key
string

API Authentication Key

Responses

Response samples

Content type
application/json
{
  • "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": [
    ]
}

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 callback parameter. You can enable synchronous execution by setting sync=1, but it is discouraged when sending large amounts of requests.

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 <date-time>
check_out_date
required
string <date-time>
created_at
string <date-time>
object
object

Responses

Request samples

Content type
application/json
Example
{
  • "guest": {
    }
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "identification": {
    },
  • "created_at": "string",
  • "updated_at": "string"
}

Reservation payment event

Record a payment event belonging to a reservation for fraud analysis and business rules.

The following parameters are optional, but highly recommended:

  • card_country
  • card_provider
  • card_expiry_month
  • card_expiry_year
  • three_d_secure
  • billing_email
  • billing_phone
  • ip_address

If you are using Adyen, see this guide for more information on how to get the required parameters.

Examples of how to map the webhook events from common providers:

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

Autohost reservation ID

event_source
required
string
Enum: "adyen" "stripe" "other"

Payment processor

event_id
required
string

Unique event ID from payment processor

event_type
required
string
Enum: "authorization" "charge" "refund" "dispute" "chargeback"

Type of the event

event_status
required
string
Enum: "info" "warning" "success" "failure"

Status of the event

customer_id
string

Unique customer ID from payment processor or your system

processor_status_code
string

Status code from the payment processor

processor_message
string

Message from the payment processor

network_status_code
string
Enum: "approved_by_network" "declined_by_network" "not_sent_to_network" "reversed_after_approval"

Network status code

three_d_secure
string
Enum: "attempt_acknowledged" "authenticated" "exempted" "failed" "not_supported" "processing_error"

3D Secure status (if applicable)

amount
number >= 0

Amount in major currency units (e.g. 1.25)

currency
string = 3 characters

ISO 4217 currency code (e.g. usd)

charge_descriptor
string

Short description of the charge

name_on_card
string

Name on the card

payment_method
string
Enum: "card" "ach"

Payment method

card_type
string
Enum: "credit" "debit" "prepaid"

Card type (credit, debit, prepaid)

card_provider
string
Enum: "visa" "mastercard" "amex" "discover" "jcb" "diners" "maestro" "unionpay" "other"

Issuer of the card

card_country
string = 2 characters

The country where the card was issued in ISO 3166-1 alpha-2 format (e.g. US)

card_iin
string [ 4 .. 6 ] characters

Issuer Identification Number

card_last4
string = 4 characters

Last 4 digits of the card number

card_expiry_month
string = 2 characters

Expiry month of the card

card_expiry_year
string = 4 characters

Expiry year of the card

card_fingerprint
string

Unique card fingerprint provided by payment processor (if available)

card_cvc_check
string
Enum: "pass" "fail" "unavailable"

Card security code check

card_postal_code_check
string
Enum: "pass" "fail" "unavailable"

Card postal code check

card_line1_check
string
Enum: "pass" "fail" "unavailable"

Card address line 1 check

billing_country_code
string = 2 characters

Country code of the billing address in ISO 3166-1 alpha-2 format

billing_address
string

Billing street address

billing_city
string

Billing city

billing_state_code
string

Billing state code in ISO 3166-2 format

billing_postal_code
string

Billing postal code

billing_phone
string

Billing phone number in E.164 format (e.g. +15555555555)

billing_email
string <email>

Billing email address

billing_name
string

Billing name

ip_address
string <ipv4>

IP address of the customer

user_agent
string

User agent of the customer

timestamp
string <date-time>

Timestamp of the event in ISO 8601 format (e.g. 2022-05-22T18:06:20.352Z)

Responses

Request samples

Content type
application/json
Example
{
  • "event_source": "adyen",
  • "event_id": "123456789",
  • "event_type": "charge",
  • "event_status": "failure",
  • "customer_id": "123456789",
  • "processor_status_code": "111",
  • "processor_message": "Invalid BankCountryCode specified",
  • "network_status_code": "declined_by_network",
  • "three_d_secure": "exempted",
  • "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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "countryCode": "US",
  • "phoneNumber": "+1234567890",
  • "nationalFormat": "(123) 456-7890",
  • "carrier": {
    }
}

Lookup social accounts

Lookup social accounts by email and phone number to Check users are not using fake profiles by validating they have online social accounts

header Parameters
x-api-key
string

API Authentication Key

Request Body schema: application/json

Transaction details object

email
string <email>
phoneNumber
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "phoneNumber": "string"
}

Response samples

Content type
application/json
{
  • "phoneNumber": {
    },
  • "email": { }
}

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[]

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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "from": 0,
  • "size": 0,
  • "total": 0,
  • "items": [
    ]
}

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

Content type
application/json
{
  • "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": {
    }
}

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "id": "ab48405329f526a3f43f6e9c711466f503395f86a18110641ae246df544e56f1",
  • "status": "FINISHED",
  • "startDate": "2023-01-01T00:00:00.000Z",
  • "stopDate": "2023-01-01T00:10:00.000Z",
  • "riskCategories": [
    ],
  • "findings": []
}

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

Content type
application/json
Example
{
  • "countryCode": "US",
  • "phoneNumber": "+1234567890",
  • "nationalFormat": "(123) 456-7890"
}

Validate email address

Ensure that the email address is valid

path Parameters
email
required
string

URL encoded email address

header Parameters
x-api-key
string

API Authentication Key

Responses

Response samples

Content type
application/json
Example
{
  • "status": "VALID",
  • "result": {
    }
}

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
email
string <email>
phoneNumber
string
phoneCountry
string
ipAddress
string
billingCountry
string
billingZip
string

Responses

Request samples

Content type
application/json
{
  • "sessionToken": "string",
  • "productToken": "string",
  • "email": "user@example.com",
  • "phoneNumber": "string",
  • "phoneCountry": "string",
  • "ipAddress": "string",
  • "billingCountry": "string",
  • "billingZip": "string"
}

Response samples

Content type
application/json
{
  • "score": 0,
  • "status": "pass",
  • "cacheKey": "string"
}

Tenant Evictions sources

Retrieve a list of sources available in the Tenant Evictions list

header Parameters
x-api-key
required
string

API Authentication Key

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ]
}