Ticket of the month - February 2022 - ORCID auto-update notifications

We get many questions from contributors (e.g., authors) and members about ORCID auto-update. Sometimes contributors are expecting an auto-update notification for a DOI that was recently registered and are not receiving it. Typically this is when we, Crossref support, will hear from the contributor or the member registering that contributor’s metadata (and, ORCID iD).

For this post, I’m going to use a DOI that I co-authored back in 2016 - 10.1190/INT-2016-0411-FE.1.

The DOI was originally registered on 2016-May-18.

As you can see from the image above (from our admin tool - doi.crossref.org), the submission was received by Crossref at 11:44:42 ET and was finished processing at 11:45:52 ET. Within 2 to 3 minutes (at most) of that finished time, the DOI would have been registered and successfully resolving to its resource resolution URL.

Here’s the full metadata record today for that DOI (in our XML API):
https://0-doi-crossref-org.lib.rivier.edu/search/doi?pid=support@crossref.org&format=unixsd&doi=10.1190%2FINT-2016-0411-FE.1

Below is the metadata critical for ORCID auto-update. As you can see here, my ORCID iD has to be included in the metadata registered to trigger auto-update.

<person_name sequence="additional" contributor_role="author">
<given_name>Isaac</given_name>
<surname>Farley</surname>
<ORCID>http://orcid.org/0000-0002-9117-4510</ORCID>
</person_name>

From there, after a successful registration, we push that metadata that was registered to our APIs. The XML API takes 1 to 2 hours to index. This is the DOI in question in the XML API: Let’s get animated!

The push to index the metadata in our REST API can take longer. Usually metadata is available within 24 hours of successful registration in the REST API, but sometimes that process can take 48 hours - depending on the amount of other metadata registered, across all members.

Here’s that same DOI in our REST API:
https://0-api-crossref-org.lib.rivier.edu/works/10.1190/INT-2016-0411-FE.1

[Note: You may wish to download a JSON formatter for your browser in order to best view this information. I use this extension for Google Chrome, but there are other extensions and other browsers, so I encourage you to find one that is right for you: JSON Formatter - Chrome Web Store]

The REST API is what serves ORCID auto-update, so a newly registered DOI will not trigger auto-update until that DOI has been indexed in the REST API. So, there can be a lag.

In recap, for me to get an auto-update notification in my ORCID account:

  1. My ORCID iD must be included in the metadata registered. It’ll look like this:
<person_name sequence="additional" contributor_role="author">
<given_name>Isaac</given_name>
<surname>Farley</surname>
<ORCID>http://orcid.org/0000-0002-9117-4510</ORCID>
</person_name>
  1. I must grant permissions for Crossref to add works on this prefix to my account. You can learn more about this step in the ORCID documentation here: https://support.orcid.org/hc/en-us/articles/360006971293-Auto-updates-in-third-party-systems-Crossref

  2. Notifications within my ORCID account must be enabled. To enable auto-update, you’ll need to follow these instructions on the ORCID website: https://support.orcid.org/hc/en-us/articles/360006896394-Auto-updates-time-saving-and-trust-building. Please ensure that you do not have your permissions “An ORCID member wants your permission to add or update my ORCID record” set to “Never (no emails or inbox notifications)” within your ORCID account (see attached screenshot).

If all of these criteria are met, I can expect to receive notifications to my ORCID inbox, like this:

Thanks for reading!
-Isaac

3 Likes

Hi all. An update to this ticket that I wrote back in February.

ORCID auto-update currently supports the first ten ORCID iDs on a record. If, say, you’re the 28th author of a work and there are 14 ORCID iDs in that metadata prior to yours, our auto-update solution will not work for you, as you’re not one of the first ten ORCID iDs in the record. As more authors adopt ORCID iDs and more members register ORCID iDs with us, we’re seeing more examples of these gaps. We’re aware of this limitation, but we do not yet have this fix prioritized for a short-term fix. You may monitor our progress here: As an author of a paper I want all authors to benefit from ORCID autoupdate, not just the first 10, so that we all save time updating our ORCID profiles (#1693) · Issues · crossref / DEPRECATED Issue Tracker · GitLab

1 Like