Development

The latest updates to the API can be found on the Releases page.

Examples of requests made to the services please see the Examples page.

Endpoints

The endpoints are

Testing:

https://api.themovingportal.dev
https://api.imyhome.dev

Production:

https://api.themovingportal.co.uk
https://api.imyhome.co.uk

You can find Swagger definitions/UI at the following locations:

Testing system and Emails

When we setup your firm on the testing system it will NOT have your firms real name. This is to make it clear to future customers if you accidentally make this available in production. THIS HAS BEEN DONE BEFORE.

The testing system is setup to operate normally. IT WILL SEND EMAILS. e.g. if you set the customer email address then any emails will be sent to that address. Ensure that all your development takes this into account.

We do however operate an allowed list on the testing system for SMS messages.

Not sending emails

If you create a customer with an email address ending in .nosend then no email will be sent.

Plus addressing

One approach that we have taken to is to use plus addressing. This allows emails to be received into the same mailbox.

e.g. if your normal email address is ken.carson@myfirm.com, then emails sent to ken.carson+customer1@myfirm.com should be received into your mailbox

Not always supported

Plus address is not supported by all email systems and some email systems can disable this.

Service development status

Service/method	Available
Authentication
POST `/auth/login`	Yes
POST `/auth/refresh`	Yes
GET `/auth/whoami`	Yes

Instruction
GET `/instruction/{tmpReference}`	Yes
GET `/instruction/introducer/{reference}`	Yes
GET `/instruction/supplier/{reference}`	Yes
GET `/instruction/{tmpReference}/file/{fileName}`	Yes
PUT `/instruction/{tmpReference}/introduder/{references}`	Yes
PUT `/instruction/{tmpReference}/supplier/{references}`	Yes

Instructions search
GET `/instructions`	Yes

Notes
POST `/instruction/{tmpReference}/note`	Yes
PUT `/instruction/{tmpReference}/readnotes`	Yes

Data
GET `/data/{setCode}`	Yes

Referral
POST `/referral`	Yes
HEAD `/referral/introducer/{reference}`	Yes

Quote
GET `/quote/{tmpReference}`	Yes
POST `/quote`	Yes
PUT `/quote/{tmpReference}/refer`	Yes
PUT `/quote/{tmpReference}/email`	Yes
DELETE `/quote/{tmpReference}`	Yes
PATCH `/quote/{tmpReference}/property`	Yes
PATCH `/quote/{tmpReference}/fees`	Yes

Quote	NOT IN PLACE
PUT `/quote/{tmpReference}/assign`	No

Quotes search
GET `/quotes`	Yes

Supplier operations
PUT `/instruction/{tmpReference}/accept`	Yes
PUT `/instruction/{tmpReference}/decline`	Yes
PUT `/instruction/{tmpReference}/terms`	Yes
POST `/instruction/{tmpReference}/appointment`	Yes
PATCH `/instruction/{tmpReference}/appointment`	Yes
PUT `/instruction/{tmpReference}/appointmentcompleted`	No Not enabled.
PUT `/instruction/{tmpReference}/appointmentuncompleted`	No Not enabled.
POST `/instruction/{tmpReference}/report`	Yes
PATCH `/instruction/{tmpReference}/report`	Yes
PUT `/instruction/{tmpReference}/complete`	Yes

Instruction notifications	Yes

GET `/instructions/notifications`	Yes
GET `/instruction/{reference}/notifications`	Yes
GET `/instruction/{reference}/notifications?timestamp={fromTimestamp}`	Yes
PUT `/instruction/{reference}/processed?timestamp={toTimestamp}`	Yes

Current issues

General

If you use the Swagger definitions these will contain references to response codes that aren't in use or the API will return response codes not defined. They will be cleaned up over time and with continual review.

Quoting service

Internally Quotes and Instructions are separate entities - they hold separate types data and are for different purposes. However, some of the data is similar.

The functionality associated with Instructions is more advanced than that with Quotes. The Quote structure is being upgraded to have some of the functionality in Instructions (e.g. Introducer references, referrer)

POST /quote does not yet support creation of a referrer. The referrer property is in the payload and if provided will be validated, but is not yet in use. There is work in the back end to support this.
POST /quote does not yet support suppling introducer references. These UniqueIntegrationReference and UniqueCustomerReference properties are in the payload and if proprovided will be validated, but is not yet in use. There is work in the back end to support this.
The quote object has no support to return who created the quote at the introducer firm. There is work in the back end to support this.
The otherInformation and configuration properties of a quote are not populated (as they are with the Instruction).

Instruction service

There is no support for an Introducer to retrieve the owner of a case (or change it). The owner is the person at the firm who created the case (or created the customer who quoted/instructed themselves).

Instructions search service

It is not possible for an Introducer to search by Introducer references or return the references.
It is not possible for an Supplier to search by Supplier references or return the references.
It is not possible to search by case index. This is not currently an issue as each instruction has only one case.

Testing service

As of February 2025 development of this service is On Hold. Interactive functionality to assist developers with integration testing has been put in place instead.

This service may be depreacted in future.