Permalink
Switch branches/tags
3.0-docs-edits 3.0-edits-2 3.0_rc1-docs-edits 4804-account-deactivate-account AddPreprintTorc2 AddPreprintWorkType AdminActions_FixBugsWhenHittingEnter AdminActions_Fixes AdminSwitchToDisabledRecords AllowDuplicatedVersionOf ArXivResolver AvailableLocalesEnum Card3325-print-record-peer-review-section-oddness Card3461-update-header-layout Card3663-bulk-editing-delete-visibility-for-all-activities-sections-of-orcid-record ClaimNG2 DisplaySwitchUserOnLockedRecordsWhenAdminIntoThem DissertationThesis DissertationToDissertationThesisDBUpdate FillDisambiguatedOrgData FixManageMembersUserSwitch FixManageMembersUserSwitch2 FixSavedRequestIssue FundrefImporter_AllowOrgTypeUpdate ImprovementsOnPublicPage IncludeWorkContributorORCIDOn3.0rc1 IsVersionOf LowercaseEmailBeforeLookingAtAccountsToReactivate Ng2AdminModule PreprintUnderPublicationCategory PublicClientNG2 RefactorNotificationQueries ResetPassword_EmailValidation SendEmailVerificationToNewEmailsOnReactivation SeparatePropertiesForCreateAndViewWorkBulks Set403InsteadOf401OnSomeBBTests UpgradeSpringAndJacksonLibs UpgradeSpringCoreSpringSecurityAndJacksonLibs UpgradeSpringOnOrcidTest UsePersonalDetailsEndpointForSearchResults ValidateResetPasswordEmailId aCoupleMoreNg2BBFixes accountNg2 activitiesAddCreatedLastMod addClientIdToTokenEndpointLogs additionalPeerReviewSubjectTypes affiliationsNoDates alainna-patch-1 alainna-patch-2 alainna-patch-3 alainna-patch-5 alainna-patch-6 alainna-patch-8 anotherBunchOfNg2BBTestFixes apiV2GETPeerReviewWithFundingSubjectType apiV3Bugs arabicIconMisaligned bb_tests_workflow_update bulk-work-xml-updates bulk-works-edit bulkErrorTweaks bulkWorksPostBug catchAndLogExceptionCreatingFirefoxDriver claimStyleMatchRegister clean_up_maven_repo clientEditNg2 clientLoggingOn clientMissingFromSourceUri countriesOrder deactivateAccountTextUpdates delegatesNg2Fixes devToolsTokenReqFixSpace dreamofaredbird-3.0-edits-1 dreamofaredbird-3.0-edits dreamofaredbird-minor-typos dreamofaredbird-typo email-hash-integration-test emailPrefsLineBreak emailVerifiedUpdateProperties ensureOnlyOneNameValueUsedInShibSignin excludeLEIFromOrgsDropDown extIdsHandleMissingRelationship extIdsHandleNullUrl fix-bio-and-name-variables fix-bulk-edit fix-link-works-url fix-loading-id-section fix-popover-position fix-print-name-and-bio fix-relogging-alert fix-space-between-commas fix-switch-for-locked-users fix-url-color fix-works-id fixClaimPage fixDuplicatePublicRecordLastMod fixEmailVerifedMsgNotSignedIn fixInboxV3rc2 fixNameVisInSelfService fixNotoFont fixNpeWhenAddingExtId fixSelfServiceAddContact fixSelfServiceRemoveContact fixShowRegForNonExistentEmail fixUpdateContacts fixVerifyAlertText groupingMultipleUserSourceWorks groupingSuggestionsUi https-location-header ignoreErrorElementInV2Bulk implicit-update inboxNg2Fixes inboxNg2 include_ng_check_on_master_build individualMemberPageNg2 label-empty-profiles linkSocialShowOauth maintainListOfMemberChosenOrgs makeReindexTopicVirtualTopic manage-members-migration master mergeWorksUi missingAttributesForEmail ml-no-cache ng1DuplicateIds ng2-migration-v0.2 noJsDontShowLoadingIcon normalized-grouping notificationAlertsFixAuthUrl oauth-screen-text oauthLockedClientErrorRemergeMaster offHeapOption onlyShowLEIOrgsChosenByMember open-id-cert3 openid-cert-2 optimization passwordResetProfileEvent peer-review-and-group-id-tutorial-updates peer-review-link peer-review-update peerReviewBackendGroupingCheckNoConflicts peerReviewShowMoreDetails person-endpoint-public print-bio-fix printViewLoadAllWorks promoteOrgsSelectedByMembers pubViewMissingOrgIds publicProfileControllerPersonEndpoint publicRecordDontDisplayEmailsAsLink publicRecordEmailSpacing publicRecordEmailSpecChars publicRecordNg2 record-loading-fix recordCorrections refactorMapperFacadeFactories rejectErrorElements release-1.234.9 reloginAlert remove-angularjs-test remove-top-line remove_staticLoc_path removeAffiliationStartDateUi removeBackendSetPreferredWorkBeforeMerging removeCustomEmailsCtrl removeEmptyHrefs removeNg1Affiliations removeRedundantBackendGroupingSuggestionsCode removeV3DevSwaggerReferences removes-unrequired-dependencies requireStartDateIfEndDateSuppliedApiV3 researcher-resources-model returnErrorForOrcidProfileWrongToken right-to-left-text rollBackStartDatesApiV3 save-all-for-large-bibtex self-service-MA-test setVisibilityFromWorkDetails shorterOrcidExceptionMapperLogging springSecurityUpdateWithWillChanges styleMaintenanceHeader toggleSectionCloseImportWizard token-exchange updateNewFooterCc0 uriNormalizer v3Rc1Broken v3_rc2_bb_tests v3_rc2_core v3_rc2_model workAddExtIdDontReloadPage workTitleFormLabelBug worksReloadOnCancel wrap-fix
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
392 lines (348 sloc) 48.1 KB

ORCID API v3.0_rc1 Guide

Current State (Release Candidate Stable)

v3.0_rc1 is the current development release of the ORCID API.

Endpoints

  • activities (read only)
  • address
  • biography (read only)
  • distinction/distinctions
  • education/educations
  • email (read only)
  • employment/employments
  • external-identifiers
  • funding/fundings
  • invited-position/invited-positions
  • keywords
  • membership/memberships
  • other-names
  • peer-review/peer-reviews
  • person (read only)
  • personal-details (read only)
  • qualification/qualifications
  • research-resource/research-resources
  • researcher-urls
  • service/services
  • work/works

XSDs and current state (all stable)

Tutorials

Changes from Version 2.1:

JSON

  • JSON enumerated types are now expressed in lowercase with dashes instead of underscores, matching the existing XML enums (ie JOURNAL_ARTICLE is now expressed as journal-article). This affects enums for visibility, locale, work types, contributor roles, citation types, external identifier relationship, funding types, peer review types, and peer review role

Activities external identifiers

  • Addition of common:external-id-normalized for work and peer-review identifiers. The common:external-id-normalized field is a transient, system generated field which expresses the identifier in a standard format that is used for grouping. In general, normalized identifiers trim extraneous text such as the identifier type or the expression of the identifier as a url. Additional normalization is done based on the rules of the identifier type and may include setting all alpha characters to lower case, or transforming spaces, dashes, periods and other characters that can be treated as equivalent. See the full normalization rules. Identifiers which can not be normalized will return a error message when reading them.

Affiliations

  • Addition of new affiliation sections: Distinction, Invited-position, Membership, Qualification, and Service in addition to the existing Education and Employment sections. For more information see Affiliations tutorial
  • Summary information now available for each section including affiliation source, role-title, department-name, dates, organization and external-ids
  • common:start-date of the year as a minimum is required when writing items
  • Addition of optional element common:url for recording links about the affiliation
  • Addition of optional element common:external-ids for recording identifiers for the affiliation
  • Disambiguated organization identifier is now required and must be a valid Ringgold, FundRef, or GRID identifier
  • Use of common namespace for common:department-name, common:role-title and common:organization

Research-resources

  • This new section of the ORCID record captures information about things that researchers use for their research which require a specific proposal process or credential to access, such as collections, equipment, infrastructure, and services. For more information see the Research-resource tutorial.

Works

  • work:journal-title field is returned with the work summary
  • Addition of common:external-id-normalized when reading works for normalized work identifiers
  • Addition of software to the list of supported work types
  • Use of common namespace for common:url replacing work:url and this field is now returned in the work summary

Fundings

  • Disambiguated organization identifier is now required and must be a valid Ringgold, FundRef, or GRID identifier
  • Use of common namespace for common:organization, replacing funding:organization
  • Use of common namespace for common:url replacing funding:url and this field is now returned in the funding summary

Peer-review

  • reviewer-role and review-type are returned with the peer-review summary
  • Disambiguated organization identifier is now required and must be a valid Ringgold, FundRef, or GRID identifier
  • Addition of common:external-id-normalized when reading peer-reviews for normalized peer-review identifiers
  • Addition of grant, contract, award, salary-award, and research-resource-proposal to supported subject types

Sample files:

For working with json see ORCID conversion util

REST API Reference

API Tutorials

Swagger

The swagger interfaces to the API available at:

Scopes

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

Calls

Action HTTP method Scope URL
Read the entire record GET /read-limited or /read-public https://[HOST]/v3.0_rc1/[ORCID]/record
Read an activities section GET /read-limited or /read-public https://[HOST]/v3.0_rc1/[ORCID]/[SECTION]s
Read a person section GET /read-limited or /read-public https://[HOST]/v3.0_rc1/[ORCID]/[SECTION]
Read a single item GET /read-limited or /read-public https://[HOST]/v3.0_rc1/[ORCID]/[SECTION]/[PUT-CODE]
Add a person item POST /person/update https://[HOST]/v3.0_rc1/[ORCID]/[SECTION]
Update a person item PUT /person/update https://[HOST]/v3.0_rc1/[ORCID]/[SECTION]/[PUT-CODE]
Delete a person item DELETE /person/update https://[HOST]/v3.0_rc1/[ORCID]/[SECTION]/[PUT-CODE]
Add an activity POST /activities/update https://[HOST]/[ORCID]/[SECTION]
Update an activity PUT /activities/update https://[HOST]/v3.0_rc1/[ORCID]/[SECTION]/[PUT-CODE]
Delete an activity DELETE /activities/update https://[HOST]/v3.0_rc1/[ORCID]/[SECTION]/[PUT-CODE]
Add multiple works POST /read-limited or /read-public https://[HOST]/v3.0_rc1/[ORCID]/works
Read multiple works GET /activities/update https://[HOST]/v3.0_rc1/[ORCID]/works/[PUT-CODE1],[PUT-CODE2]
Search records GET /read-public https://[HOST]/v3.0_rc1/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 *
  • distinction
  • education
  • email *
  • employment
  • external-identifiers
  • funding
  • invited-position
  • keywords
  • membership
  • other-names
  • peer-review
  • person *
  • personal-details *
  • qualification
  • research-resource
  • researcher-urls
  • service
  • work

Notes:

  • biography, email, person and personal-details sections are read only
  • when reading and posting multiple works a maximum of 100 works can be accessed 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. The start parameter (integer pointing to the zero-based position of the first result to be returned) can be used to page through larger results sets. See Searching the API tutorial

Examples

Read sections

Item Scope Example cURL Statement
Entire record /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/record'
Activities summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/activities'
Addresses /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/address'
Distinction summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/distinctions'
Education summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/educations'
Emails /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/email'
Employment summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/employments'
External identifiers /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/external-identifiers'
Funding summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/fundings'
Invited position summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/invited-position'
Keywords /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/keywords'
Membership summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/memberships'
Other names /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/other-names'
Peer review summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/peer-reviews'
Personal details /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/personal-details'
Person /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/person'
Qualification summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/qualifications'
Research-resource summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/research-resources'
Researcher URLs /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/researcher-urls'
Service summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/services'
Works summary /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/works'

Read Record Items

Item Scope Example cURL Statement
Address /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/address/4556'
Biography /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/biography'
Distinction /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/distinction/29770'
Education /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/education/22423'
Employment /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/employment/22411'
External identifier /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/external-identifiers/3193'
Funding /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/funding/4413'
Invited position /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/invited-position/29778'
Keyword /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/keywords/4504'
Membership /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/membership/29779'
Other names /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/other-names/15812'
Peer review /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/peer-review/1374'
Qualification /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/peer-review/29769'
Research-resource /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/research-resource/1000'
Researcher URL /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/researcher-urls/41387'
Service /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/service/29773'
Work /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/work/733536'
Multiple Works /read-limited or /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/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.

Add Record Items

Item Scope Example cURL Statement
Address /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/address.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/address
Distinction /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/distinction-item.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/distinction'
Education /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/education-item.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/education'
Employment /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/employment-item.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/employment'
External identifiers /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/external_identifier.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/external-identifiers'
Funding /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/funding-item.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/funding'
Invited position /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/invited-position-item.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/invited-position'
Keywords /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/keyword.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/keywords'
Membership /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/membership-item.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/membership'
Other names /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/other-name.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/other-names'
Peer review /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/peer-review-item.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/peer-review'
Qualification /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/qualification-item.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/qualification'
Research-resource /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/qualification-item.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/research-resource'
Researcher URL /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/researcher-url.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/researcher-urls'
Service /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/service-item.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/service'
Work /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/work.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/work'
Multiple works /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/works.xml' -X POST 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/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.

Update Record Items

Item Scope Example cURL Statement
Address /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/address.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/address/[PUT-CODE]'
Distinction /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/distinction-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/distinction/[PUT-CODE]'
Education /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/education-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/education/[PUT-CODE]'
Employment /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/employment-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/employment/[PUT-CODE]'
External identifiers /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/external_identifier.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/external-identifiers/[PUT-CODE]'
Funding /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/funding-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/funding/[PUT-CODE]'
Invited position /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/invited-position-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/invited-position/[PUT-CODE]'
Keywords /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/keyword.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/keywords/[PUT-CODE]
Membership /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/membership-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/membership/[PUT-CODE]'
Other names /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/other-name.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/other-names/[PUT-CODE]'
Peer review /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/peer-review-item-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/peer-review/[PUT-CODE]'
Qualification /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/qualification-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/qualification/[PUT-CODE]'
Research-resource /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/qualification-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/research-resource/[PUT-CODE]'
Researcher URL /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/researcher-url.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/researcher-urls/[PUT-CODE]'
Service /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/service-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/service/[PUT-CODE]'
Work /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -d '@[FILE-PATH]/work-updated.xml' -X PUT 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/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-3.0_rc1.xsd ">

Delete Record Items

Item Scope Example cURL Statement
Address /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/address/[PUT-CODE]
Distinction /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/distinction/[PUT-CODE]'
Education /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/education/[PUT-CODE]'
Employment /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/employment/[PUT-CODE]'
External identifiers /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/external-identifiers/[PUT-CODE]
Funding /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/funding/[PUT-CODE]'
Invited Position /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/invited-position/[PUT-CODE]'
Keywords /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/keywords/[PUT-CODE]
Membership /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/membership/[PUT-CODE]
Other names /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/researcher-urls/[PUT-CODE]'
Peer review /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/peer-review/[PUT-CODE]'
Qualifiation /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/qualification/[PUT-CODE]'
Research-resource /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/research-resource/[PUT-CODE]'
Researcher URL /person/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/researcher-urls/[PUT-CODE]'
Service /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/service/[PUT-CODE]'
Work /activities/update curl -i -H 'Content-type: application/vnd.orcid+xml' -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'https://api.sandbox.orcid.org/v3.0_rc1/0000-0002-9227-8514/work/[PUT-CODE]'

Webhooks

Item Scope Example cURL Statement
Register a webhook /webhook curl -v -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X PUT 'http://api.sandbox.orcid.org/0000-0002-9227-8514/webhook/http%3A%2F%2Fencoded.url%2F0000-0002-9227-8514'
Delete a webhook /webhook curl -v -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' -X DELETE 'http://api.sandbox.orcid.org/0000-0002-9227-8514/webhook/http%3A%2F%2Fencoded.url%2F0000-0002-9227-8514'

Search

Item Scope Example cURL Statement
Search records /read-public curl -i -H "Accept: application/vnd.orcid+xml" -H 'Authorization: Bearer dd91868d-d29a-475e-9acb-bd3fdf2f43f4' 'https://api.sandbox.orcid.org/v3.0_rc1/search?q=Simpson'