ORCID members can update information they’ve previously added to an ORCID record. Only one item can be updated at a time, and it can only be updated using the client […]
How do I add an item using the ORCID API?
Items (works, employment, funding, peer review etc) can be added to an ORCID record using the ORCID member API. To do this, you must first obtain permission from the researcher […]
How do visibility settings work in the API?
Visibility indicates the privacy setting of the item, based on the user’s set visibility preference. If a visibility tag is included when information is posted via the API, it will […]
How do I delete an item using the ORCID API?
If you have added data that needs to be deleted, for example, if it has been associated with the wrong ORCID iD, then you can make an HTTP DELETE request […]
How do I use the ORCID Search API?
The ORCID search API uses the SOLR syntax. All query syntaxes available in SOLR 3.6 are supported, including Lucene with Solr extensions (default), DisMax, and Extended Dismax. You need a “/read-public” […]
Which fields does the ORCID Search API support?
The ORCID search API uses the SOLR syntax. All query syntaxes available in SOLR 3.6 are supported, including Lucene with Solr extensions (default), DisMax, and Extended Dismax. You can use a fielded […]
How do I explore the APIs?
In real-world situations, API interactions are completed by your system using a programming language such as PHP, Java, or Ruby on Rails. For practice and testing, you can interact with […]
How do I register a webhook?
Webhooks can be registered by premium members against any ORCID record in the registry. The steps are: Encode the URL URL-encode the URL that you want ORCID to call when […]
How do I unregister a webhook?
The URL for unregistering a webhook is the same as for registering. However, you need to use the HTTP DELETE method. The response should be 204 No Content.
What does a webhook callback look like?
The ORCID Registry will do the following HTTP call when a record is updated. The request uses the HTTP POST method, but the body of the request is empty. Your […]