To ensure that you build the best possible integration for your institution, your researchers, and the wider community, we have created these integration requirements. They will ensure a standardized user experience for an efficient collection of ORCID iDs and understandable request of user permissions. This allows you to focus on supporting and tracking research in your institution, and your researchers to more easily share information about their work. These practices are summarised in the 5 steps below. For more technical information please check out our Github Documentation and Integration guide.
Collect only authenticated iDs
It is critical that you collect ORCID iDs and obtain permission to read and update ORCID records, by first prompting users to sign into ORCID from within your system, and then retrieving their data from the ORCID Registry using the ORCID API. rather than being asked to type in or search for their ORCID iD. You should request and store permissions to read and update their ORCID record at the same time.
It is also essential to provide a documentation page on what ORCID is, the benefits to the individual and the wider community and an explanation of what your integration does.
You must provide a hyperlinked ORCID-branded button for collecting authenticated ORCID iDs: This can be at sign-in, within the researcher’s personal profile, or in a customized email to a researcher. Using an ORCID-branded button consistently helps ensure that researchers associate it with being asked to securely provide their iD, which in turn builds trust in ORCID as a reliable identifier.
Display collected iDs clearly
Displaying ORCID iDs clearly signals to your users that your system supports ORCID. It requires you to have collected validated ORCID iDs from researchers as described above. To complete the Display process:
Once a researcher has connected their ORCID iD to your system, publicly display their iD within your system so that they know that they have successfully connected and asserted their iD. Format the iD as descried in our , per our Brand Guidelines. Also include the authenticated iD in any metadata sent to third-party services when applicable.
You can help researchers get credit for their work by connecting validated information about their affiliation with you to their ORCID records. At the same time, you will be helping to build trust in scholarly communications. Request permission to read/write/ their ORCID record at the same time that you authenticate the researcher’s ORCID iD. You can then use the ORCID API to access information such as employment and education affiliations; publications, datasets and other works;funding, and peer review information.
Depending on the type of information you are pushing to ORCID you should include metadata related to it. For each kind we have technical tutorials that you can follow to ensure you send the most complete data to ORCID:
When relevant you should also include ORCID iDs in Crossref DOI metadata or DataCite DOI metadata , so that Crossref and DataCite can, with your researchers permission, automatically update their ORCID records.
Synchronize your system with ORCID
Meet researchers’ expectations that you will update their ORCID record with the latest information you have — and that any updates made by them or others on their ORCID record will, in turn, be made to your system(s).
Using the ORCID API to exchange information between your system and ORCID records allows up-to-date and accurate information to flow between your systems and other systems your applicants use. This provides the greatest benefit for your researchers, your organization, and the broader scholarly community – it enables researchers to spend more of their time making contributions and less time managing information about them; it makes information about your grants and supported researchers more accessible to the community; and it makes it possible to map funding, research, and researchers across time and place.
You should also provide a mechanism to allow researchers to submit correction requests, for example to correct typos or display errors.