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/user 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.

// Send completion signal without any data
// when the user finished all steps in the UI
await client.verification.save({
  step: "Finish",
  complete: true, // KYC UI workflow completed
  data: {},
});

// Or: send last form data and signal workflow completion.
// The system will know BackgroundCheck was the last step in the verification workflow.
await client.verification.save({
  step: "BackgroundCheck",
  complete: true,
  data: {
      first_name: "Agent",
      last_name: "Smith",
      dob: {
          year: 1999,
          month: 5,
          day: 15
      },
      addresses: [{
          address: "100 King Street, Unit 101",
          province_state: "ON",
          city: "Toronto",
          country: "CA"
      }]
  },
});

Steps

PersonalInfo

Field	Required	Type
email		String
full_name	*	String
phone		String
phone_country		String
address		String
birth_date		Date

BackgroundCheck

Field	Required	Type
first_name	*	String
middle_name		String
last_name	*	String
dob	*	Object
├── year	*	Number
├── month	*	Number
└── day	*	Number
addresses	*	Array
├── address	*	String
├── province_state	*	String
├── city	*	String
└── country	*	String

CreditCheck

Field	Required	Type
first_name	*	String
middle_name		String
last_name	*	String
dob	*	Object
├── year	*	Number
├── month	*	Number
└── day	*	Number
addresses	*	Array
├── address	*	String
├── province_state	*	String
├── city	*	String
└── country	*	String

GuestList

Field	Required	Type
guests	*	Array
├── full_name	*	String
├── email		Email
├── phone		String
└── birth_date		Date

PurposeOfStay

Field	Required	Type
category	*	String
experiences	*	Array

AboutYou

Field	Required	Type
bio	*	String

HouseRules

Field	Required	Type
signature	*	String

UsageAgreement

Field	Required	Type
agreement_signed_date	*	Iso Date
email_agreement		Boolean
signature	*	String

Finish

Field	Required	Type
-	-	-

Autohost

Talk to Sales