In addition to employment and education affiliations, ORCID users and members can also add membership and service activities.
Membership organizations such as scholarly societies can recognize your members and those who donate time and expertise; funders can recognize your board members; publishers can recognize editorial boards and conference organizers can recognize your planning committees.
This is great news for committee members, panel experts, advisory boards, and others who would like to be able to share information about their work and expertise with others, and to be publicly recognized for it.
There are two generalized workflows for adding affiliation assertions: by collecting ORCID iDs on registration, or by emailing existing users and asking them to connect their iD to your system. Both have three components: authenticate, connect, and display.
Workflow 1: Collecting iDs up front using registration systems
In this scenario, ORCID iDs are a requirement of registration, for example:
- When joining a society/renewing a membership, or when joining a board or panel. When registering their details via a web form, registrants are asked to authenticate their ORCID iD and grant your organization permission to interact with their record.
- Once their registration is approved, your system updates the appropriate section of the individual’s ORCID record with details of their membership or service activities, connecting them with your organization.
- Their ORCID iD should be displayed alongside any publicly available information about them.
Workflow 2: Collecting iDs retrospectively
If your system already contains information about members and/or service activities, or if it does not have a registration component, then you can instead:
- Email individuals a unique link they can use to connect themselves with your system.
- When clicked, this link directs the individual to ORCID to authenticate their iD and grant your organization permission to update their record.
- You then redirect them to a specially created web page you provide.
- Your system stores the link between the ORCID iD and email address/user account, and uses the permissions the individual has granted to update the appropriate section of their ORCID record, connecting them and their activity with your organization.
- Display their authenticated ORCID iD alongside any publicly available information about them.
Affiliation assertions contain start dates and end dates. The workflows above provide long-term update permissions, which can be used to update the end date when an individual’s period of service finishes. As well as providing a start date when you first update their record, your system should also use the ORCID API to add an end date to your researchers’ records, to make their full term of service for or membership of your organization clear.
You can help your researchers get credit for their membership and service 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. By asserting the connection between individuals and your organization — connections that only your organization can make authoritatively — you ensure that your organization is appropriately acknowledged when your employees and affiliates make professional contributions. That information can then be shared, with the researcher’s permission, with the other systems they interact with, helping to create a trustworthy research information infrastructure.
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.
All affiliation sections use the same set of metadata in the API:
- Organization name:* The name of the organization at the highest level (e.g. “Boston University”, rather than “Boston University School of Medicine”).
- Organization city:* City of where the organisation is based.
- Organization region: Region of where the organisation is based.
- Organization country* the country of the organisation. This should be populated with the two letter ISO 3166 Alpha-2 country code.
- Organization ID (ROR, GRID, Ringgold** or LEI):* A unique identifier for the organization and its source. We recommend that the parent organization ID is used within the affiliation and not the division or department.
- Role/Title: The position held, or the degree awarded or to be awarded.
- Department: Any subdivision of the parent organization.
- URL: A URL to a resource about the affiliation
- Start date: The date the relationship between the researcher and organization began (can be specified down to year, month, and day).
- End date: The date the relationship between the researcher and organization ended (can be specified down to year, month, and day)
- An external persistent identifier describing the affiliation: A unique identifier for the actual affiliation assertion
*Indicates a required field.
**Although Ringgold identifiers still exist within the ORCID registry, as of 1 August 2023, ORCID no longer receives updates to the RINGGOLD organization identifier database used by our Registry, nor will we be able to process or use RINGGOLD IDs created after that date. See our FAQ for more info.
A more detailed tutorial can be found here.