International Validation

(0 reviews)

home

Introduction:

The International Validation API provides validation services to ensure parcel data complies with Global Customs clearance requirements.

For Global Customs clearance requirements, refer here:

https://www.nzpost.co.nz/business/shipping-internationally/customs-documentation-for-business/global-customs-clearance-requirements

Overview

The API provides endpoints to:

The validate-stop-word endpoint specifically checks item descriptions for prohibited or vague terms (known as stop words) that are not acceptable under the EU’s ICS2 (Import Control System 2) rules.

These include generic or non-descriptive terms such as “gift”, “sample”. Using these terms may result in shipments being delayed, rejected, or subject to fines at customs.

Key Features
  • When to call: Before submitting parcel label requests for the destinations impacted by ICS2 guidelines.
  • Input: Provide item description text and destination country code in the request payload. Country codes follow the ISO 3166-1 alpha-2 standard (two-letter country codes).
  • Validation: The API scans the description against the stop word list.
  • Response: If a stop word is detected, the API returns a validation error with details of the prohibited item. If no stop words are found, the API returns a success response, allowing you to proceed with label creation.

By using this endpoint, customers can:

  • Ensure item descriptions are clear and compliant.
  • Avoid shipment details, returns, or rejections due to non-compliant data.
  • Reduce manual intervention and seed up customs clearance for parcels.

Resource Information:

Endpoint Name Function Resource URL Verb
validate-stop-word Validates one or more parcel content descriptions against centrally maintained list of stop words. Generate an error response if invalid terms or blank descriptions are detected. UAT:
https://api.uat.nzpost.co.nz/international-validation/v1/ead/validate-stop-word
PROD:
https://api.nzpost.co.nz/international-validation/v1/ead/validate-stop-word
POST
AttributeDetail
Response FormatJSON
Requires AuthenticationYes

Support

For developer integration enquiries, please email techsupport@nzpost.co.nz. Support is available during New Zealand business hours.


Reviews