This document provided the interface requirements for the eDocument Registration Service V2_1 Business Gateway service.
2. Purpose
The purpose of this document is to specify the interface between Land Registry and a Business Gateway Customer, indicating the message layouts and XML schemas that must be adhered to in order to communicate with LR, so that data may be exchanged between the organisations to effect Business Gateway.
The XML schemas associated with this interface represent the authoritative definition of the interface and takes precedence over any information in this document. The schemas will be issued with this document, along with sample requests.
3. Scope
The scope of this document encompasses the eDocument Registration Service V2_1 interface and XML message format.
4. Definitions, Acronyms and Abbreviations
Any specific terms and abbreviations are further explained in the Glossary.
5. XML requirements
5.1 XML Requirements
The XML schema attached as part of this document is compliant with ‘XML Schema W3C Recommendation’, 04 Feb 2004 and e-GIF standards. The XML version is 1.0 and encoding is UTF-8.
In an XML message, use of the characters &, <, “ and ‘ is constrained. The characters & and < are permitted to represent themselves only in Comments, Processing Instructions and CDATA sections. The characters “ and ‘ cannot appear in an attribute if they are being used to demarcate the value.
Escape sequences are used to represent these characters when required. These escape sequences are:
Character
Escape sequence
&
“&”
<
“<”
>
“>”
“
”"“
‘
”'“
Within CDATA blocks the above characters are permitted and escape sequences must not be used. CDATA blocks are used for attachments to messages.
6. eDocument Registration Services
6.1 eDocument Registration Service V2_1 Specific Messages
Schema:
RequestApplicationToChangeRegisterV2_1
ResponseApplicationToChangeRegisterV2_1
Description:
Submits an application to change the register, providing details of the application type, representations and parties. Returns an acknowledgement on initial submission, followed by a response when application is completed including a ZIP file with responses documents. The response will be one of the following.
Acknowledgment confirming the request has been accepted.
A success response will include a ZIP file, normally containing an RCS, TID and copy of updated register and an XML copy of the register. The response will advise if the application has been completed under early completion. The response will advise if the application has been cancelled with a letter detailing the reason for cancellation.
Rejection may comprise multiple validation errors each containing a code and description of the reason for rejection.
Schema:
CorrespondenceV1_0
Description:
These are requests from Land Registry for requisitions, so the message ID is not one the user provided. The service must be monitored polling the Outstanding Requests Service and collecting any CorrespondenceV1_0 responses identified as available.
The response will contain the MessageId and the external reference from the application it relates to. It will also contain a PDF detailing the Requisition correspondence.
Schema:
AttachmentV2_1
AttachmentResponseV2_0
Description:
Submits documents detailed in the application, replies to Requisitions or additional documents. Documents detailed in the application must use the ApplicationPriority or Supporting Document Id as the Attachment Id.
Acknowledgement that attachment received, if out of hours.
Response confirming the attachment has been accepted.
Rejection may just contain a reason and code elements, or the reason and code elements may contain generic messages i.e. BatchException and BatchExceptionCode , then the message will contain one or more ValidationErrors elements. The ValidationErrors will contain a code and description providing the rejection reason.
Schema:
ResponseEarlyCompletionV2_0
Description:
Response created by Land Registry when the request to cancel entries relating to a registered charge (Mortgage) arrives for an application which was completed under Early Completion. This service must be monitored using the Outstanding Requests service.
The Response will contain a ZIP file with a Notification of Discharge letter and an updated Official Copy of the register. The Response also contains an XML version of the register, comprising an OCSummaryData section highlighting specific information from the register and also a full XML version of the register.
Schema:
PollRequest
Description:
Polls for the response for an application indicated as available by the Outstanding Requests service
The response to an e-Document Registration application, may include PDF results if it is the final response.
7. RequestApplicationtoChangeRegisterV2_1
7.1 Request message
The RequestApplicationToChangeRegisterV2_1 request message uses the namespace http://www.oscre.org/ns/eReg-Final/2012/RequestApplicationToChangeRegisterV2_1 and must be valid with respect to the XML Schema published by the Land Registry for that namespace.
Message
Description
RequestApplicationToChangeRegisterV2_1
This message allows Customers to submit Request Application to Change the Register to HMLR.
7.2 Message structure
The request message comprises:
Generic header information (common with requests for other services).
Information specific to the RequestApplicationToChangeRegisterV2_1 request. This is illustrated below:
7.3 Specific elements
The request message breakdown is illustrated below:
Element
Description
Rules for Use
AdditionalProviderFilter
A value that can be used to subsequently retrieve request responses based upon high level grouping. This will be of particular interest to cloud providers.
Mandatory
MessageId
A unique reference associated with the application in the
Case Management System.
Mandatory
ExternalReference
Reference associated with a case in Case Management
System.
Customer reference for the person submitting the request. See ReferenceTypeContent for more details.
Section 14
Mandatory
TotalFeeInPence
Non negative integer.
Section 4
Mandatory
Email
Contact email for the person submitting the application.
Section 7
Mandatory
TelephoneNumber
Contact telephone number for the person submitting the application.
Section 7
Mandatory
AP1WarningUnderstood
* True or false.
Signified by signing
Mandatory
ApplicationDate
Date of the application.
Section 15
Mandatory
DisclosureOveridingInterest
This application relates to a registerable disposition and disclosable overriding interests affect the registered estate. Value - True or false.
Section 11
Mandatory
PostcodeOfProperty
Postcode of property application relates to.
Section 1
Optional
LocalAuthority
Local Authority serving the property.
Section 1
Optional
Titles
Details of this applications service type. See ServiceTitlesType for more details.
Section 2
Mandatory
Applications
Provide multiple ApplicationsType with details of either a Charge application or other application type. See ApplicationsType for more details.
Section 4
Mandatory
SupportingDocuments
Details of any documents being submitted to support the application. See SupportingDocumentsType for more details.
Section 5
Optional
Representation
Details of the conveyance(s) representing the parties in the transaction.
Section 13 and 14
Mandatory
Parties
Details of parties
Section 6
Mandatory
AdditionalPartyNotifications
Details of any third party to be notified on completion of the application. Please note: while this remains in the schema, HMLR no longer actions third party notifications.
Section 8
Optional
Notes
This is a free format notepad area for any additional notes.
Optional
ApplicationAffects
Details how much of the title the application affects. See ApplicationAffectsContent for more details.
Section 3
Mandatory
AP1 Warning
Note: AP1 Form column indicates where on the paper form this data is inserted.
If you dishonestly enter information or make a statement that you know is, or might be, untrue or misleading, and intend by doing so to make a gain for yourself or another person, or to cause loss or the risk of loss to another person, you may commit the offence of fraud under section 1 of the Fraud Act 2006, the maximum penalty for which is 10 years’ imprisonment or an unlimited fine, or both.
Failure to complete this form with proper care may result in a loss of protection under the Land Registration Act 2002 if, as a result, a mistake is made in the register.
Under section 66 of the Land Registration Act 2002 most documents (including this form) kept by the registrar relating to an application to the registrar or referred to in the register are open to public inspection and copying. If you believe a document contains prejudicial information, you may apply for that part of the document to be made exempt using Form EX1, under rule 136 of the Land Registration Rules 2003.
Will contain TitleNumber element(s). See DealingType for more details.
Choice
TransferOfPart
Will contain TitleNumber element(s) for the Transferor title(s), plus the option of an additional title(s) where required. See TransferOfPartType for more details.
Choice
NewLease
Will containTitleNumber element(s) for the Lessor title(s), plus the option of an additional title(s) where required. See NewLeaseType for more details.
Choice
LeaseExtension
Will containTitleNumber element(s) for the Lessor title(s) and a TitleNumber element for the existing Lessee title. Plus the option of an additional title(s) where required.See LeaseExtensionType for more details.
Provides details of application other than a charge. Includes priority of documents contained in request, application value, fee in pence and the document type. See ApplicationType for more details. Extended with mandatory Type element, which contains a string value of type i.e. Lease or COA etc. See ApplicationTypeContent for more details.
A unique number indicating the priority order of application documents supplied in the request. This unique identifier must be included as the DocumentID in any supporting documents.
Mandatory
Value
Application Price paid/Value.
Mandatory
FeeInPence
Application fee in pence.
Mandatory
Document
Provides details of the document that will be attached (The only application types that allow no document are DIS and COA) See DocumentType for more details.
Contains a CertifiedCopy element with a string value of CertifiedTypeContent. Enumeration values are Original, Certified or Scanned. See Certified Copy Values for more details
A unique identifier (number) for each supporting document supplied in the request. This should be different from the identifiers used as application Priority. This unique identifier must be included as the DocumentID in any supporting documents.
Mandatory
SupportingDocument
A unique identifier (number) for each supporting document supplied in the request. This should be different from the identifiers used as application Priority. This unique identifier must be included as the DocumentID in any supporting documents.
Mandatory
DocumentName
Contains a DocumentNameContent with an enumeration of string values. See DocumentNameContent for more details.
Contains the postal address information. See PostalAddressType for more details.
Choice
AdditionalAddresses
Only allowed if PostalAddress selected. Contains an additional address for service if appropriate. See AdditionalAddressForServiceType for more detail.
Optional
AddressForServiceOption
String values are A1, B1 or TA, where A1 is the address of the property (A1 register), B1 is current proprietor address (B1 register) and TA is address from Transfer/Assent.
Choice
This element must contain either an Address for service option or Address(es) for the Party. If Address(es) are supplied there MUST be Postal address and can optionally be up to 2 more addresses of any type.
ResponseApplicationToChangeRegisterV2_0 Response messages use the namespace http://www.oscre.org/ns/eReg-Final/2012/ResponseApplicationToChangeRegisterV2_0 and must be valid with respect to the XML Schema published by the Land Registry for that namespace.
Message
Description
ResponseApplicationToChangeRegisterV2_0
This message allows Land Registry to send Application to Change Register V2_0 Responses to the Customer.
8.2 Message structure
The response message comprises generic information common with responses to other services, plus information specific to the Application to Change the Register V2_0 response. This is illustrated below:
8.3 Specific element
The GatewayResponseType response structure is illustrated below:
Represents the date and time at which the Office Copy data is taken. Is a DateTimeType.
Mandatory
EditionDate
Edition of register date. Is DateType.
Mandatory
PricePaidEntry
Provides price paid information from the register. See Q1PricePaidEntryType for more details.
Optional
PropertyAddress
Contains a Q1AddressType with details of the address.
Mandatory [1..*]
Title
Contains further information about the title. See Q1TitleType
Mandatory
RegisterEntryIndicators
The following indicator elements with value true or false. See Q1RegisterEntryIndicatorsType for details of all the indicators.
Mandatory
Proprietorship
Contains the proprietor details, plus an optional date of the proprietorship entry in the register. See Q1ProprietorshipType for more details.
Mandatory
Lease
Q1LeaseEntriesType can have one or more ‘LeaseEntry’ elements. See Q1LeaseType for more details.
Optional
RestrictionDetails
Q1RestrictionEntryType can have one or more ‘RestrictionEntry’ elements. See Q1RestrictionEntryType for more details.
Optional
Charge
Q1ChargeEntriesType will have one or more ‘ChargeEntry’ elements. See Q1ChargeDetailsType for more details.
Optional
AgreedNotice
Q1AgreedNoticeEntriesType will have one or more ‘AgreedNoticeEntry’ elements. See Q1AgreedNoticeType for more details.
Optional
Bankruptcy
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Bankruptcy entries. See Q1EntryDetailsType for more detail.
Optional
Caution
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Caution entries. See Q1EntryDetailsType for more detail.
Optional
DeedOfPostponement
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Deed of Postponement entries. See Q1EntryDetailsType for more detail.
Optional
GreenOutEntry
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Green Out entries. See Q1EntryDetailsType for more detail.
Optional
HomeRights
Q1HomeRightsEntriesType will have one or more ‘HomeRightsEntry’ elements. See Q1HomeRightsType for more detail.
Optional
RentCharge
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Rent Charge entries. See Q1EntryDetailsType for more detail.
Optional
VendorsLien
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Vendors Lien entries. See Q1EntryDetailsType for more detail.
Optional
RightOfPreEmption
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Right of Pre-emption entries. See Q1EntryDetailsType for more detail.
Optional
DocumentDetails
Q1DocumentDetailsType will have one or more ‘Document’ elements. See Q1DocumentEntryType for more details.
Optional
UnilateralNoticeDetails
Q1UnilateralNoticeEntriesType will have one or more ‘UnilateralNoticeEntry’ elements detailing the Unilateral Notice. See Q1UnilateralNoticeDetailsType for more details.
Optional
DeathOfProprietor
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Death of Proprietor entries. See Q1EntryDetailsType for more detail.
Optional
DiscountCharge
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Discount Charge entries. See Q1EntryDetailsType for more detail.
Optional
EquitableCharge
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Equitable Charge entries. See Q1EntryDetailsType for more detail.
Optional
NotedCharge
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Noted Charge entries. See Q1EntryDetailsType for more detail.
Optional
CreditorsNotice
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Creditors Charge entries. See Q1EntryDetailsType for more detail.
Optional
UnidentifiedEntity
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of Unidentified Entry entries. See Q1EntryDetailsType for more detail.
Optional
CCBIEntry
Q1EntriesType will have one or more ‘EntryDetails’ elements, containing details of CCBI Entry entries. See Q1EntryDetailsType for more detail.
String description of the type of schedule i.e. Schedule of Restrictive Covenants.
Mandatory
ScheduleEntry
Contains information about the schedule entry. See RegisterEntryType for more detail.
Mandatory [1..*]
9 CorrespondenceV1_0
9.1 Response message
CorrespondenceV1_0 response messages use the namespace http://www.oscre.org/ns/eReg-Final/2012/CorrespondenceV1_0 and must be valid with respect to the XML Schema published by the Land Registry for that namespace.
Message
Description
CorrespondenceV1_0
This message allows Land Registry to initiate Requisition requests to be sent, using Correspondence V1_0 responses to the customer.
9.2 Message Structure
The response message comprises generic information common with responses to other services, plus information specific to the Corresponence V1_0 response. This is illustrated below:
9.3 Specific Elements
The GatewayResponseType response structure is illustrated below:
Element
Description
Rules for Use
TypeCode
ProductResponseCodeContentType will have an enumeration value of 31.
Mandatory
ApplicationMessageId
String value containing the message ID of the Application to Change the Register request that the correspondence relates to.
Mandatory
ExternalReference
String value of the customers supplied reference to help them identify the case correspondence relates to.
Mandatory
ABR
String value of the Land Registry’s application barcode reference.
Optional
Correspondence
Details information about the attached correspondence. Has attributes filename and format. Element contains base64Binary data of attached file.
Mandatory
10 RequestAttachmentV2_1
10.1 Attachment message
The Attachment V2_1 Request message uses the namespace http://www.oscre.org/ns/eReg-Final/2012/RequestAttachmentV2_1 and must be valid with respect to the XML Schema published by the Land Registry for that namespace.
Message
Description
RequestAttachmentV2_1
This message allows Customers to submit to HMLR Attachments to support a previously submitted Request Application to Change the Register.
10.2 Message Structure
The request message comprises generic header information which is common with requests for other services, plus information specific to the RequestAttachmentV2_1 request. This is illustrated below:
10.3 Specific Elements
Element
Description
Rules for Use
AdditionalProviderFilterType
A value that can be used to subsequently retrieve request responsesbased upon high level grouping. This will be of particular interest to cloud providers.
Mandatory
MessageId
MessageIdType is a string value of the requests unique message ID.
Mandatory
ExternalReference
ReferenceTypeContent is a string value of external reference.
Mandatory
ApplicationMessageId
MessageIdType is a string value of the original Request To Change the Register applications message ID to which the attachment relates.
Mandatory
ApplicationService
Is an integer value for the Service ID for the Application to Change the Register (Currently 104).
Mandatory
Notes
Free format notepad area for additional notes.
Choice
Alternative choice sequence
See below for detail.
Choice
Choice sequence if not Notes:
Element
Description
Rules for Use
AttachmentId
Integer is the unique attachment identifier and should be set to the application priority or supporting document ID in the original Application to Change the Register request.
String enumeration values are ‘Original’, ‘Certified’ or ‘Scanned’.See Certified Copy Values for more details.
Mandatory
Attachment
Contains attributes for filename and format, the element contains base64Binary data for the attachment document.
Mandatory
11.1 Response message
The Attachment Response V2_0 Response message uses the namespace http://www.oscre.org/ns/eReg-Final/2012/ResponseAttachmentV2_0 and must be valid with respect to the XML Schema published by the Land Registry for that namespace.
Message
Description
RequestAttachmentV2_0
The response message to a Request Attachment V2_0 request, maybe Acknowledgement if out of hours, a rejection if something wrong with the attachment or a Result accepting the attachment.
11.2 Message Structure
The response message comprises generic header information which is common with responses for other services, plus information specific to the ResponseAttachmentV2_0 response. This is illustrated below:
11.3 Specific Elements
Element
Description
Rules for Use
TypeCode
String enumeration values:
Value ‘0’ is Other
Value ‘10’ is Acknowledgement
Value ‘20’ is Rejection
Value ‘30’ is Result
Mandatory
Acknowledgement
If out of hours the Acknowledgement will contain the expected time the request will be processed. See AcknowledgementType for more detail.
Optional
Rejection
If the attachment is not accepted, details of rejection provided. See RejectionType for more detail.
Optional
CertifiedCopy
Details of the accepted attachment. See ResultsType for more details.
Freeform text field to convey any further information about the rejection.
Optional
ValidationErrors
This element is included if Code above has value BatchExceptionCode. ValidationErrors Code element will contain values as above.
Description element is a string value describing the reason for rejection.
String element representing a reference supplied by the external user in the original request.
Mandatory
MessageDetails
String message, usually ‘Your attachment has been accepted’.
Mandatory
AttachmentID
Integer that will be the equivalent of the Priority or Document ID.
Optional
12 ResponseEarlyCompletionV2_0
12.1 Response Message
The Early Completion Response V2_0 Response message uses the namespace http://www.oscre.org/ns/eReg-Final/2012/ResponseEarlyCompletionV2_0 and must be valid with respect to the XML Schema published by the Land Registry for that namespace.
Message
Description
ResponseEarlyCompletionV2_0
The response message to a Request Application To Change Register V2_0 request, where Early Completion rules apply.
12.2 Message Structure
The response message comprises generic header information which is common with responses for other services, plus information specific to the ResponseAttachmentrV2_0 response. This is illustrated below:
12.3 Specific Elements
Element
Description
Rules for Use
TypeCode
This will be a result value of 30.
Mandatory
EarlyCompletion
EarlyCompletionType gives full details of the Early Completion, including an XML register where possible.
Mandatory
12.3.1 Early Completion Type
Element
Description
Rules for Use
ApplicationMessageId
String value of the message ID from the original Application to Change the Register.
Mandatory
ExternalReference
String value of the external reference provided by customer.
Mandatory
ABR
String value of the Land Registry’s Application Barcode Reference.
Optional
DespatchDocument
Contains an Attachment Type holding base64Binary documents with the following attributes - String filename and String format.
Mandatory
XmlRegisters
Contains a Register Extract. See XmlRegistersType for more detail.
Has a Q1OCSummaryDataType. See Q1 OCSummary Data Type as in Response Application to Change the Register V2_0 for more details.
Mandatory
XmlRegisterData
Has a XmlRegisterDataType. See Xml Register Data Type as in Response Application to Change the Register V2_0 for more details.
Optional
PollRequest
13.1 Request Message
The Poll Request message uses the namespace http://www.oscre.org/ns/eReg/MR01-20090605/PollRequest and must be valid with respect to the XML Schema published by the Land Registry for that namespace.
Message
Description
PollRequest
This message allows Customers to submit Poll Request to HMLR.
13.2 Message Structure
The request message comprises generic header information which is common with requests for other services, plus information specific to the Poll Request. This is illustrated below:
13.3 Poll Request Specific Elements
Element
Description
Rules for Use
MessageID
Contains a MessageIDTextType which is a String of minimum length 5 and maximum length 50, being the MessageID of the request being polled.
I/We certify this attachment is a true copy of the original document
This certificate should be used where you hold the original document, original certificate or original letter. i.e. Anything that the submitting firm has scanned from an original document would be appropriate for ‘original’ in Business Gateway. Equally, an electronic document that has been received digitally by the firm from the issuing body, such as an SDLT (Stamp Duty Land Tax) submission receipt, would also be ‘original’.
OCSummaryData
I/We certify this attachment is a true copy of a document which is certified by a conveyancer to be a true copy of the original
This certificate should be used where you are submitting a document which is a copy of a document which has been certified on the face of the document by another Conveyancer to be a true copy of the original. This would be used if the submitting firm had scanned a certified copy of a document received from elsewhere, when they hadn’t seen the original themselves. Also, a scanned electronic image of a document received from a third party via email would be ‘certified’ by another for eDRS purposes.
XmlRegisterData
This attachment is an uncertified copy
This certificate should be used when you are submitting a document where you do not hold an original or copy certified by another Conveyancer and what you are submitting is a copy document such as copies of Death Certificates or Court Orders. The ‘scanned or ‘uncertified’ in portal option is seldom used, but it is there for the rare situation when a conveyancer might not know the provenance of a document that they need to submit as evidence. E.g. they have a document that is obviously a photocopy but it hasn’t been certified as a copy by anyone and the original is unavailable.
List of rejection codes and the reason/description:
Rejection code
Rejection reason/description
bg.title.invalid.specific
Title Number is invalid.
bg.title.closed.specific
Title Number is closed.
scheme.title.caution.title
Applications against scheme titles or caution titles are not supported.
leasehold.title
Lessees title number provided does not match a leasehold title held by Land Registry.
franchise.title
Applications for a New Lease, Lease Extension or a Transfer of Part against an affecting franchise or relating franchise are not supported.
pending.title
The title number provided is a pending new title. Applications for a New Lease, Lease Extension or a Transfer of Part will not be permitted against a pending new title.
bg.drs.priority.startvalue
Application priority must begin with ‘1’
bg.drs.priority.nonconsecutive
Application priority must be in consecutive numerical order.
bg.drs.ap1warning
Certification is required that the AP1 warning has been read and understood..
bg.drs.applicant
At least one party must be an applicant.
bg.drs.identityform
An must be provided.
bg.drs.party.representation
Representation for s must be provided.
bg.drs.application.roletype
Role Type of must be present for .
bg.drs.application.document
Application must be supported by a document.
bg.drs.lodging.representation
Representation by the must be provided for one of the parties to the application
bg.drs.transferee.afs
As you are representing the transferee the address for service is required.