Releases

Major releases

As of March 2025, this API is still under development. The following major releases have been made and are scheduled:

ReleaseWhenDescription
v1Q4 2023Direct Referral service.
Used internally at TMP as proof of concept.
v2Q2 2024Introducer and Quoting services and updates to Referral service.
Supplier services for supplier operations.
Basic and Bearer authentication.
v3Q1 2025Notification service to allow for polling for updates to Instructions.
v4Q2 2025Final parts of Quoting service completed.
--On holdTesting service to allow integrators to perform end to end tests.

INFO

Our aim is to create a full set of API methods to allow for all quoting, referral and instruction operations that can be performed via the portal. We hope that these services will be completed by mid 2025.

Work for v2 has mostly been released and completes the instruction services for Introducers and Suppliers and most of the Quoting services for introducers. Updates will continue during 2025 to complete the quoting journey.

Prioritisation for v3 has moved the notification service ahead of the quoting service. The testing service has been put on hold following feedback and replaced with interactive functionality for developers to assist with testing.

Until the API is completed we may make breaking changes in an effort to get the services implemented correctly. We would not make a change without discussion and notice.

v3 development

22 March 2025

  • Supplier A new option for suppliers to update the state of terms and conditions. Use of this is optional. It will allow tracking of terms and conditions. We expect it to be used when there is a delay in getting these returned which should be done before an appointment is booked.
  • Introducer Supplier The otherInformation property returned for an Instruction, Instruction search and Instruction Events now includes entries to indicate whether Terms and Conditions have been sent or received.
  • Introducer Supplier There are new Instruction Events returned for Terms and Conditions have been sent or received.

10 March 2025

  • We have released an Integration Developer Console to allow for integrators to peform testing themselves by allowing you to move an instruction through it's various stages and perform some admin operations. See the page on Testing.
  • Introducer Supplier A release of the Instruction notifications service has been made to the testing environment.

31 January 2025

  • Introducer Supplier Following feedback we have made the decision to prioritise development of the Instruction notification service scheduled for Q2 2025 (v4) to move into Q1 2025 (v3) and move completion of the Quoting service to later in the year.
  • Introducer Supplier Development of the Testing service has been put on hold and will be replaced with interactive functionality for developers in the main portal. This will allow developers to perform operations on their test instructions that they would not normally have permissions to perform. We are likely to remove this service completely unless we received feedback that this would be useful addition for integrators.

v2 updates

The following updates have been made since the release of v2:

20 March 2025

  • Introducer Supplier You can now use the X-UserCode HTTP header in calls to the API in conjunction with the Bearer token header. This allows you to specify the name of a person to perform operations in the context of.

13 March 2025

  • Introducer The Quote service methods to update the property and fees are in place.
  • Introducer The Property value tier codes had the wrong code for the range £100k to £150k. It was set to 100K150K rather than 100KTO150K to match the other codes. This code has been changed but have allowed for the previous value to continue to be used for any integrators already using the service and using a cached version of the values. An alternative is to provide the property value and the tier is calculated.

10 March 2025

  • Introducer Supplier A new property has been added to the Instruction object to return attributes of a case. The DataSetItem object returned in the Data service has an Information property added to return additional information. It is used when the data set item CASEATTRIBUTES is used. Information about attributes can be found in the Key concepts page.
  • Introducer There was a bug where the CaseStatusCode for an Ordered case was showing as REFERRED and should be showing as ORDERED and when assigned/accepted by a supplier was showing as ACCEPTED and should be showing as ALLOCATED.
  • Introducer Supplier The data associated with the Appointment milestone for Introducers and Suppliers has changed. TIMESLOT has been renamed TIMESLOTCODE and is now optional. It will only be present if the data is available. Not all appointments will have a timeslot defined. The meaning of the timeslot can be retrieved from the Data service using the data set code APPOINTMENTTIMES.
  • Introducer Supplier The method to retrieve files in the Instruction service is now in place.
  • Introducer Supplier Support is now available to provide your own reference with a note that is added. This will allow you to determine whether a note has already been added.
  • Introducer Supplier The InstructionNote object (returned when retrieving an Instruction) now contains a property Sequence which is an index to the note. This will correspond to a property returned in the Add Note notification.

28 February 2025

  • Following feedback, we have changed our guidance and approach for the topic of shared accounts. We still discourage the use of shared accounts in the interactive portals. However, it is now possible to create a integration service account to work with in association with the API. This has the same permissions as an interactive user on the portal - but you cannot logon with it. It can be hooked up to web service credentials which you can then use. You can also optionally use the X-UserCode header to switch to an individual user if you wish. See the API concepts for more details.

15 January 2025

  • Introducer Extend the direct referral creation method in the Referral service to specify that the referral is a Lead and no total fee has been calculated. The total fee will then be calculated using the official price lists.

9 January 2025

  • Supplier New methods to update the supplier references on a case and retrieve an instruction using the supplier reference.

21 October 2024

  • Introducer Supplier The Instruction search allows searchTypeCode to be set to null/empty - in which case it will return Active cases (i.e. not Completed or Cancelled).

9 October 2024

  • Introducer A breaking change has be made on the Referrer object used in the NewReferrer and NewQuote objects. All active integrators and integrations have been advised:
    • remove ContactName and replace it with ContactTitle, ContactFirstName and ContactLastName.
    • remove ContactReference.

4 September 2024

  • Supplier First method added to Testing service to allow a Supplier to create a case and have it allocated to them ready for acceptance (or to be declined).

21 August 2024

  • Introducer BUG: When creating a new referral and provided the Purchase Price AND the Property Value Tier code, the tier code was being used to determine the quote. This has been changed to use the Purchase Price and the Tier code will be ignored.

26 July 2024

  • Introducer Quote and Instruction now supports returning Primary customer.
  • Supplier Instruction now supports returning Primary customer.

24 July 2024

  • Introducer Quote search is now available.

23 July 2024

  • Introducer Added new method for Introducers to update references for their cases.

17 July 2024

  • Introducer Returned an otherInformation property with an instruction containing Introducer case references. Applicable to introducers only.
Last Updated: