This is a large release. We never pushed v1.3 to live, so this contains five month's worth of development changes. There are some changes which could potentially break existing client integrations, although we have monitored the API calls actually in use and we are confident that none of these changes will impact current customers.
- Various changes to the Title Check results:
- Better detection of Extra Title Numbers.
- Fixed bug where Extra Title Numbers could include the title being checked.
- Wording changes in the descriptions for some issues.
- RegisteredCharge now includes details of any sub-charges.
- New issue: Registered Charge has sub-charges.
- RegisterEntry now has an extra optional Boolean property TextHasNewlines. If this property is present and true then the Text property may contain new lines (specifically CR/LF pairs) and is intended to be displayed in a fixed-width font.
- All issues (from both title checks and Borrower Name checks) now have an IssueId property that is a unique id (a GUID) for that instance of the issue.
- Implementation of Online Ownership Verification (OOV) service.
-
Possible breaking change if client is using automatic code generators: In the Borrower Name Match service some types have been renamed:
- BorrowerNameMatch to BorrowerNameMatchDetails
- EBorrowerNameIssueType to EBorrowerNameMatchIssueType
- BorrowerNamesIssue to BorrowerNameMatchIssue
- The Borrower Name Match service now raises a separate issue for each name mismatch rather than aggregating all name mismatches of the same type into a single issue.
- For all services except Title Numbers (ePD) there are two new endpoints:
- get-next-ready (returns the next completed request that has not been acknowledged, and locks it for a short period to give the client time to process and acknowledge it).
- ack-next-ready (acknowledges that the request returned by the last get-mnext-ready call has been processed by the client).
- For all services except Title Numbers (ePD) the “acknowledge” endpoint has been renamed “ack”.
- For all services except Title Numbers (ePD) the “request” object has an extra optional date/time field “Deadline”. If specified then if the final result of the request is not available by that time the request will be marked as “expired” and made available for return to the client.
- For all services except Title Numbers (ePD) the “search for requests meeting specified conditions” endpoints are now more flexible:
- The “status” parameter has an extra value “expired”.
- The “status” parameter value can be preceded by “!” to search for requests whose status is not the specified value.
- There is a new optional “acknowledged” parameter which can be used to filter requests to those that have or have not been acknowledged.
- For all services except Title Numbers (ePD) the “search for requests meeting specified conditions” oldest-first/newest-first ordering is now based on the date/time the request was created rather than on the date/time of the last status change.
- The Title Data and Checks service has a new endpoint which allows a client who has already obtained RES data from the LRBG to upload that data for a Title Check (so avoiding the expense of TitleExpert requesting another copy of the RES data from the LRBG).
- The Title Data and Checks service has a new endpoint to obtain the RES data as an octet stream (i.e. as a file) rather than as an object.
- The existing Title Data and Checks endpoint that obtains the RES data as an object is deprecated (and in particular should not be used when requesting a json response as the RES cannot be serialised to json correctly).
-
Breaking change: Certain “internal” properties of various objects were accidentally exposed in the Swagger service descriptions and were returned if the response was requested as json (rather than XML). The following properties are now no longer exposed in the Swagger or returned by API calls:
- IsIncomplete
- DisplayName
- IsIncomplete
- DisplayName
- DisplayName
- ShortRef.
- Possible breaking change if client is using automatic code generators: A number of properties of various objects were incorrectly shown as “optional” in the Swagger. The properties affected (too many to list) are no longer shown as “optional”.
- The Swagger for the various “get a document” endpoints has been corrected to show that they return streams rather than objects.
If you are concerned about the impact or would like to discuss exploiting any of these changes, please do get in touch.