ORCID API Guide

URIs

Each of the calls below use a base URI which is different depending on the API Version:

  • Public API:   http://pub.orcid.org/
  • Member API:   https://api.orcid.org/
  • Sandbox API:   http://api.sandbox.orcid.org/

Scholar ORCID iD

Scholars are at the heart of everything that ORCID does. These resources affect information stored in a scholar's record.

Recource API Versions Description
GET orcid_id Public API
Member API
Returns the fields set as "Public" in the bio portion of the ORCID Record for the scholar represented by the specified orcid_id. When used with an access token and the Member API, limited-access data is also returned. (NOTE: The same results are returned for orcid_id/orcid-bio.)
GET orcid_id/orcid-bio Public API
Member API
As above.
GET orcid_id/orcid-works Public API
Member API
Returns the "works" research activities that are set as "Public" in the ORCID Record for the scholar represented by the specified orcid_id. When used with an access token and the Member API, limited-access "works" are also returned.
GET orcid_id/orcid-record Public API
Member API
Returns the fields and "works" research activities that are set as "Public" in the ORCID Record for the scholar represented by the specified orcid_id. When used with an access token and the Member API, limited-access data is also returned.
POST orcid_id/orcid-works Member API Adds one or more "works" research activities to the ORCID Record for the scholar represented by the specified orcid_id.
POST orcid_id/orcid-bio/external-identifiers Member API Adds one or more external identifiers to the ORCID Record for the scholar represented by the specified orcid_id.
PUT orcid_id/orcid-bio Member API Completely replaces all fields of the bio marked as PUBLIC or LIMITED in the ORCID Record for the scholar represented by the specified orcid_id, EXCEPT FOR elements containing lists such as External identifiers and Affiliations.
PUT orcid_id/orcid-works Member API Completely replaces all "works" research activities marked as PUBLIC or LIMITED in the ORCID Record for the scholar represented by the specified orcid_id.

Record Creation

New ORCID records can be created by institutions who employ scholars. ORCID authorizes the OAuth scope to enable this resource to be used at the start of ORCID Membership.

Recource API Versions Description
POST orcid-profile Member API
Research Institutions
Only
Creates new ORCID iDs and Records and notifies each scholar that the record has been created. The scholar has 10 days to decline the invitation before the iD is activated and information in the Record become accessible (according to the privacy model). The scholar may claim (start managing) or deactivate the ORCID Record at any time after it has been created.

OAuth

ORCID uses OAuth for authentication. Be sure to read Obtaining Access Tokens for more information about the process.

Recource API Versions Description
GET oauth/authorize Member API
Public API
Allows an ORCID client to obtain an OAuth Authorization Code from an authenticated ORCID user for a specific access scope.
POST oauth/token Member API
Public API
Allows an ORCID client to exchange an OAuth Authorization Code for an OAuth Access Token for a specific access scope.
POST oauth/token (for new iDs) Member API
Research Institutions
Only
Allows an ORCID client to obtain an OAuth Access Token to create new ORCID iDs and Records.
POST oauth/token (for reading public data) Member API
Public API
Allows an ORCID client to obtain an OAuth Access Token to make Public API calls using the Member API (and its service level agreement).

Feedback and Knowledge Base