Getting Started

Current protocols and standards

TSW sends and receives using SOAP over HTTPS, and uses an internal Certificate Authority.

For sending lodgements, TSW has exposed a web service interface (SOAP with attachments over HTTPS) where the lodgement is sent as an attachment. For WCO 3 XML, supporting documents can also be sent as additional attachments.
For receiving responses, another web service is exposed to allow these, plus any attached documents such as delivery orders to be pulled down from the TSW system.
In the future, TSW plans to move to RestAPIs using JSON to replace the current SOAP format.

Certificate Policy

TSW requires the use of Public Key Infrastructure (PKI) for the provisioning and use of digital certificates.
The following certificates are required:

  • Mutual SSL for identification of the Exporter
  • JSON Web Token (JWT) signing keys for verify the Exporter signature.
  • The environments that will be used for the CoO API are:
  • EXT this is a trade facing test system for Exporters to connect their pre-production / test environments to.
  • PROD this is the production system where Exporters will connect their production environment to the Customs production environment.

Trusted Certificate Authorities

In both the EXT and PROD environment, the Exporters certificates will be signed using the NZCS private CA. Customs will provide the environments public certificates to the Exporter.

Certificate Filename Naming Conventions

Let's get started!

If you’re comfortable with the connections steps and standards in place, request to create a connection by completing the form. This will take you about ten minutes to complete.

Request to Connect