CINXE.COM
<!DOCTYPE html><html lang="en" xmlns="http://www.w3.org/1999/xhtml" xmlns:fb="https://www.facebook.com/2008/fbml" itemscope="itemscope" itemtype="http://schema.org/Product"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"><meta name="readme-deploy" content="5.235.0"><script src="https://browser.sentry-cdn.com/6.19.7/bundle.tracing.min.js" integrity="sha384-lEBvyPG01tsv1WahtwAQevkCCh3NjqUNlz93IATGFmFuVbVyx6dReoQ035OOjNsM" crossorigin="anonymous"></script><script>Sentry.init({ dsn: "https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166", environment: "production", release: "5.235.0", tracesSampleRate: 0, initialScope: { tags: { 'readme-component': 'dash' } } }); </script><title ng-bind="Title.get()">ReadMe</title><meta http-equiv="Content-type" content="text/html;charset=UTF-8"><meta name="keywords" content="readme,developer hub,documentation"><meta name="description" content="Create beautiful product and API documentation with our developer friendly platform."><link rel="stylesheet" href="https://use.typekit.net/xxi6uhs.css"><link rel="shortcut icon" href="https://cdn.readme.io/public/img/favicon.ico?1732290089794" type="image/x-icon"><meta property="fb:app_id" content="293989217296609"><meta property="og:title" content="ReadMe"><meta property="og:description" content="Create beautiful product and API documentation with our developer friendly platform."><meta property="og:url" content="http://readme.io"><meta property="og:image" content="http://readme.io/img/image.png"><meta property="og:site_name" content="ReadMe"><meta property="fb:admins" content="1037213945"><meta name="slack-app-id" content="AQBR3NZUY"><meta name="csrf-token" content="undefined"><meta id="domain" content="readme.io"><link rel="stylesheet" href="https://cdn.readme.io/public/css/bundle-dash.css?1732290089794"><link data-chunk="routes-Dash-Onboarding" rel="preload" as="style" href="/public/dash/web/routes-Dash-Onboarding.3affb51a976441e71e55.css"> <link data-chunk="main" rel="preload" as="style" href="/public/dash/web/main.3fa88d79fbc8b45a3f83.css"> <link data-chunk="main" rel="preload" as="style" href="/public/dash/web/ui-styles.4835e026555e75cecdd1.css"> <link data-chunk="main" rel="preload" as="script" href="/public/dash/web/main.671cad64cda32b7ff9ff.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/3766.5b33aec47565911e9ac6.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/7397.113781fd2f766bf29b1f.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/4241.8f70a87077f703b6e567.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/7672.b15199bc5637e5078c79.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/3383.e26c3faf0ed3166fc98c.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/6365.e2364988204d88f2d665.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/7436.42f081c3e0533b19adc6.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/6164.f1385a19e1d08223b9c3.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/9355.a266f6393358a73bd778.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/4344.76464ebc31120dc1aa8c.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/74.7e46ff08b9929e95159b.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/9503.e0ec95bcb299b55bd0f1.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/8993.769cf94cf07610467b08.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/2326.41ef366fa6b4355f7b75.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/3460.484efd4e741825dcf249.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/9723.2c2861481ac047803748.js"> <link data-chunk="routes-Dash-Onboarding" rel="preload" as="script" href="/public/dash/web/routes-Dash-Onboarding.51fb4add96d306c9f07a.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="/public/dash/web/core-icons-arrow-right-svg.33683bb9528fcbb0553f.js"> <link data-chunk="main" rel="stylesheet" href="/public/dash/web/ui-styles.4835e026555e75cecdd1.css"> <link data-chunk="main" rel="stylesheet" href="/public/dash/web/main.3fa88d79fbc8b45a3f83.css"> <link data-chunk="routes-Dash-Onboarding" rel="stylesheet" href="/public/dash/web/routes-Dash-Onboarding.3affb51a976441e71e55.css"><!--if lt IE 9script(src="http://html5shim.googlecode.com/svn/trunk/html5.js") --><script type="text/javascript">window.FS = { identify: () => {} }; </script><script>(function(){var w=window;var ic=w.Intercom;if(typeof ic==="function"){ic('reattach_activator');ic('update',intercomSettings);}else{var d=document;var i=function(){i.c(arguments)};i.q=[];i.c=function(args){i.q.push(args)};w.Intercom=i;function l(){var s=d.createElement('script');s.type='text/javascript';s.async=true;s.src='https://widget.intercom.io/widget/m6855w1q';var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s,x);}if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})() </script></head><body><div class="ng-non-bindable"><script id="dashReact-props" data-initial-props="{"baseUrl":"/to/ror/?redirect=%2Fdocs%2Fmapping","context":{"labs":{},"user":{},"terms":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[]},"project":{"_id":"6058e47681775f002de04832","appearance":{"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#44A28F","main_alt":"","header_text":"","body_highlight":"","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"allowApiExplorerJsonEditor":false,"referenceSimpleMode":true,"referenceLayout":"row","link_logo_to_url":true,"theme":"solid","colorScheme":"light","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":true,"logo":["https://files.readme.io/4330c08-small-ror-logo-large.png","4330c08-small-ror-logo-large.png",125,80,"#000000","https://files.readme.io/e784d79-ror-logo-large.png","64c16bb48938310012444a6e"],"loginLogo":[],"logo_white":["https://files.readme.io/dacd566-white-logo.png","dacd566-white-logo.png",125,80,"#ffffff","65ef46717fce1c0036177477"],"logo_white_use":false,"logo_large":true,"favicon":["https://files.readme.io/a931430-small-ror-icon-profile_2.png","ror-icon-profile (2).png",32,32,"#d8e0de","https://files.readme.io/a2115cf-ror-icon-profile_2.png"],"stylesheet":"","stylesheet_hub2":"","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":true,"hideTableOfContents":false,"nextStepsLabel":"Other resources you might find helpful","promos":[{"extras":{"type":"buttons","buttonPrimary":"get-started","buttonSecondary":"none"},"title":"ROR Documentation","text":"Comprehensive technical documentation for the Research Organization Registry (ROR), including ROR's metadata schema and REST API, plus implementation guides. Let's ROR!","_id":"6058e47681775f002de04834"}]},"currentOnboardingStep":3,"custom_domain":"","childrenProjects":[],"derivedPlan":"opensource","description":"Technical documentation for ROR, the Research Organization Registry, a global, community-led registry of open persistent identifiers for research organizations.","error404":"","experiments":[],"first_page":"landing","flags":{"allowReusableOTPs":false,"alwaysShowDocPublishStatus":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"allowXFrame":false,"apiAccessRevoked":false,"bidiSync":false,"changelogRssAlwaysPublic":false,"correctnewlines":false,"customComponents":false,"dashReact":false,"disablePasswordlessLogin":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"disableAutoTranslate":false,"disableSignups":false,"enableOidc":false,"enterprise":false,"graphql":false,"mdx":false,"newEditorDash":true,"oauth":false,"passwordlessLogin":"default","owlbotAi":false,"rdmdCompatibilityMode":false,"reviewWorkflow":true,"singleProjectEnterprise":false,"star":false,"staging":false,"superHub":false,"superHubDevelopment":false,"superHubMigrationSelfServeFlow":false,"translation":false,"disableDiscussionSpamRecaptchaBypass":false},"fullBaseUrl":"https://ror.readme.io/","git":{"sync":{"connectedRepository":{},"github":[]}},"glossaryTerms":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":""},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"text","alignment":"left","title":"ROR v1 will be deprecated in 2025","text":"Have you switched yet to v2 of the ROR schema and API? Remember that v1 of ROR will be deprecated in 2025. Read more about [version 2 in the changelog](https://ror.readme.io/v2/changelog/2024-04-11-schema-api-v2) and flip the toggle to switch between documentation for v1 and v2."},{"type":"docs","alignment":"left","pageType":"Documentation"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"monthlyPurchaseLimit":0,"thumbsEnabled":true},"modules":{"landing":true,"docs":true,"examples":false,"reference":false,"graphql":false,"changelog":true,"discuss":false,"suggested_edits":true,"custompages":false,"tutorials":false},"name":"ROR","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""},"oauth_url":"","onboardingCompleted":{"api":true,"appearance":true,"documentation":true,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"owlbot":{"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""},"customization":{"tone":"neutral","customTone":"","answerLength":"long","forbiddenWords":"","defaultAnswer":""},"enabled":false,"isPaying":false},"owner":{"id":"6058e462f15349003a4afdfe","email":"liz@ror.org","name":"Liz Krznarich"},"plan":"freelaunch","planOverride":"opensource","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"","planTrial":"opensource","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":false,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":false,"points":1},"suggestedEdits":{"enabled":false,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":false,"points":1},"integrations":{"enabled":false,"points":2}},"totalScore":70},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":true},"stable":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"pdfStatus":"","_id":"6058e47681775f002de04837","project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"},"subdomain":"ror","subpath":"","superHubWaitlist":false,"topnav":{"left":[{"type":"url","text":"Report a bug or request a feature","url":"https://github.com/ror-community/ror-roadmap/issues/new/choose"},{"type":"url","text":"Contact support","url":"mailto:support@ror.org"}],"right":[{"type":"user"}],"bottom":[],"edited":true},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2021-04-05T18:39:50.145Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://ror.org","versions":[{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"pdfStatus":"","_id":"6058e47681775f002de04837","releaseDate":"2021-03-22T18:39:50.198Z"},{"version":"2","version_clean":"2.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"pdfStatus":"","_id":"66072096d9631f0054e8c118","releaseDate":"2021-03-22T18:39:50.198Z"}],"variableDefaults":[],"webhookEnabled":false},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"pdfStatus":"","_id":"6058e47681775f002de04837","project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"}},"apiBaseUrl":"/","config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.235.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"https://www.youtube.com/embed/CIhJ1uWyLhk?si=qEeH4oqdT_ncz10p&start=300","forceWaitlist":true},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"location":"/to/ror?redirect=%2Fdocs%2Fmapping","isOnboardingRoute":false,"shMigrationLock":false}"></script></div><div id="dashReact"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#333388;--color-primary-inverse:#fff;--color-primary-alt:#161659;--color-primary-darken-10:#252563;--color-primary-darken-20:#17173e;--color-primary-alpha-25:rgba(51, 51, 136, 0.25);--color-link-primary:#333388;--color-link-primary-darken-5:#2c2c75;--color-link-primary-darken-10:#252563;--color-link-primary-darken-20:#17173e;--color-link-primary-alpha-50:rgba(51, 51, 136, 0.5);--color-link-primary-alpha-25:rgba(51, 51, 136, 0.25);--color-link-background:rgba(51, 51, 136, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"></div><div class="ModalWrapper" id="modal-target"></div></div><div id="dashReact-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[3766,7397,4241,7672,3383,6365,7436,6164,9355,4344,74,9503,8993,2326,3460,9723,7196,9575]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-Dash-Onboarding","core-icons-arrow-right-svg"]}</script> <script async data-chunk="main" src="/public/dash/web/main.671cad64cda32b7ff9ff.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/3766.5b33aec47565911e9ac6.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/7397.113781fd2f766bf29b1f.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/4241.8f70a87077f703b6e567.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/7672.b15199bc5637e5078c79.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/3383.e26c3faf0ed3166fc98c.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/6365.e2364988204d88f2d665.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/7436.42f081c3e0533b19adc6.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/6164.f1385a19e1d08223b9c3.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/9355.a266f6393358a73bd778.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/4344.76464ebc31120dc1aa8c.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/74.7e46ff08b9929e95159b.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/9503.e0ec95bcb299b55bd0f1.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/8993.769cf94cf07610467b08.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/2326.41ef366fa6b4355f7b75.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/3460.484efd4e741825dcf249.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/9723.2c2861481ac047803748.js"></script> <script async data-chunk="routes-Dash-Onboarding" src="/public/dash/web/routes-Dash-Onboarding.51fb4add96d306c9f07a.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="/public/dash/web/core-icons-arrow-right-svg.33683bb9528fcbb0553f.js"></script></div></body><script>var is_hub = false; var is_hub_edit = false; var is_hub2 = false; </script><script src="https://cdn.readme.io/public/js/bundle-dash.js?1732290089794"></script></html>