> ## Documentation Index
> Fetch the complete documentation index at: https://docs.conduit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Verification Rule

> Get one portal verification rule and its complete configuration.



## OpenAPI

````yaml GET /v1/workspaces/{workspace_id}/verification-rules/{id}
openapi: 3.0.0
info:
  title: Conduit API
  version: 1.0.0
  description: Public API for Conduit.
servers:
  - url: https://api.conduit.ai
    description: Production
security: []
tags:
  - name: meta
    description: Discovery and API metadata endpoints.
  - name: agents
    description: >-
      V2 chat agent configuration, including instructions, skills, triggers, and
      automation behavior.
  - name: contacts
    description: >-
      Contact profile and contact-scoped related resources such as tickets and
      calls.
  - name: workspaces
    description: Workspaces accessible to the current API token.
  - name: escalations
    description: >-
      Chat escalations that require operator review, including message, proposed
      response, and disposition context when available.
  - name: conversations
    description: >-
      Canonical message threads. Use these endpoints to list threads, inspect
      conversation state, read transcripts, and send replies.
  - name: conversation-tags
    description: >-
      Conversation labels, root topics, and subtopics used for classification
      and topic analytics.
  - name: tickets
    description: >-
      Operational queue items tied to conversations, including ticket-scoped
      transcripts and replies.
  - name: calls
    description: Phone call records, transcripts, summaries, and recordings when available.
  - name: reservations
    description: >-
      PMS reservations synced from the workspace's integrations (Hostaway,
      Guesty, Airbnb, etc.), including guest identity, payment status, and stay
      dates.
  - name: appointments
    description: >-
      Scheduled appointments (bookings) backed by the Conduit booking service.
      Exposes allocation context and the upstream booking-service `external_id`.
  - name: helpdesk_tickets
    description: >-
      Helpdesk tickets mirrored from external helpdesk integrations (Zendesk,
      Pylon, Plain), including requester identity and upstream metadata.
  - name: kb
    description: >-
      Knowledge base search and node management. Nodes represent knowledge base
      entries (files or directories), chunks are the indexed retrieval units
      used by search.
  - name: skills
    description: >-
      Workspace agent skills that can be attached to V2 chat agents.
      Sidebar/global-assistant skills are intentionally excluded.
  - name: custom_tools
    description: >-
      Custom code tools: user-authored Python/JavaScript functions executed in a
      sandbox when an agent calls them. Includes a runtimes endpoint describing
      the entrypoint signature, return shape, and available dependencies per
      language.
  - name: inbox_types
    description: >-
      Workspace inbox types. Each id is stable and usable as a message trigger's
      `inboxTypeId` and as the `inbox_type_id` filter on list conversations.
  - name: workflows
    description: >-
      Workspace automation workflows: definitions, executions, and per-execution
      event timelines.
  - name: insights
    description: Aggregated workspace analytics, such as conversation automation rate.
paths:
  /v1/workspaces/{workspace_id}/verification-rules/{id}:
    get:
      tags:
        - portals
      summary: Get Verification Rule
      description: Read one portal verification rule and its full config.
      operationId: getVerificationRule
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Workspace identifier
          required: true
          description: Workspace identifier
          name: workspace_id
          in: path
        - schema:
            type: string
            minLength: 1
            description: Verification rule identifier
          required: true
          description: Verification rule identifier
          name: id
          in: path
      responses:
        '200':
          description: Get Verification Rule
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      workspace_id:
                        type: string
                      name:
                        type: string
                      enabled:
                        type: boolean
                      order:
                        type: number
                      step_type:
                        type: string
                        enum:
                          - id_check
                          - agreement
                          - damage_waiver
                          - security_deposit
                          - mandatory_fee
                          - guest_details
                          - additional_questions
                          - other_guests
                      slot:
                        type: string
                        enum:
                          - identity
                          - agreement
                          - signature
                          - deposit
                          - fee
                          - guest_details
                          - questions
                          - other_guests
                      exclude_returning_guests:
                        type: boolean
                      targeting:
                        type: object
                        properties:
                          bookingChannelMode:
                            type: string
                            enum:
                              - include
                              - exclude
                          bookingChannels:
                            type: array
                            items:
                              type: string
                          minNights:
                            type: number
                            minimum: 0
                          maxNights:
                            type: number
                            minimum: 0
                          maxBookingLeadDays:
                            type: integer
                            minimum: 0
                          matchUnknownBookingLeadTime:
                            type: boolean
                          listingIds:
                            type: array
                            items:
                              type: string
                          listingGroupIds:
                            type: array
                            items:
                              type: string
                              minLength: 1
                        additionalProperties: false
                      config:
                        anyOf:
                          - type: object
                            properties:
                              title:
                                type: string
                                minLength: 1
                              instructions:
                                type: string
                                minLength: 1
                              requireContactPhoto:
                                type: boolean
                              autoApprove:
                                type: boolean
                              provider:
                                type: string
                            required:
                              - title
                              - instructions
                            additionalProperties: false
                          - type: object
                            properties:
                              title:
                                type: string
                                minLength: 1
                              body:
                                type: string
                                minLength: 1
                            required:
                              - title
                              - body
                            additionalProperties: false
                          - type: object
                            properties:
                              title:
                                type: string
                                minLength: 1
                              body:
                                type: string
                                minLength: 1
                              pricing:
                                type: object
                                properties:
                                  model:
                                    type: string
                                    enum:
                                      - flat
                                      - per_night
                                  amountInCents:
                                    type: integer
                                    minimum: 0
                                  currency:
                                    type: string
                                    minLength: 1
                                  capInCents:
                                    type: integer
                                    minimum: 0
                                  minimumNights:
                                    type: integer
                                    minimum: 0
                                required:
                                  - model
                                  - amountInCents
                                  - currency
                                additionalProperties: false
                            required:
                              - title
                              - body
                            additionalProperties: false
                          - type: object
                            properties:
                              title:
                                type: string
                              pdfVersionId:
                                type: string
                              pricing:
                                type: object
                                properties:
                                  model:
                                    type: string
                                    enum:
                                      - flat
                                      - per_night
                                  amountInCents:
                                    type: integer
                                    minimum: 0
                                  currency:
                                    type: string
                                    minLength: 1
                                  capInCents:
                                    type: integer
                                    minimum: 0
                                  minimumNights:
                                    type: integer
                                    minimum: 0
                                required:
                                  - model
                                  - amountInCents
                                  - currency
                                additionalProperties: false
                            required:
                              - title
                              - pdfVersionId
                          - type: object
                            properties:
                              title:
                                type: string
                                minLength: 1
                              instructions:
                                type: string
                                minLength: 1
                              amountInCents:
                                type: integer
                                minimum: 0
                                exclusiveMinimum: true
                              currency:
                                type: string
                                minLength: 1
                              releaseDelayDays:
                                type: integer
                                minimum: 0
                            required:
                              - title
                              - instructions
                              - amountInCents
                              - currency
                            additionalProperties: false
                          - type: object
                            properties:
                              title:
                                type: string
                                minLength: 1
                              instructions:
                                type: string
                                minLength: 1
                              amountInCents:
                                type: integer
                                minimum: 0
                                exclusiveMinimum: true
                              currency:
                                type: string
                                minLength: 1
                            required:
                              - title
                              - instructions
                              - amountInCents
                              - currency
                            additionalProperties: false
                          - type: object
                            properties:
                              title:
                                type: string
                                minLength: 1
                              description:
                                type: string
                              collectEmail:
                                type: boolean
                              collectPhone:
                                type: boolean
                              collectEta:
                                type: boolean
                              collectEtd:
                                type: boolean
                              requiredFields:
                                type: array
                                items:
                                  type: string
                                  enum:
                                    - email
                                    - phone
                                    - eta
                                    - etd
                            required:
                              - title
                              - collectEmail
                              - collectPhone
                              - collectEta
                              - collectEtd
                              - requiredFields
                            additionalProperties: false
                          - type: object
                            properties:
                              title:
                                type: string
                                minLength: 1
                              description:
                                type: string
                              questions:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      minLength: 1
                                    label:
                                      type: string
                                      minLength: 1
                                    type:
                                      type: string
                                      enum:
                                        - text
                                        - long_text
                                        - single_select
                                        - multi_select
                                        - checkbox
                                    required:
                                      type: boolean
                                    helpText:
                                      type: string
                                    placeholder:
                                      type: string
                                    options:
                                      type: array
                                      items:
                                        type: string
                                  required:
                                    - id
                                    - label
                                    - type
                                    - required
                                  additionalProperties: false
                                minItems: 1
                            required:
                              - title
                              - questions
                            additionalProperties: false
                          - type: object
                            properties:
                              title:
                                type: string
                                minLength: 1
                              description:
                                type: string
                              minGuests:
                                type: integer
                                minimum: 0
                              maxGuests:
                                type: integer
                                minimum: 0
                                maximum: 50
                              fields:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      minLength: 1
                                    label:
                                      type: string
                                      minLength: 1
                                    type:
                                      type: string
                                      enum:
                                        - text
                                        - email
                                        - phone
                                        - image
                                    required:
                                      type: boolean
                                  required:
                                    - id
                                    - label
                                    - type
                                    - required
                                  additionalProperties: false
                                maxItems: 20
                            required:
                              - title
                            additionalProperties: false
                      created_at:
                        type: number
                      updated_at:
                        type: number
                    required:
                      - id
                      - workspace_id
                      - name
                      - enabled
                      - order
                      - step_type
                      - slot
                      - targeting
                      - config
                      - created_at
                      - updated_at
                required:
                  - data
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: >-
        Conduit API token. Use `Authorization: Bearer <token>`. Read/write
        endpoints require a token with write access.

````