API Documentation

Overview of the COMESA eCO APIs, available endpoints, methods, and integration functions.

Integration Framework: The complete technical definition of these APIs, including request structures, response structures, headers, datasets, parameters, security requirements and implementation rules, is defined in the COMESA eCO Integration Framework.
View Integration Framework β†’
API CHAPTER 01
Exporter Registration

Register exporters on the COMESA eCO platform.

View in Integration Framework β†’
API CHAPTER 02
Exporter Registration – Incremental Query

Retrieve exporter registrations incrementally using the last successfully processed identifier.

View in Integration Framework β†’
API CHAPTER 03
eCO Submission

Submit electronic Certificates of Origin for processing.

View in Integration Framework β†’
API CHAPTER 04
eCO Query / Retrieval

Retrieve electronic Certificates of Origin from the platform.

View in Integration Framework β†’
API CHAPTER 05
Exporter Revocation

Manage exporter registration revocation requests.

View in Integration Framework β†’
API CHAPTER 06
Exporter Revocation – Revoke

Revoke an exporter registration.

View in Integration Framework β†’
API CHAPTER 07
Exporter Revocation – Cancel

Cancel a previously requested exporter revocation.

View in Integration Framework β†’
API CHAPTER 08
Add Approved eCOs

Submit approved electronic Certificates of Origin.

View in Integration Framework β†’
API CHAPTER 09
Get eCOs

Query electronic Certificates of Origin.

View in Integration Framework β†’
API CHAPTER 10
Amend eCOs

Amend an existing eCO record.

View in Integration Framework β†’
API CHAPTER 11
eCO Revocation – Revoke

Revoke an electronic Certificate of Origin.

View in Integration Framework β†’
API CHAPTER 12
eCO Revocation – Cancel

Cancel a previously requested eCO revocation.

View in Integration Framework β†’
API CHAPTER 13
eCO Usage – Submit

Submit certificate usage information.

View in Integration Framework β†’
API CHAPTER 14
eCO Usage – Query Incrementally

Retrieve usage records incrementally using the last processed ID.

View in Integration Framework β†’
API CHAPTER 15
Query eCOs

Query certificates requiring query handling.

View in Integration Framework β†’
API CHAPTER 16
Get Queried eCOs

Retrieve eCO records whose status is Queried.

View in Integration Framework β†’
API CHAPTER 17
Generate eCO PDFs

Request generation or retrieval of eCO PDF documents.

View in Integration Framework β†’
API CHAPTER 18
Officers

Create, amend, or query authorised officers.

View in Integration Framework β†’
API CHAPTER 19
DIA Officers – Incremental Query

Retrieve DIA officers incrementally using user_id.

View in Integration Framework β†’
API CHAPTER 20
eCO Status Update

Transmit eCO status updates to the COMESA platform.

View in Integration Framework β†’

COMESA eCO Integration Framework

For complete API definitions, datasets, request and response structures, parameters, authentication, security requirements, error handling and implementation conventions, refer to the Integration Framework.

Open Integration Framework β†’