New NZBN API version 4 definition now available for review
A new NZBN API version "v4" is under development and will be available for use soon. The new version includes updates that respond to recent developments in the NZBN that allow for new Primary Business Data elements, including GST numbers for businesses. We’ve also used this opportunity to make enhancements to functionality in response to customer feedback on v3.
Full details, including the API specification, are available in the NZBN v4 API documentation in the Prototyped APIs section of API Explorer. We encourage you to review the documentation and welcome any feedback you have on the current specification by 19th July 2019.
Key changes in v4
- New Primary Business Data (PBD) elements
- Multiple values of some data elements now supported for companies
- Ability to retrieve specific data
- Improved business change information
- Improvements to watchlist functionality
What this means for existing users of v3
When the new version is available for public use all current v3 users will have access without having to resubscribe to v4.
Version 3 will continue to be available for the foreseeable future and existing users will not need to immediately migrate to the new version when it becomes available.
Data structures and most key operations in v4 are significantly unchanged from v3 to make it easier to migrate to the new version and take advantage of the new features. Changes to the legislation on NZBN Primary Business Data mean that some features do not have backwards compatibility.