ORCID can be used in repository systems to clearly link authors—and all their name variants—with their research work, improving search and retrieval to support networking and collaboration. Using the ORCID API, repository systems can exchange data with the ORCID Registry to populate local author profiles. You can also update ORCID records with publication information each time a repository deposit is made.
Search & link wizards: Large repositories which are open and accessible to researchers can create Search & Link wizards to benefit the entire community. These are links from the ORCID Registry user interface which first request researchers’ update permission and then redirect to your system. They require considerable testing between the provider and ORCID. Get in contact with the ORCID Engagement Team if you are interested in creating a Search & Link wizard.
Typically a repository workflow will follow the steps below, although we are aware that this can vary between integrators depending on specific use cases.
- The repository collects the researchers authenticated ORCID iD and requests permission to interact with their record, and stores that permission. This allows the administrators to request authenticated ORCID iDs and ORCID record update permission from authors and co-authors, in cases where iDs are missing or have not been authenticated in the metadata received.
- Once the researcher has connected their ORCID iD to your system, clearly display their iD on their profile within your system so that they know that they have successfully connected and asserted their identity. Format the iD as a hyperlinked URI and include the green iD icon, per our iD Display Guidelines. Also include the authenticated iD in any metadata sent to third party services when applicable.
- With the users permission:
- read the publications that are available on the users ORCID record and add import to your repository
- Update the users ORCID record with the publications that are available within the repository
Example
Benefits
Repository systems integrations with ORCID add visibility to repository content and their authors, facilitate collaboration and networking, and help organizations with institutional reporting systems and national assessment programs.
More information
Items (works, employment, funding, peer review etc) can be added to an ORCID record using the ORCID member API. You will need the following:
- The researchers permission
- Member API credentials
- And either:
- A vendor system that integrates with the ORCID Member API
- Your own system that integrates with the ORCID Member API
To support the social component we offer a toolkit of Outreach Resources to help you develop a campaign to support your integration, and communicate to your researchers:
- What ORCID is.
- Why your system collects iDs and how your system will perform tasks, such as updating their records.
- Why your researchers will benefit by creating an ORCID iD and connecting their iDs to your system.
- How ORCID benefits the wider, global research community.
We will be continually building out this “library” of resources based on feedback from the community. If you have an idea for something you might like to see, please feel free to contact us.
You collect authenticated IDs when you ask a researcher to sign in with their ORCID iD. This process uses a technology called “OAuth” or “SSO” and should be built into your workflow.
See the API Tutorial ‘Get an Authenticated ORCID iD‘ for more details.
The process to get permission to add or update data on a user‚s ORCID record uses OAuth, as described in our 3 Legged OAuth FAQ. Only ORCID members can use the Member API to ask for update permissions. In simple terms it works like this:
- Your local system creates a special link
- When clicked, the user is sent to ORCID, signs in and grants permission
- ORCID sends the user back to your system with an ‘authorization code’
- Your system exchanges that code for an ‘access token’
- The access token lets you update the user’s record
Collecting validated ORCID iDs for individuals through the OAUTH process is important. Individuals sign into their ORCID accounts using their registered email address and password or they can create a new account and then authorize your system to obtain their ORCID iD. This ensures you get the correct ORCID iD for the researcher and that the information on that record reflects their research activities (see What’s So Special About Signing I).¬¨‚
You can help make life easier for your users by connecting validated information to their ORCID records. You will also be helping to build trust in scholarly communications and, by keeping that data up to date, you can reduce the reporting burden for your users and improve data quality.
ORCID for Research Organisations
In addition to its use as a persistent identifier for your researchers, ORCID can help you take control of how your institution‚s name is used across research systems. In combination with other persistent identifiers ORCID enables you to authoritatively assert your staff, faculty, and student affiliations with your institution. You can also use ORCID APIs to receive real-time notifications about research activities, to auto-update forms, and to follow your alumni’s careers.
ORCID for Funding Organisations
By embedding ORCID iDs in your funding workflows, you can reliably connect your grantees and funding programs — and save everyone time and reduce errors caused by manual keying of information. Using ORCID in your system(s), you can play your part in building a trusted research information infrastructure by asserting connections between individuals and the grants you award them.
ORCID for Publishers
Researchers are at the heart of everything that scholarly and research publishers do. Accurate author and reviewer information is vital to indexing, search and discovery, publication tracking, funding and resource use attribution, and supporting peer review.
ORCID serves as an information hub, enabling your authors and reviewers to reliably connect to their contributions, and to share information from their ORCID record as they interact with your publishing systems. Collecting iDs for all your authors and reviewers during the publication process — whether for books, journals, datasets, compositions, presentations, code, or a variety of other works — allows for information to be easily shared, ensures researchers can provide consent to share, saves researchers time and hassle, reduces the risk of errors and, critically, enables researchers to get the credit they deserve for the important work they’re doing.
I have developed my integration using the Sandbox, how do I get Production member API credentials?
Member organizations request ORCID Member API credentials on the production (live) server by completing the Production Member API client application form. Before issuing production Member API credentials, the ORCID Engagement team will review a demo of your integration in the ORCID sandbox. This gives us a chance to see the great integrations you have built and offer workflow improvements, as well as check that all integrations meet our best practices.
To provide a demo of your system you’ll need to set up a working integration with the ORCID sandbox that the ORCID team can preview. There are a few ways to share your working sandbox integration:
- Recommended: Live demo: Contact us to schedule a live demonstration. We’ll provide meeting software that allows you to share your screen for you to demo your integration. This also gives us an opportunity to learn more about how your system works, and how you‚re explaining the benefits of your ORCID integration, so we can provide better support for you and your users.
- Test site: If your development site is public, send us the URL along with test credentials (if needed) to access your system and instructions describing how to use your system’s ORCID features. Provide additional documentation to verify what we would not be able to see from the user end, e.g. API version used, what data is stored by your system, etc.
- Screencast or screenshots (recommended for ORCID-enabled systems which require a demonstration): Send a recording or a set of screenshots with descriptions clearly explaining and demonstrating how your integration works at each step, including what happens if a user denies access or disconnects their iD. Be sure to provide additional documentation to verify anything we would not be able to see from the user end, such as API version used and how data is stored.¬¨‚
If you are using one of the ORCID-enabled systems that does not require a demonstration, you can directly request production Member API credentials. Be sure to specify which system (and, if applicable, version) you’re using in the notes.
- Title:* The title of the work
- Subtitle: A subtitle to the work
- Translated-title: The title the work appears under in another language, the language of the translated title is recorded as an attribute
- Journal-title: The name of a larger collection the work belongs to, such as a journal for journal articles or a book for book chapters. Even though this is labelled journal title it can be used for other works
- Short-description: A brief description or abstract of the work
- Citation-type: The format the citation is provided in. This field is selected from a list containing the following values: APA, BIBTEX, CHICAGO, HARVARD, IEEE, MLA, RIS, UNSPECIFIED, VANCOUVER
- Citation-value: The contents of the citation
- Work-type: The type of object the work is. This field must be selected from the supported work types
- Publication date: The date the work was published. We recommend the earliest publication date is used
- External-id-type:* The type of identifier. This field must be selected from the supported work identifiers
- External-id-value:* The identifier itself
- External-id-url: A url the identifier resolves to
- External-id-relationship:* Identifiers that apply only to the work being added would be marked as Self. Identifiers that apply to a larger collection this work belongs to would be set to Part-of. Identifiers that apply to alternate versions of the work would be set to version-of. Identifiers that apply to the funding for the work would be set to funded by.
- Work-url: A url linking to the work
- Work-contributors: Information about the individuals who created the work
- Language-code: The language used to describe the work in the previous fields
- Country: A country the work was published in or otherwise associated with
* Indicates required field
ORCID was a key member of the ORCID in Repositories working group which was charged with drafting recommendations for repository platform developers, intended to ensure a consistent base level of support for ORCID across different platforms, allowing repository administrators to implement ORCID effectively ‘out of the box. Please see our blog post for full details.
Technical documentation
A more detailed tutorial can be found here.
Repository best practice
For more information, please read the full ORCID in Repositories Task Force report.