This version is in beta - expect some breaking changes.
|Available in Sandbox||Yes|
|Sandbox base URL||https://test-api.service.hmrc.gov.uk|
|Available in Production||No|
This API allows testers to inject departure and arrival movement notifications as if they came from the Office of Departure and Office of Destination via the New Computerised Transit System (NCTS).
We will continue to add endpoints as we finish developing them. To review our progress and to see what you can test, take at look at our Roadmap.
Further details of the User Application Restricted Authentication are given on the Authorisation page.
For more information about how to develop your own client applications, including example clients for this API, see Tutorials.
When an API changes in a way that is backwards-incompatible, we increase the version number of the API. See our reference guide for more on versioning.
Here is the list error codes that we will keep updating. We use standard HTTP status codes to show whether an API request has succeeded or not:
400 BadRequest: If JSON message is invalid
401 Unauthorized: If client passes invalid auth credentials
403 Forbidden: If supplied auth token doesn't contain valid enrolment
404 Not Found: If no object with specified ID found in database
415 Unsupported Media Type: If the client specified an invalid
500 Internal Server Error: If exception in code occurs
501 Not Implemented: If user attempts to
POST a message and the message type isn't currently supported
Errors specific to each API are shown in the Endpoints section, under Response. See our reference guide for more on errors.