v1

latestOpenAPI 3.0.32026-07-134744.0 KB

create-test-user

Create a test user which is an organisation

This resource creates and returns a test user which is an organisation. The caller can specify the required service enrolments in the request body. If no request body is supplied, the test user is created with no service enrolments. Test users that have not been tested against within a 3-month period will be automatically deleted.

post/create-test-user/organisations

Request body

eoriNumberstring

Economic Operator Registration and Identification (EORI) number. Regular expressions:<br><code>^(GB|XI)[0-9]{12,15}$</code> A GB or XI EORI.<br><code>^[A-Z]{2}[0-9]{1,15}$</code> An EU EORI.

exciseNumberstring

Excise Number. Must be enrolled with 'excise-movement-control-system' for this to be used

ninostring

National Insurance number. Must be enrolled with 'national-insurance' or 'mtd-income-tax' services for this to be used.

taxPayerTypestring

Type of Self Assessment taxpayer One of 'Individual' or 'Partnership'

pillar2Idstring

A Pillar 2 ID can be provided for the test organisation

zReferencestring

An ISA Manager Z Reference can be provided for the test organisation

Response

The organisation test user resource has been created.

userIdstring required

Government Gateway ID.

passwordstring required

Government Gateway password.

userFullNamestring required

Government Gateway user's full name.

emailAddressstring required

Government Gateway user's email address.

saUtrstring

Self Assessment UTR.

ninostring

National Insurance number.

mtdItIdstring

Making Tax Digital Income Tax ID.

empRefstring

Employer Reference.

ctUtrstring

Corporation Tax UTR.

vrnstring

VAT Reference Number.

vatRegistrationDatestring date

Date of registration for VAT.

lisaManagerReferenceNumberstring

LISA Manager Reference Number, in either 4-digit format (Znnnn) or 6-digit format (Znnnnnn).

secureElectronicTransferReferenceNumberstring

Secure Electronic Transfer reference number.

pensionSchemeAdministratorIdentifierstring

Pension Scheme Administrator Identifier.

eoriNumberstring

Economic Operator Registration and Identification (EORI) number.

exciseNumberstring

Excise Number.

crnstring

Company Reference Number

taxPayerTypestring

Type of Self Assessment taxpayer One of 'Individual' or 'Partnership'

pillar2Idstring

Pillar 2 ID

zReferencestring

ISA Manager Z Reference, in 4-digit format (Znnnn).