UPU API Documentation

Application programming interface (API) documentation describes how to build connection or interface between computer programs.

Copyright notice

Address API

Address API allows you to validate post code and locality using simple and generic input form for each country. Accepts variety of inputs, including region, alternative spellings and various languages.
The Address API can be used in CDS to support data capture for the addresses in custom declarations (CN22/23).

More information


The BAMS API is organized around SOAP and can be used to retrieve bilateral agreements between your organization and your business partner.


Explore how the CDS API exposes functions related to Customs declarations and responses, as well as prohibitions and restrictions information. The CDS API can be used both in SOAP and in RESTful (recommended) modes.



Learn how to integrate DPS with your local online systems and mobile platforms. The DPS API is a RESTful API.

EAD Check

The EAD Check API allows you to check from IPS, CDS, or your local system whether an electronic customs declaration, referral, or DNL message exists for the mail item.


The EAP Get API allows you to retrieve details of an Electronic Advance PosTransfer pre-fillment as captured by customer in the PosTransfer app.

eCom API

The eCom API platform provides the services and functions of IPS, IFS and CDS through web service calls.

EDI Engine API

The EDI Engine API offers GET and POST methods to request operational business data - converted from EDI messages received from partners - or to import data into EDI Engine to generate EDI messages.

This API reference explains each of the API endpoints, with example REST requests and responses included.


Global Track and Trace


See how the IFS and IFS Cloud API allows you to connect your different local systems to your IFS on local server (IFS) or on UPU Cloud servers (IFS Cloud) to record and exchange international postal-payment messages with your business partners and record domestic postal payments operations.


Learn how to integrate IPS with your local online systems and mobile platforms. The IPS API can be used in REST (recommended) and SOAP modes. 



See how the UPU-IP API allows you to connect your local system to the UPU Interconnection Platform (UPU-IP) and exchange postal-payment messages with your business partners.

Web tracking API

The Web Tracking API allows you to track a mail item that has been entered into IPS.