Skip to main content

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.

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

FieldRequiredType
emailString
full_name*String
phoneString
phone_countryString
addressString
birth_dateDate

GuestList

FieldRequiredType
guests*Array
├── full_name*String
├── emailEmail
├── phoneString
└── birth_dateDate

TimeInfoEdit

FieldRequiredTypeExample
arrival_hour*String00-23
arrival_minute*String00-59
departure_hour*String00-23
departure_minute*String00-59

HouseRules

FieldRequiredType
signature*String

UsageAgreement

FieldRequiredType
agreement_signed_date*Iso Date
email_agreementBoolean
signature*String

PurposeOfStay

FieldRequiredType
category*String
experiences*Array

BackgroundCheck

FieldRequiredType
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

FieldRequiredType
bio*String

LongTerm

FieldRequiredType
longterm_screen*Array
├── question*String
└── answer*String

BuildingScreen

FieldRequiredType
building_screen*Array

ExtraServices

FieldRequiredType
extra_services_total_charged*Number