Sign in

v9

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-15521353.8 KB
businesses

Create a business

Create a business if it doesn't already exist, otherwise update its versioned attributes

post/businesses

Request body

sampleUnitRefstring string
sampleUnitType'B' | 'BI'
sampleSummaryIdstring uuid

Example request

{
  "sampleSummaryId": "91e0bb4f-ffad-404c-af1b-01c87037119c",
  "attributes": {
    "birthdate": "1990-01-01",
    "checkletter": "A",
    "currency": "GBP",
    "runame1": "Office for National Statistics",
    "runame2": "ONS",
    "runame3": "UK Statistics Authority"
  }
}

Response

The business has been created or updated

idstring uuid
sampleUnitRefstring string
sampleUnitType'B' | 'BI'
sampleSummaryIdstring uuid
namestring
trading_asstring

Example response

{
  "id": "91e0bb4f-ffad-404c-af1b-01c87037119c",
  "sampleSummaryId": "91e0bb4f-ffad-404c-af1b-01c87037119c",
  "attributes": {
    "birthdate": "1990-01-01",
    "checkletter": "A",
    "currency": "GBP",
    "runame1": "Office for National Statistics",
    "runame2": "ONS",
    "runame3": "UK Statistics Authority"
  },
  "name": "Office for National Statistics",
  "trading_as": "ONS",
  "associations": [
    {
      "partyId": "91e0bb4f-ffad-404c-af1b-01c87037119c",
      "enrolments": [
        {
          "surveyId": "91e0bb4f-ffad-404c-af1b-01c87037119c"
        }
      ]
    }
  ]
}