FindBroadband

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "postcode",
    "monthly_bill",
    "current_speed_mbps",
    "current_provider"
  ],
  "properties": {
    "uprn": {
      "type": "string",
      "pattern": "^\\d{6,14}$",
      "description": "Property identifier from search_addresses. Pass it whenever the user has picked an address so results become address-precise instead of postcode-wide. Never show this number to the user."
    },
    "postcode": {
      "type": "string",
      "maxLength": 10,
      "minLength": 5,
      "description": "UK postcode, e.g. 'SS13 1HJ'. When asking, request the postcode and house number or name together in one question rather than two rounds."
    },
    "quote_type": {
      "enum": [
        "current_bill",
        "renewal_offer"
      ],
      "type": "string",
      "description": "'renewal_offer' when the user is evaluating a renewal or retention price their provider quoted; 'current_bill' (default) when it is what they pay today."
    },
    "monthly_bill": {
      "type": "number",
      "maximum": 500,
      "description": "What the user currently pays per month in GBP (or the renewal price quoted to them).",
      "exclusiveMinimum": 0
    },
    "address_label": {
      "type": "string",
      "maxLength": 160,
      "description": "The display_address the user picked from search_addresses, passed back verbatim. Carried into the switch link so the FindBroadband site greets the user with their address instead of asking again."
    },
    "current_provider": {
      "type": "string",
      "maxLength": 60,
      "minLength": 2,
      "description": "The user's current broadband provider, as they said it, e.g. 'Sky' or 'Virgin Media'."
    },
    "current_speed_mbps": {
      "type": "number",
      "maximum": 10000,
      "description": "The user's current download speed in Mbps. If they only know their package name, ask or estimate from the provider's naming (e.g. 'M125' is about 132).",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "deal_id"
  ],
  "properties": {
    "uprn": {
      "type": "string",
      "pattern": "^\\d{6,14}$",
      "description": "Property identifier from search_addresses. Pass it whenever the user has picked an address so results become address-precise instead of postcode-wide. Never show this number to the user."
    },
    "deal_id": {
      "type": "string",
      "pattern": "^\\d{1,12}$",
      "description": "The deal_id from a previous find_broadband_deals or check_if_overpaying result."
    },
    "postcode": {
      "type": "string",
      "maxLength": 10,
      "minLength": 5,
      "description": "Pass the user's postcode when known so availability is checked at their address."
    },
    "address_label": {
      "type": "string",
      "maxLength": 160,
      "description": "The display_address the user picked from search_addresses, passed back verbatim. Carried into the switch link so the FindBroadband site greets the user with their address instead of asking again."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "postcode"
  ],
  "properties": {
    "postcode": {
      "type": "string",
      "maxLength": 10,
      "minLength": 5,
      "description": "UK postcode, e.g. 'SS13 1HJ'. When asking, request the postcode and house number or name together in one question rather than two rounds."
    }
  },
  "additionalProperties": false
}