v2.1 is a current stable release of the ORCID API.
- activities-2.1.xsd stable
- address-2.1.xsd stable
- bulk-2.1.xsd stable
- common-2.1.xsd stable
- education-2.1.xsd stable
- email-2.1.xsd stable
- employment-2.1.xsd not stable
- error-2.1.xsd stable
- external-identifier-2.1.xsd stable
- funding-2.1.xsd stable
- keyword-2.1.xsd stable
- other-names-2.1.xsd stable
- peer-review-2.1.xsd stable
- person-2.1.xsd stable
- personal-details-2.1.xsd stable
- record-2.1.xsd stable
- researcher-url-2.1.xsd stable
- search-2.1.xsd stable
- work-2.1.xsd stable
With version 2.1, ORCID iDs are expressed in the canonical form with the https prefix.
Example of a source ORCID iD in 2.1
<common:source-orcid>
<common:uri>https://orcid.org/8888-8888-8888-8880</common:uri>
<common:path>8888-8888-8888-8880</common:path>
<common:host>orcid.org</common:host>
</common:source-orcid>
- read activities-2.1.xml
- read address-2.1.xml
- write address-2.1.xml
- write bulk-work xml-2.1.xml
- write bulk-work-2.1.json
- read biography-2.1.xml
- read education-2.1.xml
- write education-2.1.xml
- read educations-2.1.xml
- read email-2.1.xml
- read emails-2.1.xml
- read employment-2.1.xml
- write employment-2.1.xml
- read employments-2.1.xml
- error-message-2.1.xml
- read external-identifier-2.1.xml
- write external-identifier-2.1.xml
- read external-identifiers-2.1.xml
- read funding-2.1.xml
- write funding-2.1.xml
- read fundings-2.1.xml
- read keyword-2.1.xml
- write keyword-2.1.xml
- keywords-2.1.xml
- read other-name-2.1.xml
- write other-name-2.1.xml
- read other-names-2.1.xml
- read peer-review-2.1.xml
- write full peer-review-2.1.xml
- write simple peer-review-2.1.xml
- read peer-reviews-2.1.xml
- read person-2.1.xml
- read personal-details-2.1.xml
- read researcher-url-2.1.xml
- write researcher-url-2.1.xml
- read researcher-urls-2.1.xml
- search-2.1.xml
- read work-2.1.xml
- write full work-2.1.xml
- write simple work-2.1.xml
- read works-2.1.xml
For working with json see ORCID conversion util
The swagger interfaces to the API available at:
CORS is supported for the Public API, Implicit OAuth and Force Logout only. JSONP for CORS is not supported. For more information on CORS and supported content types please visit our Content Negotiation page.
Scope | Request method | Obtain Access Token Through | Expires In | API |
---|---|---|---|---|
/authenticate | No API call. Client retrieves access token only. | 3-legged OAuth | Single authentication | Public API and Member API |
/activities/update | POST, PUT, DELETE | 3-legged OAuth | When expired or revoked by user | Member API |
/person/update | POST, PUT, DELETE | 3-legged OAuth | When expired or revoked by user | Member API |
/read-limited | GET | 3-legged OAuth | When expired or revoked by user | Member API |
/read-public | GET | Client credentials | When revoked by ORCID | Public API and Member API |
/webhook | PUT, DELETE | Client credentials | When revoked by ORCID | Premium Member API |
Action | HTTP method | Scope | URL |
---|---|---|---|
Read the entire record | GET | /read-limited or /read-public | https://[HOST]/v2.1/[ORCID]/record |
Read an activities section | GET | /read-limited or /read-public | https://[HOST]/v2.1/[ORCID]/[SECTION]s |
Read a person section | GET | /read-limited or /read-public | https://[HOST]/v2.1/[ORCID]/[SECTION] |
Read a single item | GET | /read-limited or /read-public | https://[HOST]/v2.1/[ORCID]/[SECTION]/[PUT-CODE] |
Add a person item | POST | /person/update | https://[HOST]/v2.1/[ORCID]/[SECTION] |
Update a person item | PUT | /person/update | https://[HOST]/v2.1/[ORCID]/[SECTION]/[PUT-CODE] |
Delete a person item | DELETE | /person/update | https://[HOST]/v2.1/[ORCID]/[SECTION]/[PUT-CODE] |
Add an activity | POST | /activities/update | https://[HOST]/[ORCID]/[SECTION] |
Update an activity | PUT | /activities/update | https://[HOST]/v2.1/[ORCID]/[SECTION]/[PUT-CODE] |
Delete an activity | DELETE | /activities/update | https://[HOST]/v2.1/[ORCID]/[SECTION]/[PUT-CODE] |
Add multiple works | POST | /read-limited or /read-public | https://[HOST]/v2.1/[ORCID]/works |
Read multiple works | GET | /activities/update | https://[HOST]/v2.1/[ORCID]/works/[PUT-CODE1],[PUT-CODE2] |
Search records | GET | /read-public | https://[HOST]/v2.1/search?q=[SOLR-QUERY]* |
[HOST] is the ORCID environment you are using
- api.sandbox.orcid.org for the Member API on the ORCID Sandbox
- pub.sandbox.orcid.org for the Public API on the ORCID Sandbox (/read-public scope only)
- api.orcid.org for the Member API on the production ORCID Registry
- pub.orcid.org for the Public API on the production ORCID Registry (/read-public scope only)
[ORCID] is the ORCID iD for the record.
[SECTION] can be one of the following:
- activities
- address
- biography *
- education
- email *
- employment
- external-identifiers
- funding
- keywords
- other-names
- researcher-urls
- peer-review
- person *
- personal-details *
- work
* Read only
Notes:
- biography, email, person and personal-details sections are read only
- when reading multiple works a maximum of 50 works can be accessed with a single call, when posting multiple works a maximum of 100 works can be posted with a single call.
- When searching by default a maximum of 100 results will be returned. The
rows
parameter can be used to increase the number or results, but only up to 200. Thestart
parameter (integer pointing to the zero-based position of the first result to be returned) can be used to page through larger results sets. For help with SOLR searching see https://cwiki.apache.org/confluence/display/solr/The+Standard+Query+Parser
Item | Scope | Example cURL Statement |
---|---|---|
Entire record | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/record' |
Activities summary | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/activities' |
Addresses | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/address' |
Education items | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/educations' |
Emails | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/email' |
Employment items | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/employments' |
External identifiers | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/external-identifiers' |
Funding summary | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/fundings' |
Keywords | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/keywords' |
Other names | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/other-names' |
Peer review summary | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/peer-reviews' |
Personal details | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/personal-details' |
Person | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/person' |
Researcher URLs | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/researcher-urls' |
Works summary | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/works' |
Item | Scope | Example cURL Statement |
---|---|---|
Address | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/address/4556' |
Biography | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/biography' |
Education | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/education/22423' |
Employment | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/employment/22411' |
External identifier | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/external-identifiers/3193' |
Funding | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/funding/4413' |
Keywords | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/keywords/4504' |
Other names | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/other-names/15812' |
Peer review | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/peer-review/1374' |
Researcher URL | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/researcher-urls/41387' |
Work | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/work/733536' |
Multiple Works | /read-limited or /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/works/733535,733536' |
When reading multiple works the contents of each work is returned or an error code is returned if there is an issue with a single work.
Item | Scope | Example cURL Statement |
---|---|---|
Address | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/address.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/address' |
Education | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/education-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/education' |
Employment | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/employment-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/employment' |
External identifiers | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/external_identifier.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/external-identifiers' |
Funding | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/funding-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/funding' |
Keywords | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/keyword.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/keywords |
Other names | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/other-name.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/other-names' |
Peer review | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/peer-review-item.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/peer-review' |
Researcher URL | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/researcher-url.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/researcher-urls' |
Work | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/work.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/work' |
Multiple works | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/works.xml' -X POST 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/works' |
When posting multiple works the contents of each work is returned or an error code is returned if there is an issue with a single work, see bulk work error sample.
Item | Scope | Example cURL Statement |
---|---|---|
Address | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/address.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/address/[PUT-CODE]' |
Education | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/education-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/education/[PUT-CODE]' |
Employment | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/employment-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/employment/[PUT-CODE]' |
External identifiers | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/external_identifier.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/external-identifiers/[PUT-CODE]' |
Funding | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/funding-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/funding/[PUT-CODE]' |
Keywords | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/keyword.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/keywords/[PUT-CODE] |
Other names | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/other-name.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/other-names/[PUT-CODE]' |
Peer review | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/peer-review-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/peer-review/[PUT-CODE]' |
Researcher URL | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/researcher-url.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/researcher-urls/[PUT-CODE]' |
Work | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -d '@[FILE-PATH]/work-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/work/[PUT-CODE]' |
When updating a record item, include the put code as an attribute in the root element, ex: <education:education put-code="14775" xmlns:common="http://www.orcid.org/ns/common" xmlns:education="http://www.orcid.org/ns/education" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.orcid.org/ns/education ../education-2.1.xsd ">
Item | Scope | Example cURL Statement |
---|---|---|
Address | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/address/[PUT-CODE]' |
Education | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/education/[PUT-CODE]' |
Employment | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/employment/[PUT-CODE]' |
External identifiers | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/external-identifiers/[PUT-CODE]' |
Funding | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/funding/[PUT-CODE]' |
Keywords | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/keywords/[PUT-CODE]' |
Other names | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/other-names/[PUT-CODE]' |
Peer review | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/peer-review/[PUT-CODE]' |
Researcher URL | /person/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/researcher-urls/[PUT-CODE]' |
Work | /activities/update | curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'https://api.sandbox.orcid.org/v2.1/0009-0003-7578-3214/work/[PUT-CODE]' |
Item | Scope | Example cURL Statement |
---|---|---|
Register a webhook | /webhook | curl -v -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X PUT 'http://api.sandbox.orcid.org/0009-0003-7578-3214/webhook/http%3A%2F%2Fencoded.url%2F0009-0003-7578-3214' |
Delete a webhook | /webhook | curl -v -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' -X DELETE 'http://api.sandbox.orcid.org/0009-0003-7578-3214/webhook/http%3A%2F%2Fencoded.url%2F0009-0003-7578-3214' |
Item | Scope | Example cURL Statement |
---|---|---|
Search records | /read-public | curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer 42c0aff8-a216-4cd9-8c13-6d3a8a2aa853' 'https://api.sandbox.orcid.org/v2.1/search?q=Simpson' |