Development and APIs

Accessing Data from UPC

Public APIs are available for accessing public data in the CMS. These include:

  • /caseTypes for a list of case types
  • /cases for searching the cases
  • /document for obtaining and downloading a list of documents related to a case

Detailed descriptions of the APIs and their parameters are in this Swagger file:

The current URLs for accessing the APIs are:

Writing Data into UPC CMS

Public APIs are available for writing data into the CMS. Current APIs allow for the following applications:

Submit Opt Out and Withdraw Applications

Detailed descriptions of the APIs and their parameters are in this Swagger file:

The current URLs for accessing the APIs are:

To use this functionality, a user App must be created and authorised. In order to do this:

  • Log into the UPC CMS, access the new "My Developer App" menu on the left panel and create an application
  • A Client secret key will be displayed and saved in the private area, to be used for authenticating all API calls
  • The secret key must be added in the header of all calls, named "X-API-USER"
  • This swagger file describes all parameters and returned data