XSD 3.0 is now available on the production ORCID Registry and sandbox as a stable release version. This article outlines changes between API 2.1 and API 3.0.
The update from v2.1 to v3.0 includes new features and small improvements, but does not involve major changes from v2.0/v2.1. The most notable changes are:
- Addition of research-resources section. This section captures information about resources that researchers use for their research, and which require a specific proposal process or credential to access, such as special collections, equipment, infrastructure, and services. For more information see the Research-resource tutorial
- New affiliation sections. Sections for distinction, invited-position, membership, qualification, and service have been added, in addition to the existing education and employment sections. For more information see Affiliations tutorial
- Token delegation. This allows member clients to give a second client permission to update an ORCID record on on their behalf. This process is described in the Token Delegation tutorial
- Organization identifiers. These are now required when adding an affiliation or funding item via the API
- New identifier relationship. Version-of can be used to link different versions and instances of the same work
- Work:journal-title. This field is now returned with the work summary
- Supported work types. Addition of software to the list of supported work types and migration of dissertation to dissertation-thesis
- Normalized identifiers when reading items. This system generated field expresseses the identifier in a standard format that is used for grouping.
- JSON enumerated types. These are now expressed in lowercase with dashes instead of underscores, matching the existing XML enums (ie JOURNAL_ARTICLE is now expressed as journal-article)
The new XSD for version 3.0 can be found in the ORCID GitHub repository. No further major revisions to v3.0 are planned.
For more information about the schema updating process and how release candidates work, see
Documentation on the ORCID API can be found in three locations:
- GitHub: ORCID XSD, example files, full list of API scopes, full list of API calls (with examples)
- Swagger (Sandbox: Public API, Member API; Production: Public API): List of all possible API calls on public and member API, ability to try calls using your own credentials
- Member support center: Documentation to support members building integrations with the ORCID Registry, including workflows of sample integrations (e.g. institutional repositories, manuscript submission systems), communications, and tutorials on searching, reading, and updating ORCID records using the ORCID API