Save Method
Description
The save
method is used to send the verification data for a specific Autohost Verification step, as part of a Verification UI implementation.
The required data
is specific to the provided step
. Data can only be submitted for a single step at a time.
info
Building your own Verification UI is a new feature that is under active development. Contact us for more details.
Options
Name | Type | Description |
---|---|---|
step | String | The name of the step completed by the user. |
data | Object | The user's completed data for that specific step |
isSinglePage (optional) | Boolean | If true, the Autohost Activity log will show that the step was a Single Page. |
Example
const client = await AutohostSDK.init({
reservationId: RESERVATION_ID,
});
// Information captured from your own Verification UI implementation
await client.verification.save({
step: "PersonalInfo",
data: {
email: "e@mail.com",
full_name: "John Doe",
phone: "+14165555555",
phone_country: "CA",
address: "20 King St West, Toronto ON, CA",
birth_date: "1990-01-01",
},
});
Completing the Verification UI
To tell our system that you are done sending data, and your guest has finished the Verification flow, pass complete: true
in the options you pass to the save
method. When we receive that, our Screening AI will run on the data sent and mark the Guest Portal as Complete in the Autohost Dashboard.
await client.verification.save({
step: "AboutYou",
complete: true,
data: {
bio: "I'm a single mom who works two jobs, loves her kids and never stops.",
},
});
Steps
PersonalInfo
Field | Required | Type |
---|---|---|
String | ||
full_name | * | String |
phone | String | |
phone_country | String | |
address | String | |
birth_date | Date |
GuestList
Field | Required | Type |
---|---|---|
guests | * | Array |
├── full_name | * | String |
├── phone | String | |
└── birth_date | Date |
TimeInfoEdit
Field | Required | Type | Example |
---|---|---|---|
arrival_hour | * | String | 00-23 |
arrival_minute | * | String | 00-59 |
departure_hour | * | String | 00-23 |
departure_minute | * | String | 00-59 |
HouseRules
Field | Required | Type |
---|---|---|
signature | * | String |
UsageAgreement
Field | Required | Type |
---|---|---|
agreement_signed_date | * | Iso Date |
email_agreement | Boolean | |
signature | * | String |
PurposeOfStay
Field | Required | Type |
---|---|---|
category | * | String |
experiences | * | Array |
BackgroundCheck
Field | Required | Type |
---|---|---|
first_name | * | String |
last_name | * | String |
dob | * | Object |
├── year | * | Number |
├── month | * | Number |
└── day | * | Number |
addresses | * | Array |
├── address | * | String |
├── province_state | * | String |
├── city | * | String |
└── country | * | String |
AboutYou
Field | Required | Type |
---|---|---|
bio | * | String |
LongTerm
Field | Required | Type |
---|---|---|
longterm_screen | * | Array |
├── question | * | String |
└── answer | * | String |
BuildingScreen
Field | Required | Type |
---|---|---|
building_screen | * | Array |
ExtraServices
Field | Required | Type |
---|---|---|
extra_services_total_charged | * | Number |