API News & Updates

ORCID command line conversion tool and Java model

ORCID is releasing a command-line tool that can be used to translate ORCID XML into ORCID JSON and vica-versa.  This is intended to help when working with S3 data files, and can process v2.0, v2.1 and v3.0rc1 formatted files.

API Version 1.2 turned off August 1

On August 1 we will be turning off the 1.2 version of the API for member integrations. 

Our Community team has contacted all members that we know are still using version 1.2 to make sure they plan to update to 2.0/2.1 before this deadline or have requested an extension. If you are still using version 1.2 on the member API, or are unsure if you are, and have not been in contact with the ORCID Community team, please reach out to them ASAP at support@orcid.org.  They will provide more information about how to request a one-month extension to complete your upgrade.

Public API now only supports API 2.0+

Today we sunset version 1.2 of the public API. Going forward, any public clients using v1.2 in their calls will get an error message. 
 

API defaults to 2.0 in February, 1.2 no longer supported on Public API from March

From February 1, 2018: the default version used for API calls will move from version 1.2 to 2.0

This change will only affect calls that do not specify the version. As we always encourage all clients to specify a version, we hope this change will not cause any problems. If your integration does not currently specify a version you can add ‘v1.2’ to your calls - but you will still need to complete the upgrade to version 2.0 or 2.1 ASAP.

API 2.1 now live

We are delighted to announce that the latest version of our API - version 2.1 - is now live. 
 
The only difference between 2.0 and 2.1 is in the format of the ORCID iD, now updated to the HTTPS canonical form: https://orcid.org/0000-0001-2345-6789. There are no other functional changes to API calls or the XSD in this release. If you prefer to stay on 2.0, please rest assured it will receive the same support and sunset date as 2.1 (and we hope to push the sunset date out as far as possible).