This version is in beta - expect some breaking changes.
Create Test User API
|Available in Sandbox||Yes|
|Sandbox base URL||https://test-api.service.hmrc.gov.uk|
|Available in Production||No|
What is a test user?
A test user is a dummy Government Gateway account that you can use for testing in our sandbox. To access user-restricted endpoints your application’s users must complete the OAuth journey, which includes signing into their Government Gateway account.
Each test user has a:
- type of Government Gateway account - individual, organisation or agent
- Government Gateway user ID and password - for sign in during the OAuth journey
- set of service enrolments and related tax identifiers - as different APIs require different enrolments
What types of test user can I create?
With this API you can create a wide range of test users, including individuals, organisations and agents together with a wide variety of service enrolments and corresponding tax identifiers. You can also create test users for use during automated testing.
You can also use our create a test user service to create test individuals or organisations with a simpler default set of enrolments.
How long does a test user last?
Test users and other test data are cleared down every two weeks.
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.
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
- 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
- 400 to 499 if it failed because of a client error by your application
- 500 to 599 if it failed because of an error on our server
Errors specific to each API are shown in the Endpoints section, under Response. See our reference guide for more on errors.