This FAQ explains what is changing with the ZDHC Brand APIs, what you need to update in your integration, and what to expect while the new APIs are being prepared.
As part of the relaunched ZDHC Gateway, the Brand APIs are being moved to a new technical infrastructure and a new version of the APIs.
This transition will improve the API infrastructure and align the APIs with the relaunched ZDHC Gateway. As a result, some technical changes to the APIs are required.
No. The previous Brand APIs are no longer available as part of the transition to the relaunched ZDHC Gateway.
The new Brand APIs are currently being prepared. We will share the confirmed availability date, technical documentation, and change log as soon as they are finalised.
The new Brand APIs are planned to become available around October/November 2026. However, the exact go-live date has not yet been confirmed.
We will communicate the confirmed timeline as soon as it is available.
Yes. The transition requires technical updates to your integration. This is not limited to replacing your API keys.
You should expect changes to:
- API keys
- Base URL
- Endpoint URLs
- Some data point names
- In some cases, the structure of the data returned by the endpoints
- Document availability through the API
Note: The new Brand APIs will no longer provide documents, such as report PDFs, through API endpoints. If your integration currently uses an API endpoint to retrieve documents, this process will need to be reviewed and replaced with an alternative approach, such as accessing the documents through the ZDHC Gateway Data Hub.
We are keeping these changes to the minimum necessary. A detailed change log will be provided with the new API documentation to support your development work.
Yes. The new Brand APIs will require new API keys.
The format of the keys will remain the same as the current format, consisting of a UserAccessKey and an authenticationKey.
New keys and instructions for obtaining them will be provided as part of the new API setup.
Yes. The base URL will change as part of the move to the new API infrastructure.
Yes. The endpoint URLs will change as we move to the new version of the APIs.
There will be some changes to the data returned by the APIs.
These may include:
- Renamed data points
- Removed or new data points
- Changes to the data structure required to improve an endpoint
- Documents, such as report PDFs, will no longer be delivered through the Brand APIs.
Note: Documents that are available in the ZDHC Gateway will continue to be accessible through the Data Hub.
We are keeping these changes to the minimum necessary. The new API documentation and change log will describe the changes that require updates to your integration.
The new APIs will follow the same general purpose and functionality, and the endpoints will mostly remain aligned with the existing APIs. However, the endpoint URLs and some technical details will change.
Data is not lost because of the API transition.
Data uploaded to the relaunched ZDHC Gateway will be available through the new Brand APIs once they go live.
When the new APIs become available, they will retrieve the relevant data that exists in the relaunched ZDHC Gateway at that time.
Yes. While the new Brand APIs are being prepared, brands can access relevant data manually through the ZDHC Gateway Data Hub.
Depending on the supplier sharing permissions and your access, you can download:
- InCheck reports in PDF and CSV format
- ClearStream reports in PDF and CSV format
- Vendor to Zero Reports in PDF format
- Chemical Inventory (CI) in CSV format, if the supplier has additionally opted in to share it
Please refer to the relevant Data Hub guidance for information on accessing and downloading data.
If your organisation uses the Brand APIs, you should plan for development work to update your integration once the new documentation and change log are available.
In the meantime, you can:
- Review your current API integration and identify the endpoints you use.
- Check whether your integration currently retrieves documents, such as report PDFs, through the API.
- Identify the internal systems and processes that depend on the Brand APIs.
- Plan the development and testing work required to update your integration.
- Use the ZDHC Gateway Data Hub for manual access to available data while the APIs are unavailable.
There is no need to make changes based on the new API specifications yet, as the new documentation is still being finalised.
The new Brand API documentation is currently being prepared and will be shared once it has been finalised. The new Brand APIs are currently planned to become available around October/November 2026, although the exact go-live date has not yet been confirmed.
The documentation can only be finalised as the last step of the API migration, once all technical changes have been confirmed. This is necessary to ensure that we can accurately compare the previous API version with the new version and provide a complete and reliable overview of the changes.
The new documentation will include the new endpoints, authentication information, data structures, and other technical details required to update your integration. A change log will also be provided to clearly identify the changes from the previous APIs.
We appreciate your patience while this work is being completed and will share the documentation as soon as it is ready.
The previous Brand API documentation can still be used as a reference for the existing API structure and functionality. The format of the new documentation will remain similar.
Please note that the previous documentation describes the APIs that were available before the transition and should not be used to develop or update your integration for the new APIs, as the base URL, endpoint URLs, API keys, and some data points and structures will change.
You can access the previous Brand API documentation here.
The new documentation and change log will be shared once they are finalised.
Yes. If your organisation requires automated API access, you can already formally request access and complete the relevant request form.
This allows ZDHC to prepare the required contractual arrangements while the new API infrastructure and documentation are being finalised.
Please contact ZDHC for information on the API access request process.
Yes. Data available in the relaunched ZDHC Gateway will be made available through the new Brand APIs once they are live.
There is therefore no need to re-upload or recreate data solely because of the API transition.
No separate data migration is required for brands. The API transition is part of the move to the relaunched ZDHC Gateway.
Once the new Brand APIs are available, they will provide access to the relevant data held in the relaunched ZDHC Gateway.
Once the new API documentation and change log are available, update your integration according to the new specifications.
In particular, review and update:
- API keys
- Base URL
- Endpoint URLs
- Data point names
- Data structures and mappings where applicable
- Any functionality that currently retrieves documents through the API
Note: If your integration currently retrieves report PDFs or other documents through the Brand APIs, you will need to use the Data Hub as the alternative way to access those documents.
We recommend completing the necessary development and testing before switching your production integration to the new APIs.
Yes. ZDHC will provide:
- New Brand API technical documentation
- A detailed change log comparing the new APIs with the previous version
- Information about the confirmed go-live timeline
- Guidance on accessing and configuring the new APIs
We will share these materials as soon as they are finalised.
The new Brand APIs are the API infrastructure for the relaunched ZDHC Gateway. The previous APIs will not be reinstated.
This transition is a necessary step to provide brands with better and more reliable data access and to support the development of further data solutions. We understand that the transition and the required changes to your integration may cause some inconvenience, and we appreciate your patience and collaboration while the new APIs are being implemented.
The transition is a one-time move to the new API version. Future API updates and changes will be communicated separately.