Purpose
Collecting authenticated ORCID iDs for all collaborators ensures that researchers are recognized for their contributions within works and funding metadata. It also facilitates easier tracking of research outputs and increases the visibility of a researcher’s profile.
This workflow explains how publishers, repository managers, research organizations, and funding organizations can embed ORCID iDs into workflows to streamline processes, improve the quality of scholarly metadata, and provide recognition for contributors.
Intended Audience
This document describes a workflow that may be implemented by publishers, repository managers, research organizations or funding organizations writing works and funding items to ORCID records.
Key Benefits
- Recognize Researcher Contribution: Collecting authenticated ORCID iDs for all contributors allows them to share information about their work and expertise with others, and to be publicly recognized for their contributions to the scholarly record.
- Automate Data Entry: Collecting authenticated ORCID iDs for all contributors ensures that they are recognized for their contribution and identified correctly within works and funding metadata.
- Enable Long-Term Discovery: Writing work and funding metadata to ORCID records transparently and reliably preserves vital information about scholarly outputs. Associating researchers directly with their contributions enables long-term discovery, access, sharing, reporting and other uses by the global research community.
Workflow
In a typical submission or application workflow, corresponding researchers authenticate their ORCID iDs upon submission. When multiple researchers are involved, organizations have to prompt collaborators to connect their ORCID iDs to system accounts. We recommend the following workflow, though variations may apply based on a specific use case. These steps could be implemented by a custom ORCID integration or an ORCID service provider system:
- When the submission has been accepted and/or published, the trusted organization uses the permission to add the work or funding metadata to the appropriate section of the collaborators’ ORCID records.
- A corresponding researcher (corresponding author, grant lead, or an organizational administrator) collects email addresses for all collaborators and shares them with the trusted organization (publisher/repository/funder) upon submission.
- The trusted organization emails the collaborators a unique link that redirects back to the submission system via ORCID authentication. Each collaborator grants permission for the trusted organization to read and/or update their ORCID record.
- The trusted organization uses the authenticated ORCID iD to populate the submission’s work or funding metadata in their system.
- If collaborators authenticate after publication, the trusted organization updates the submission’s work or funding metadata to include the authenticated ORCID iD.
Data Requirements
For work metadata, organizations can provide optional metadata in the contributor-attributes to describe the nature of the contribution by the collaborator or other contributor. Multiple roles can be added.
- contributor-role: the role performed by the collaborator or other contributor. Options include author, assignee, editor, chair-or-translator, co-investigator, co-inventor, graduate-student, other-inventor, principal-investigator, postdoctoral-researcher, support-staff. ORCID also supports additional CRediT roles. Read more about the role descriptions and metadata values here.
- contributor-sequence: indication of where in the contributor list the collaborator or other contributor’s name would appear. Options include first and additional.
For funding metadata, organizations can provide optional metadata in the contributor-attributes to describe the nature of the contribution by the collaborator or other contributor.
- contributor-role: the role performed by the collaborator or other contributor. Options include: lead, co-lead, supported-by, and other-contribution.
The contributor field in works and funding allows member integrations to list the researchers who have collaborated on a work or are party to a funded project.
For both funding and works, it is possible to include the contributor’s ORCID iD alongside the role. We suggest you add contributor’s ORCID iDs only if you have authenticated the ORCID iD, or have collected the ORCID iD from a source which has authenticated it. Multiple roles can be added.
The contributor sequence is used to indicate where in the contributor list the collaborator or other contributor’s names should appear. The 2 options that we support are:
- First
- Additional
Roles for works API 2.0
The below is the list of supported contributor roles using API 2.0.
- author
- assignee
- editor
- chair-or-translator
- co-investigator
- co-inventor
- graduate-student
- other-inventor
- principal-investigator
- postdoctoral-researcher
- support-staff
Roles for works API 3.0
With API 3.0, you can add the roles above plus additional CRedIT roles. The CRediT taxonomy consists of 14 contribution types to scholarly work, along with guidelines on how these roles may be assigned.
Below is the complete list with the UI value, the role description and the metadata value. The metadata value is the URL as per the NISO implementation recommendations ‘CRediT should be coded in JATS xml v1.2, described via this link: https://jats4r.org/credit-taxonomy.’
Only the URL will be accepted when adding roles via the API.
| TERM (UI Value) | DESCRIPTION | URL (API Value) |
|---|---|---|
| Conceptualization | Ideas; formulation or evolution of overarching research goals and aims. | https://credit.niso.org/contributor-roles/conceptualization/ |
| Data curation | Management activities to annotate (produce metadata), scrub data and maintain research data (including software code, where it is necessary for interpreting the data itself) for initial use and later re-use. | https://credit.niso.org/contributor-roles/data-curation/ |
| Formal analysis | Application of statistical, mathematical, computational, or other formal techniques to analyze or synthesize study data. | https://credit.niso.org/contributor-roles/formal-analysis/ |
| Funding acquisition | Acquisition of the financial support for the project leading to this publication. | https://credit.niso.org/contributor-roles/funding-acquisition/ |
| Investigation | Conducting a research and investigation process, specifically performing the experiments, or data/evidence collection. | https://credit.niso.org/contributor-roles/investigation/ |
| Methodology | Development or design of methodology; creation of models. | https://credit.niso.org/contributor-roles/methodology/ |
| Project administration | Management and coordination responsibility for the research activity planning and execution. | https://credit.niso.org/contributor-roles/project-administration/ |
| Resources | Provision of study materials, reagents, materials, patients, laboratory samples, animals, instrumentation, computing resources, or other analysis tools. | https://credit.niso.org/contributor-roles/resources/ |
| Software | Programming, software development; designing computer programs; implementation of the computer code and supporting algorithms; testing of existing code components. | https://credit.niso.org/contributor-roles/software/ |
| Supervision | Oversight and leadership responsibility for the research activity planning and execution, including mentorship external to the core team. | https://credit.niso.org/contributor-roles/supervision/ |
| Validation | Verification, whether as a part of the activity or separate, of the overall replication/reproducibility of results/experiments and other research outputs. | https://credit.niso.org/contributor-roles/validation/ |
| Visualization | Preparation, creation and/or presentation of the published work, specifically visualization/data presentation. | https://credit.niso.org/contributor-roles/visualization/ |
| Writing – original draft | Preparation, creation and/or presentation of the published work, specifically writing the initial draft (including substantive translation). | https://credit.niso.org/contributor-roles/writing-original-draft/ |
| Writing- review & editing | Preparation, creation and/or presentation of the published work by those from the original research group, specifically critical review, commentary or revision – including pre- or post-publication stages. | https://credit.niso.org/contributor-roles/writing-review-editing/ |
Example work contributor metadata:
<work:contributor> <common:contributor-orcid> <common:uri>https://orcid.org/0000-0001-5109-3700</common:uri> <common:path>0000-0001-5109-3700</common:path> <common:host>orcid.org</common:host> </common:contributor-orcid> <work:credit-name>Laure L. Haak</work:credit-name> <work:contributor-attributes> <work:contributor-sequence>first</work:contributor-sequence> <work:contributor-role>author</work:contributor-role> </work:contributor-attributes> </work:contributor>
Roles for funding
- lead
- co-lead
- supported-by
- other-contribution
Technical Documentation
Example work JSON under API v3.0 that includes multiple collaborators can be found here.
Example funding JSON under API v3.0 that includes multiple collaborators can be found here.