Skip to main content
GET
Get lead completion status

Headers

x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

facilityUuid
string
required
leadUuid
string
required

Response

Lead completion status

canGenerateLease
boolean
required

True when no system-required field is missing and there are no errors. Mirrors exactly what the generate-lease validation enforces.

Example:

true

isComplete
boolean
required

True when no required field of either tier (system-required or org-required) is missing and there are no errors.

Example:

false

missingSystemRequiredFields
string[]
required

Human-readable titles of missing fields that are system-required (block lease generation).

Example:
missingRequiredFields
string[]
required

Human-readable titles of missing fields that are org-required only (do not block lease generation). Disjoint from missingSystemRequiredFields.

Example:
errors
string[]
required

Validation errors encountered while evaluating the lead.

Example: