Skip to main content
POST
Create Verification Rule

Authorizations

Authorization
string
header
required

Conduit API token. Use Authorization: Bearer <token>. Read/write endpoints require a token with write access.

Path Parameters

workspace_id
string
required

Workspace identifier

Minimum string length: 1

Body

application/json
name
string
required

Operator-facing rule name

Minimum string length: 1
step_type
enum<string>
required
Available options:
id_check,
agreement,
damage_waiver,
security_deposit,
mandatory_fee,
guest_details,
additional_questions,
other_guests
config
object
required

Shape depends on step_type. id_check: {title, instructions, requireContactPhoto?, autoApprove?}. agreement: {title, body}. damage_waiver: {title, body, pricing?}. security_deposit: {title, instructions, amountInCents, currency, releaseDelayDays?}. mandatory_fee: {title, instructions, amountInCents, currency}. guest_details: {title, description?, collectEmail, collectPhone, collectEta, collectEtd, requiredFields}. additional_questions: {title, description?, questions}. other_guests: {title, description?, minGuests?, maxGuests?, fields?}.

targeting
object

Which stays this rule applies to. Omit to target every stay.

exclude_returning_guests
boolean
enabled
boolean

Defaults to true. Disabled rules never apply.

Response

Create Verification Rule

data
object
required