API design version Change date Description
1.43 8 March 2023 Optional PBD fields made available to more entity types. Changes to the new fields on these entity types will be returned in change event search and watchlist notifications. Refer to reference data document for further details.
1.40 10 November 2022 New API version v5 published. Version content is identical to v4 but authentication method and URL have changed.
1.40 5 July 2022 Updates to API definition:
  • Corrected request type for POST /entities
  • Changed order of some operations
  • Refined titles to differentiate fields
1.37 7 April 2022 Introduction of organisation-parts operations:
  • New operations to find, share and maintain organisation-part information.
1.36b 11 May 2020 Changes to support the Maori business identifier:
  • New operations GET and POST entities/{nzbn}/business-ethnicity-identifiers
  • Added BUSINESSETHNICITYIDENTIFIER change event type
  • Added businessEthnicityPrivateInformation to privacy settings
1.34b 7 Oct 2020 Updates to API definition:
  • New data element non-company-details available for limited partnerships, charitable trusts and incorporated societies from GET /entities/{nzbn}.
  • New operation GET /entities/{nzbn}/non-company-details.
New change event types available:
  • COMPANYDETAILS_ANNUALRETURNS
  • ENTITY_NAME
  • ENTITY_STATUS
  • COMPANYDETAILS_FINANCIALSTATEMENTS
Data availability update:
  • Privacy settings can now be used for companies' voluntary data.
1.21b 11 Jun 2020 Updates to API definition: 
  • hibernationStatusCode and hibernationStatusDescription attributes added to responses from GET /entities/{nzbn} and GET /entities/{nzbn}/discoverable  to support business debt hibernation for companies.
  • New operation GET /entities/{nzbn}/history/hibernation-statuses
  • roleAsicAddress added to company director details
1.20 14 Nov 2019 Updates to API definition:
  • Corrected descriptions for entityTypeCode and sourceRegister
  • Added Officer to roleType description
  • Added POST /entities operation for registering unincorporated entities
  • Removed unsupported limit-to-watchlist parameter from GET /entities/changes
  • Minor typos corrected
1.18 30 Sep 2019
  • Additional details available for Incorporated societies and Charitable Trusts
  • Changes for Incorporated societies and Charitable Trusts are now notified in NZBN watchlists and returned in /entities/changes?... searches
1.18 7 Aug 2019
  • First release of version 4 for public use