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

# Get lead completion status

> Read-only pre-flight check reporting whether a lead has the information required to generate a lease. canGenerateLease mirrors exactly the generate-lease validation (system-required tier); isComplete also accounts for org-required fields. Missing-field lists are disjoint.



## OpenAPI

````yaml /openapi/shopping-openapi.json get /shopping/{portfolio}/v1/facilities/{facilityUuid}/lead/{leadUuid}/completion-status
openapi: 3.0.0
info:
  title: Monument Shopping API
  description: Monument Shopping API
  version: '1.0'
  contact: {}
servers:
  - url: https://public-api.prd.monument.io
    description: Production
  - url: https://public-api.stg.monument.io
    description: Staging
security: []
tags:
  - name: Facilities
    description: Facility listing, details, and configuration
  - name: Leads
    description: Lead creation, updates, status, and pre-existing tenant validation
  - name: Shopping Cart
    description: Cart operations and access plans
  - name: Unit Groups
    description: Unit group details and taxes
  - name: Units
    description: Unit and gate access code retrieval
  - name: Payments
    description: Payment profiles and processor information
  - name: Brands
    description: Branding configuration and brand-scoped facilities
  - name: Coverages
    description: Coverage options and private coverage info
  - name: Leases
    description: Lease signing redirects
  - name: Organizations
    description: Portfolio organization information
  - name: Lead Marketing Sources
    description: Marketing source listing
paths:
  /shopping/{portfolio}/v1/facilities/{facilityUuid}/lead/{leadUuid}/completion-status:
    get:
      tags:
        - Facilities
        - Leads
      summary: Get lead completion status
      description: >-
        Read-only pre-flight check reporting whether a lead has the information
        required to generate a lease. canGenerateLease mirrors exactly the
        generate-lease validation (system-required tier); isComplete also
        accounts for org-required fields. Missing-field lists are disjoint.
      operationId: PublicApiFacilitiesController_getLeadCompletionStatus
      parameters:
        - name: facilityUuid
          required: true
          in: path
          schema:
            type: string
        - name: leadUuid
          required: true
          in: path
          schema:
            type: string
        - in: header
          required: true
          name: x-api-key
          schema:
            example: monument-2230012-2312321
            description: >-
              Api key required to authenticate your request. Please reach out to
              monument for a key.
        - in: path
          required: true
          name: portfolio
          schema:
            example: abc_selfstorage
      responses:
        '200':
          description: Lead completion status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadCompletionStatusResponseDto'
        '404':
          description: Lead not found or does not belong to the facility
components:
  schemas:
    LeadCompletionStatusResponseDto:
      type: object
      properties:
        canGenerateLease:
          type: boolean
          example: true
          description: >-
            True when no system-required field is missing and there are no
            errors. Mirrors exactly what the generate-lease validation enforces.
        isComplete:
          type: boolean
          example: false
          description: >-
            True when no required field of either tier (system-required or
            org-required) is missing and there are no errors.
        missingSystemRequiredFields:
          example: []
          description: >-
            Human-readable titles of missing fields that are system-required
            (block lease generation).
          type: array
          items:
            type: string
        missingRequiredFields:
          example:
            - Date of Birth
          description: >-
            Human-readable titles of missing fields that are org-required only
            (do not block lease generation). Disjoint from
            missingSystemRequiredFields.
          type: array
          items:
            type: string
        errors:
          example: []
          description: Validation errors encountered while evaluating the lead.
          type: array
          items:
            type: string
      required:
        - canGenerateLease
        - isComplete
        - missingSystemRequiredFields
        - missingRequiredFields
        - errors

````