These workflows set out the ways in which an ORCID member can integrate with the ORCID API to collect authenticated ORCID iDs from your researchers, gain permission to, and update their ORCID records. They are applicable for any organization that would like to add biographical items to researchers’ ORCID records, such as other names by which they are known, keywords, links to external websites (e.g. faculty profile pages), their country or region, and other unique identifiers created by the organization’s own system(s).
Our API allows members to add biographical items to ORCID records with the researcher’s permission.
For example, as a member organization you can add links to your researcher’s profile page as a website link, or add an external identifier generated from your own system.
This is great news for your researchers, as adding links to other websites within their ORCID record helps with search engine indexing, making their work more discoverable. Adding country codes helps anyone using ORCID data for analytics. Connecting alternate names to ORCID records enables researchers to be discovered using other representations of their name, such as abbreviations and transliterations. Together, all these sections help anyone browsing an ORCID record to more easily discover the context in which the researcher works.
The section of the ORCID record that contains biography information appears like this:
There are a number of sections under the biography part of an ORCID record:
Also known as: This can include an abbreviated first name, variants including initials for one or more first names, middle name(s), former or alternate name(s), or name(s) in a different character set. Each name should be added as a single item. This is a free text field up to 255 characters.
Websites: This section includes a description (optional) and a website URL (required)
Country: The Country section of an ORCID record allows researchers and member organizations to add one or more countries where they conduct research, or that are the topic of their research. The items in the country list are sourced from ISO 3166, the international standard for country and region codes.
External identifiers (Other IDs): This section can only be added by member organizations. Please note that, although many organizations collect other external identifiers for their researchers, e.g. Scopus Author IDs, only the issuer of those identifiers can assert them authoritatively. We therefore strongly recommend that your organization only adds identifiers which your system(s) created and uses to identify researchers. This section includes four components (* indicates a required field):
- ID type*
- ID value*
- ID relationship*
- ID URL
Depending on your integration there could be a number of workflows where you can obtain permission from the researcher to interact with their ORCID record, whether as a supplementary workflow when asserting affiliations or works, or one focused on updating person identifiers or other biographical details. All follow the same process, as outlined below.
It is critical that you collect ORCID iDs and obtain permission to read and (members only) 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. It is also essential to provide information within your system about why you are collecting ORCID iDs and why this is beneficial to your users.
You must provide a hyperlinked ORCID-branded button for collecting authenticated ORCID iDs: This could 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.
Help your researchers distinguish themselves from others by connecting information about them in your systems to their records. They can then choose to share the information with other organizations and systems they interact with, saving time and hassle and reducing the risk of errors.
Adding information to ORCID records involves sending formatted data to the ORCID Registry using the ORCID API, and saving the code that the ORCID Registry returns for each item. Doing this requires that you have collected both ORCID iDs and update permission as described in Authenticate above.
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 in Authenticate. To complete the Display process:
Once a researcher has connected their ORCID iD to your system, publicly display their iD on their profile within your system, so 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.