Business Gateway Official Copy Document Availability Service

Returns OC1 document availability (title register and title plan) and a collection of OC2 document availability (documents referred to in the register) for a given title number, so a case management system can tell a conveyancer what official copies can actually be ordered before ordering them. Two OpenAPI 3.0.0 contracts are published and harvested — v1 on /bg2/api/v1 and v2 on /bg2/api/v2 — both securing the single GET operation with HTTP Basic.

OpenAPI Specification

hm-land-registry-official-copy-document-availability-v2-openapi.json Raw ↑
{
  "openapi": "3.0.0",
  "info": {
    "title": "Official Copy Document Availability Service",
    "description": "A specification for the HMLR Business Gateway official copies document availability service.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://businessgateway.landregistry.gov.uk/bg2/api/v2"
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "tags": [
    {
      "name": "Official Copies",
      "description": "Document information related to a title."
    }
  ],
  "paths": {
    "/titles/{title_number}/official-copies/availability": {
      "get": {
        "operationId": "getOfficialCopiesAvailability",
        "tags": [
          "Official Copies"
        ],
        "summary": "Get document availability associated with a title number.",
        "description": "Returns the OC1 document availability (title register and title plan) and a collection of OC2 document availability (referred to in the register) for the provided title number.",
        "parameters": [
          {
            "$ref": "#/components/parameters/TitleNumberParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "data"
                  ],
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/OfficialCopiesResponse"
                    }
                  }
                },
                "examples": {
                  "1: Title is valid and has the register immediately available": {
                    "value": {
                      "data": {
                        "title_status": "Title number is valid.",
                        "title_status_code": "VALID",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Title Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "2: Title is valid and does not have the register immediately available": {
                    "value": {
                      "data": {
                        "title_status": "Title number is valid.",
                        "title_status_code": "VALID",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "requires further investigation",
                          "availability_code": "MANUAL",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "3: Title is valid and has the title plan immediately available": {
                    "value": {
                      "data": {
                        "title_status": "Title number is valid.",
                        "title_status_code": "VALID",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "4: Title is valid and does not have the title plan immediately available": {
                    "value": {
                      "data": {
                        "title_status": "Title number is valid.",
                        "title_status_code": "VALID",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "requires further investigation",
                          "availability_code": "MANUAL",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "5: Title is valid, has pending correction applications against it and has the register immediately available": {
                    "value": {
                      "data": {
                        "title_status": "There is at least one pending application for registration against this title number. You may want to view the day list.",
                        "title_status_code": "PENDING_APPLICATIONS",
                        "title_number": "AB000000",
                        "applications_pending": true,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "6: Title is valid, has pending correction applications against it and does not have the register immediately available": {
                    "value": {
                      "data": {
                        "title_status": "There is at least one pending application for registration against this title number. You may want to view the day list.",
                        "title_status_code": "PENDING_APPLICATIONS",
                        "title_number": "AB000000",
                        "applications_pending": true,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "requires further investigation",
                          "availability_code": "MANUAL",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "7: Title is valid, has pending correction applications against it and has the title plan immediately available": {
                    "value": {
                      "data": {
                        "title_status": "There is at least one pending application for registration against this title number. You may want to view the day list.",
                        "title_status_code": "PENDING_APPLICATIONS",
                        "title_number": "AB000000",
                        "applications_pending": true,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "8: Title is valid, has pending correction applications against it and does not have the title plan immediately available": {
                    "value": {
                      "data": {
                        "title_status": "There is at least one pending application for registration against this title number. You may want to view the day list.",
                        "title_status_code": "PENDING_APPLICATIONS",
                        "title_number": "AB000000",
                        "applications_pending": true,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "requires further investigation",
                          "availability_code": "MANUAL",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "9: Title is valid and has pending non-correction applications against it": {
                    "value": {
                      "data": {
                        "title_status": "There is at least one pending application for registration against this title number. You may want to view the day list.",
                        "title_status_code": "PENDING_APPLICATIONS",
                        "title_number": "AB000000",
                        "applications_pending": true,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": true
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": true
                        }
                      }
                    }
                  },
                  "10: Title is valid and closed/cancelled": {
                    "value": {
                      "data": {
                        "title_status": "According to our records this title number has been cancelled (or closed).",
                        "title_status_code": "CLOSED",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "11: Title is valid, closed and continued under another title number": {
                    "value": {
                      "data": {
                        "title_status": "The title number you entered, has been closed and continued under another title number.",
                        "title_status_code": "CLOSED_AND_CONTINUED",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "continued_under_title_number": "AB000001",
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "12: Title is valid but not computerised": {
                    "value": {
                      "data": {
                        "title_status": "No computerised register held for this title. Please check the title number.",
                        "title_status_code": "NOT_COMPUTERISED",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "13: Title is valid, is a pending new title or has pending dealings against it": {
                    "value": {
                      "data": {
                        "title_status": "This is a pending new title number allocated for a dealing with the whole. Only document requests can be accepted against it.",
                        "title_status_code": "PENDING_DEALING",
                        "title_number": "AB000000",
                        "applications_pending": true,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "14: Title is valid but is a scheme title": {
                    "value": {
                      "data": {
                        "title_status": "This is a scheme title number allocated prior to receipt of the first application. Only document requests can be accepted against it.",
                        "title_status_code": "SCHEME",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability": "not available",
                          "availability_code": "UNAVAILABLE",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "15: Title is valid and has register referred to documents": {
                    "value": {
                      "data": {
                        "title_status": "Title number is valid.",
                        "title_status_code": "VALID",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [
                          {
                            "type": "Abstract",
                            "type_code": "ABSTRACT",
                            "entry_numbers": [
                              "A1"
                            ],
                            "date": "2020-12-01",
                            "filed_under": "AB000000",
                            "availability": "available for immediate download",
                            "availability_code": "IMMEDIATE",
                            "plan_only": true
                          }
                        ],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability_code": "UNAVAILABLE",
                          "availability": "not available",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "16: Title is valid and has no register referred to documents": {
                    "value": {
                      "data": {
                        "title_status": "Title number is valid.",
                        "title_status_code": "VALID",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability_code": "UNAVAILABLE",
                          "availability": "not available",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "17: Title is valid, closed/cancelled and has register referred to documents": {
                    "value": {
                      "data": {
                        "title_status": "According to our records this title number has been cancelled (or closed).",
                        "title_status_code": "CLOSED",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [
                          {
                            "type": "Abstract",
                            "type_code": "ABSTRACT",
                            "entry_numbers": [
                              "A1"
                            ],
                            "date": "2020-12-01",
                            "filed_under": "AB000000",
                            "availability": "available for immediate download",
                            "availability_code": "IMMEDIATE",
                            "plan_only": false
                          }
                        ],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability_code": "UNAVAILABLE",
                          "availability": "not available",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "18: Title is valid, closed/cancelled and has no register referred to documents": {
                    "value": {
                      "data": {
                        "title_status": "According to our records this title number has been cancelled (or closed).",
                        "title_status_code": "CLOSED",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability_code": "UNAVAILABLE",
                          "availability": "not available",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "19: Title is valid, has pending non-correction applications against it and has register referred to documents": {
                    "value": {
                      "data": {
                        "title_status": "There is at least one pending application for registration against this title number. You may want to view the day list.",
                        "title_status_code": "PENDING_APPLICATIONS",
                        "title_number": "AB000000",
                        "applications_pending": true,
                        "referred_to_documents": [
                          {
                            "type": "Charge",
                            "type_code": "CHARGE",
                            "entry_numbers": [
                              "A1"
                            ],
                            "date": "2020-12-01",
                            "filed_under": null,
                            "availability": "available for immediate download",
                            "availability_code": "IMMEDIATE",
                            "plan_only": false
                          }
                        ],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability_code": "UNAVAILABLE",
                          "availability": "not available",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "20: Title is valid, has pending non-correction applications against it and has no register referred to documents": {
                    "value": {
                      "data": {
                        "title_status": "There is at least one pending application for registration against this title number. You may want to view the day list.",
                        "title_status_code": "PENDING_APPLICATIONS",
                        "title_number": "AB000000",
                        "applications_pending": true,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability_code": "UNAVAILABLE",
                          "availability": "not available",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "21: Title is valid, has pending correction applications against it and has register referred to documents": {
                    "value": {
                      "data": {
                        "title_status": "There is at least one pending application for registration against this title number. You may want to view the day list.",
                        "title_status_code": "PENDING_APPLICATIONS",
                        "title_number": "AB000000",
                        "applications_pending": true,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability_code": "UNAVAILABLE",
                          "availability": "not available",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "22: Title is valid, has pending correction applications against it and has no register referred to documents": {
                    "value": {
                      "data": {
                        "title_status": "There is at least one pending application for registration against this title number. You may want to view the day list.",
                        "title_status_code": "PENDING_APPLICATIONS",
                        "title_number": "AB000000",
                        "applications_pending": true,
                        "referred_to_documents": [],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability_code": "UNAVAILABLE",
                          "availability": "not available",
                          "backdated": false
                        }
                      }
                    }
                  },
                  "23: Title is valid, is a scheme title and has register referred to documents": {
                    "value": {
                      "data": {
                        "title_status": "This is a scheme title number allocated prior to receipt of the first application. Only document requests can be accepted against it.",
                        "title_status_code": "SCHEME",
                        "title_number": "AB000000",
                        "applications_pending": false,
                        "referred_to_documents": [
                          {
                            "type": "Abstract",
                            "type_code": "ABSTRACT",
                            "entry_numbers": [
                              "A1"
                            ],
                            "date": "2020-12-01",
                            "filed_under": "AB000000",
                            "availability": "available for immediate download",
                            "availability_code": "IMMEDIATE",
                            "plan_only": false
                          }
                        ],
                        "register": {
                          "type": "Register",
                          "type_code": "REGISTER",
                          "availability": "available for immediate download",
                          "availability_code": "IMMEDIATE",
                          "backdated": false
                        },
                        "title_plan": {
                          "type": "Plan",
                          "type_code": "TITLEPLAN",
                          "availability_code": "UNAVAILABLE",
                          "availability": "not available",
                          "back

# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hm-land-registry/refs/heads/main/openapi/hm-land-registry-official-copy-document-availability-v2-openapi.json