CheckResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/lettance-com/json-schema/lettance-com-check-response-schema.json",
  "title": "CheckResponse",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lettance-com-openapi.json#/components/schemas/CheckResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/$defs/CheckResult"
    },
    "meta": {
      "$ref": "#/$defs/Meta"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "$defs": {
    "CheckResult": {
      "type": "object",
      "properties": {
        "postcode": {
          "type": "string"
        },
        "ward": {
          "type": [
            "string",
            "null"
          ]
        },
        "council": {
          "type": [
            "string",
            "null"
          ]
        },
        "household": {
          "type": "string",
          "enum": [
            "single",
            "small_hmo",
            "large_hmo"
          ]
        },
        "licence": {
          "type": "object",
          "properties": {
            "needed": {
              "type": "string",
              "enum": [
                "yes",
                "no",
                "check"
              ],
              "description": "check means the answer depends on something a postcode cannot settle, or the council is not researched yet. It never means no."
            },
            "summary": {
              "type": "string"
            },
            "schemes": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/CheckScheme"
              }
            }
          },
          "required": [
            "needed",
            "summary",
            "schemes"
          ]
        },
        "register": {
          "anyOf": [
            {
              "$ref": "#/$defs/RegisterWindow"
            },
            {
              "type": "null"
            }
          ]
        },
        "registerSources": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "Absolute URL"
          }
        },
        "registerCheckedAt": {
          "type": "string",
          "description": "ISO date, YYYY-MM-DD"
        },
        "planningSource": {
          "type": "string",
          "description": "Absolute URL"
        },
        "planningAvailability": {
          "type": "object",
          "properties": {
            "floodZone": {
              "type": "string",
              "enum": [
                "available",
                "unavailable"
              ]
            },
            "conservationAreas": {
              "type": "string",
              "enum": [
                "available",
                "unavailable"
              ]
            },
            "article4": {
              "type": "string",
              "enum": [
                "available",
                "unavailable"
              ]
            }
          },
          "required": [
            "floodZone",
            "conservationAreas",
            "article4"
          ]
        },
        "openQuestions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "floodZone": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "level": {
                  "anyOf": [
                    {
                      "type": "number",
                      "const": 2
                    },
                    {
                      "type": "number",
                      "const": 3
                    }
                  ]
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "level",
                "source"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "conservationAreas": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            {
              "type": "null"
            }
          ],
          "description": "null when the dataset was unavailable; empty when the lookup found none at the postcode centre."
        },
        "article4Directions": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "url": {
                    "anyOf": [
                      {
                        "type": "string",
                        "description": "Absolute URL"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "required": [
                  "name",
                  "description",
                  "url"
                ]
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "councilPage": {
          "anyOf": [
            {
              "type": "string",
              "description": "Absolute URL"
            },
            {
              "type": "null"
            }
          ]
        },
        "researched": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO date, YYYY-MM-DD"
            },
            {
              "type": "null"
            }
          ],
          "description": "When the council's licensing was researched; null if not researched yet."
        },
        "verified": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO date, YYYY-MM-DD"
            },
            {
              "type": "null"
            }
          ]
        },
        "limitations": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "postcode",
        "ward",
        "council",
        "household",
        "licence",
        "register",
        "registerSources",
        "registerCheckedAt",
        "planningSource",
        "planningAvailability",
        "openQuestions",
        "floodZone",
        "conservationAreas",
        "article4Directions",
        "councilPage",
        "researched",
        "verified",
        "limitations"
      ]
    },
    "CheckScheme": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "selective",
            "additional",
            "mandatory_hmo"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "in_force",
            "approved_not_started",
            "consultation",
            "expired",
            "quashed",
            "revoked"
          ]
        },
        "covers": {
          "type": "string",
          "enum": [
            "yes",
            "check"
          ],
          "description": "yes: the postcode's ward is inside the scheme. check: confirm the boundary or property criteria with the council."
        },
        "reason": {
          "type": "string"
        },
        "start": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO date, YYYY-MM-DD"
            },
            {
              "type": "null"
            }
          ]
        },
        "end": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO date, YYYY-MM-DD"
            },
            {
              "type": "null"
            }
          ],
          "description": "The last day the scheme is certainly in force."
        },
        "ceasesOn": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO date, YYYY-MM-DD"
            },
            {
              "type": "null"
            }
          ],
          "description": "The notice's \"ceases to have effect on\" date, the day after end, when recorded. On that day covers is check."
        },
        "endDateUncertainUntil": {
          "anyOf": [
            {
              "type": "string",
              "description": "ISO date, YYYY-MM-DD"
            },
            {
              "type": "null"
            }
          ],
          "description": "Last disputed day when primary sources conflict. From ceasesOn through this date covers is check, not proof that a licence is required or unnecessary."
        },
        "feeGbp": {
          "description": "The published standard figure, which may be per room or unit rather than a total. Read feeNotes for the charging basis, supplements and conditions. No property-specific total has been calculated.",
          "type": [
            "number",
            "null"
          ]
        },
        "feeNotes": {
          "description": "The council research's fee conditions, including any charging unit, supplements or discounts. Null means these details have not been recorded.",
          "type": [
            "string",
            "null"
          ]
        },
        "licenceLengthYears": {
          "description": "The published licence term in years, where recorded. This does not turn feeGbp into a total charge for that period.",
          "type": [
            "number",
            "null"
          ]
        },
        "appliesTo": {
          "type": "string"
        },
        "exemptions": {
          "type": [
            "string",
            "null"
          ]
        },
        "confidence": {
          "type": "string",
          "enum": [
            "high",
            "medium",
            "low"
          ],
          "description": "How sure the research is. Medium or low means read the linked source before relying on it."
        },
        "notes": {
          "type": [
            "string",
            "null"
          ]
        },
        "apply": {
          "anyOf": [
            {
              "type": "string",
              "description": "Absolute URL"
            },
            {
              "type": "null"
            }
          ]
        },
        "sources": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "Absolute URL"
          }
        }
      },
      "required": [
        "name",
        "type",
        "status",
        "covers",
        "reason",
        "start",
        "end",
        "ceasesOn",
        "endDateUncertainUntil",
        "feeGbp",
        "feeNotes",
        "licenceLengthYears",
        "appliesTo",
        "exemptions",
        "confidence",
        "notes",
        "apply",
        "sources"
      ]
    },
    "Meta": {
      "type": "object",
      "properties": {
        "sources": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "Absolute URL"
          },
          "description": "Distinct upstream sources this response draws on: legislation, GOV.UK guidance, council pages and data services."
        },
        "coverage": {
          "type": "string",
          "description": "How much of England the council licensing research covers today."
        },
        "notice": {
          "type": "string",
          "description": "How to use this answer. It is information, not legal advice."
        },
        "catalogueDate": {
          "type": "string",
          "description": "The catalogue edition this response was built from."
        },
        "links": {
          "type": "object",
          "properties": {
            "documentation": {
              "type": "string",
              "description": "Absolute URL"
            },
            "openapi": {
              "type": "string",
              "description": "Absolute URL"
            },
            "html": {
              "description": "The human page for this answer.",
              "type": "string"
            },
            "markdown": {
              "description": "The same page as Markdown, for agents.",
              "type": "string"
            }
          },
          "required": [
            "documentation",
            "openapi"
          ]
        }
      },
      "required": [
        "sources",
        "coverage",
        "notice",
        "catalogueDate",
        "links"
      ],
      "description": "Sources, coverage and links. Present on every response, including errors."
    },
    "RegisterWindow": {
      "type": "object",
      "properties": {
        "region": {
          "type": "string"
        },
        "opens": {
          "type": "string",
          "description": "ISO date, YYYY-MM-DD"
        },
        "deadline": {
          "type": "string",
          "description": "ISO date, YYYY-MM-DD"
        },
        "earlyRegistrationFrom": {
          "type": "string",
          "description": "ISO date, YYYY-MM-DD"
        },
        "feeGbp": {
          "type": "number"
        },
        "status": {
          "type": "string",
          "const": "planned"
        },
        "note": {
          "type": "string"
        },
        "rule": {
          "type": "string",
          "description": "Absolute URL"
        }
      },
      "required": [
        "region",
        "opens",
        "deadline",
        "earlyRegistrationFrom",
        "feeGbp",
        "status",
        "note",
        "rule"
      ],
      "description": "The planned landlord register (Private Rented Sector Database) window for the region. The regulations are in draft."
    }
  }
}