Development and APIs -- Developers' area

Sunrise versions of CMS and APIs

As of the 9th of October 2017, the Sunrise version of the CMS is live at .

New user and new developer key for APIs need to be created on the new site.

Once registered, CMS users have the possibility to test Applications for Opt-out as well as to test Applications to be registered as a representative before the UPC.

This new version will remain in test mode until further notice, after which the CMS shall transition to the production environment.

Users are invited to monitor the News section of this Web-site for official updates.

Substantial modifications have been inserted in the final procedure for Opt-out, both via UI and via API. Please refer to the Opt-out API Instructions document (see Attachments section).  

The revised version of API for lodging Opt-out applications is described in the a2a_swagger_v5 file (see Attachments section).

The API to access public data from UPC register remains the upc_public_api_swagger_v2 file (see Attachments section).


[deprecated] New version for accessing Data from UPC

30 May 2017

Version 2 of public APIs is now available at

The new swagger is here

Major changes for /cases:

  • The request parameter modifiedSince now works. It expects a date in the format yyyy-MM-dd. If not passed, the filter is not used
  • The request parameters from and to are removed
  • The new request parameter pageNumber can be used to page the results. The first page is the 1. The default value is 1
  • The new request parameter pageSize can be used to set the number of records for single page request. The default value is 10
  • Removed from Case the list of Part claimantdefendantapplicant
  • Added to Case the list of Part as field parts
  • Added to Part the field type. It is described as an enum ("CLAIMANT", "DEFENDANT", "APPLICANT", "APPELLANT", "RESPONDENT") and specifies the type of the part

The version 1 of the API (available at is still available, but will be dismissed on the next release



[deprecated] New version for Writing Data into UPC CMS

15 May 2017

New version of the APIs has been added.

The v1 API and v2 API are not available anymore

The v3 API is still available at 

It will be removed on the next release, and proprietors' and SPCs' data are not saved anymore.

The new API is available at

This file contains the new definition.

Major changes:

  • added the mandatory field statusPersonLodgingApplication to Applicant. The valid values are:
    • RegisteredRepresentativeBeforeTheUPC
    • NotARegisteredRepresentativeBeforeTheUPC
  • removed field listProprietor from Patent
  • removed field listSpc from Patent
  • added mandatory boolean field proprietorship to Patent. Must be set to true if the applicant is the person lodging the Application to opt out declares that details of each person entitled to be registered pursuant to Rule 8.5 have been provided as requested by the Rules of Procedure in the document attached to and uploaded with this Application for each patent to which this opt-out relates.
  • added mandatory boolean field spcInfoProvided to Patent. Must be set to true if spc information is provided in the document attached to and uploaded with this Applicantion.

The feature to upload of attached document for the optout will be added on the next release

There is no need to generate another key code.


[deprecated]  New version for Writing Data into UPC CMS

6 Feb 2017

New version of the API has been added.

The old API is still available at
It will be removed on the next release, and proprietor and spc data are not saved anymore.

The new API is available at

This swagger file contains the new definition.

Major changes:

  • revised SPC and SPC holder data
  • revised proprietor (same format as SPC holder)
  • new country indications (addresses.state and SPCData.nationalDesignation), must be encoded with ISO 3166-1 alpha-2
  • new endpoint /nationalDesignation (to get a list of national designations for SPC and proprietor. It contains dummy data; it will be a complete list with the next release
  • SpcData.nationalDesignation and Proprietor.nationalDesignation must comply with the list returned from /nationalDesignation
  • moved some check to early stage for feedback in case of input error ( must be well formed, etc)
  • added officialCaseNumber at CaseResult
  • added CaseResult to the ErrorResponse. It will help to track the case in error, by case number.

There is no need to generate another key code.

[deprecated] 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 APIs and parameters are in this Swagger file:

The current URL for accessing the APIs is:

[deprecated] 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 URL for accessing the APIs is:

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-KEY"
  • This swagger file describes all parameters and returned data