Sign in

v1

latestOpenAPI 3.0.32026-07-13105113.9 KB

List All Businesses

This endpoint allows a developer to retrieve all details of a user's business income sources. The unique account reference (National Insurance number) must be provided.

Test data

Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment.

Header Value (Gov-Test-Scenario)Scenario
N/A - DEFAULTSimulate a successful response with a self-employment business.
PROPERTYSimulate a successful response with a uk-property business.
FOREIGN_PROPERTYSimulate a successful response with a foreign-property business.
BUSINESS_AND_PROPERTYSimulate a successful response with a self-employment, uk-property and foreign-property business.
UNSPECIFIEDSimulate a successful response with a property-unspecified business.
NOT_FOUNDSimulates the scenario where no data is found.
STATEFULPerforms a stateful list.
get/individuals/business/details/{nino}/list

Path parameters

ninostring required
Example:TC663795B

National Insurance number, in the format AA999999A

Headers

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used.

Authorizationstring required
Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token with the read:self-assessment scope.

Gov-Test-Scenariostring
Example:-

Only in sandbox environment. See Test Data table for all header values.

Response

Success

Example response

{
  "listOfBusinesses": [
    {
      "typeOfBusiness": "self-employment",
      "businessId": "XAIS12345678910",
      "tradingName": "RCDTS"
    }
  ]
}
All 10 operations