The Crossref Curriculum

Updating funding deposits with new registry info

The Funder Registry is growing rapidly. New funders are continually being evaluated for inclusion, and the Registry is updated almost every month. Once added, a funder name is given a DOI, making it an official Registry entry. It’s important to check regularly and add funder IDs to existing records where no funder ID was available at the time of first deposit.

Updating deposited data to reflect registry changes

If an appropriate identifier did not exist in the registry (or a match could not be made) at the time of deposit, metadata will need to be updated to include new identifiers and better registry metadata.

getFunders API

We have a simple getFunders service to help you identify Funder Registry changes that affect your existing deposits. The getFunders service displays the funder information for a DOI (including Registry changes).

For example, DOI https://0-doi-org.lib.rivier.edu/10.1037/0735-7036.121.3.306 was registered on 18 May 2017 with the following funding data. This deposit identifies five sources of funding for the article, only one of which was identified with a registry DOI.

<xref:publisher_item>
<xref:identifier id_type="other">2007-11961-009</xref:identifier>
<xref:identifier id_type="pmid">17696657</xref:identifier>
</xref:publisher_item>
<fr:program xmlns:fr="http://0-www.crossref.org.lib.rivier.edu/fundref.xsd">
<fr:assertion name="fundgroup">
<fr:assertion name="funder_name">
American Psychological Association
<fr:assertion name="funder_identifier">http://0-dx.doi.org.lib.rivier.edu/10.13039/100006324</fr:assertion>
</fr:assertion>
</fr:assertion>
<fr:assertion name="fundgroup">
<fr:assertion name="funder_name">
American Association of University Women
<fr:assertion name="funder_identifier">http://0-dx.doi.org.lib.rivier.edu/10.13039/100005280</fr:assertion>
</fr:assertion>
</fr:assertion>
<fr:assertion name="fundgroup">
<fr:assertion name="funder_name">Soroptimist International</fr:assertion>
</fr:assertion>
<fr:assertion name="fundgroup">
<fr:assertion name="funder_name">SEASPACE</fr:assertion>
</fr:assertion>
<fr:assertion name="fundgroup">
<fr:assertion name="funder_name">
Walt Disney Company
<fr:assertion name="funder_identifier">http://0-dx.doi.org.lib.rivier.edu/10.13039/100004795</fr:assertion>
</fr:assertion>
</fr:assertion>
</fr:program>
<xref:doi_data>
<xref:doi>10.1037/0735-7036.121.3.306</xref:doi>
<xref:resource>
http://doi.apa.org/getdoi.cfm?doi=10.1037/0735-7036.121.3.306
</xref:resource>

The API call https://0-doi-crossref-org.lib.rivier.edu/getFunders?q=10.1037/0735-7036.121.3.306 shows these same five funders with additional Registry information (in JSON format)

{
"fundedItemDOI": "10.1037/0735-7036.121.3.306",
"funders": [
{
"asDeposited": "American Psychological Association",
"depositedAsIdentifier": "false",
"suggested": [
{
"isRegistryName": "true",
"identifier": "10.13039/100006324",
"country": "http://sws.geonames.org/6252001/",
"prefLabel": "American Psychological Association"
},
{
"isRegistryName": "true",
"identifier": "10.13039/100006324",
"country": "http://sws.geonames.org/6252001/",
"prefLabel": "American Psychological Association"
},
{
"isRegistryName": "true",
"identifier": "10.13039/100006324",
"country": "http://sws.geonames.org/6252001/",
"prefLabel": "American Psychological Association"
}
]
},
{
"asDeposited": "American Association of University Women",
"depositedAsIdentifier": "false",
"suggested": [
{
"isRegistryName": "true",
"identifier": "10.13039/100005280",
"country": "http://sws.geonames.org/6252001/",
"prefLabel": "American Association of University Women"
},
{
"isRegistryName": "true",
"identifier": "10.13039/100005280",
"country": "http://sws.geonames.org/6252001/",
"prefLabel": "American Association of University Women"
},
{
"isRegistryName": "true",
"identifier": "10.13039/100005280",
"country": "http://sws.geonames.org/6252001/",
"prefLabel": "American Association of University Women"
}
]
},
{
"asDeposited": "Soroptimist International",
"depositedAsIdentifier": "false",
"suggested": []
},
{
"asDeposited": "SEASPACE",
"depositedAsIdentifier": "false",
"suggested": []
},
{
"asDeposited": "Walt Disney Company",
"depositedAsIdentifier": "false",
"suggested": [
{
"isRegistryName": "true",
"identifier": "10.13039/100004795",
"country": "http://sws.geonames.org/6252001/",
"prefLabel": "Walt Disney Company"
},
{
"isRegistryName": "true",
"identifier": "10.13039/100004795",
"country": "http://sws.geonames.org/6252001/",
"prefLabel": "Walt Disney Company"
},
{
"isRegistryName": "true",
"identifier": "10.13039/100004795",
"country": "http://sws.geonames.org/6252001/",
"prefLabel": "Walt Disney Company"
}
]
}
]
}

This tells you that:

  • SEASPACE was deposited without an identifier, and nothing in the registry has changed
  • Walt Disney Company was deposited without an identifier, but there is a registry entry for The Walt Disney Company which has a registry DOI
  • Soroptimist International was deposited without an identifier, and nothing in the registry has changed
  • American Psychological Association was deposited without an identifier, but it does have a registry DOI
  • American Association of University Women was deposited with a registry DOI.

Depositing funding and license metadata using a .csv file

We support the deposit of funding and text and data mining license metadata in .csv format through our web deposit form (learn more about the web deposit form).

  1. Start at the web deposit form
  2. Select the Supplemental Metadata Upload option under data type, and upload your .csv file
  3. Enter your Crossref username and password, your email address, and click submit
  4. The .csv metadata will be converted to XML and submitted to the system.

Are you participating in Similarity Check? Learn more about formatting a .csv file for Similarity Check full-text URL deposits.

Troubleshooting uploads

Some basic validation is performed upon upload. Incomplete or incorrect files will return an error message, and will not be deposited. If the file passes the initial validation, it will be converted to XML, and submitted to the Crossref system. You will receive a submission log when your deposit is complete. Please review the log to be sure the DOIs have been updated. The initial validation addresses .csv formatting issues only. Additional validation is performed upon deposit. ​

Please contact us with questions or comments. If you are reporting problems with an upload, please attach the .csv file to your support request.

.csv specifications

Files submitted via .csv upload must comply with these specifications:

  • Column headings must match the headings outlined for each deposit type. You may include funding metadata, license metadata, or both funding and license metadata (see further details below)
  • Values must be separated by a comma (,)
  • Commas and quotation marks must not appear within a column value
  • All dates must be in YYYY-MM-DD format
  • If metadata is not available for an item, the cell should be left blank. If an entire column is not populated, it may be omitted. Do not enter placeholders such as n/a or -, this will cause your deposit to fail, or cause incorrect metadata to be attached to a DOI
  • Files may be up to 45 MB. Note that we will split the file into batches of 5,000 DOIs each for processing, and we’ll email you a submission log and a copy of the submitted XML for each batch.

Funding metadata

The .csv file must contain 4 columns with these headings:

  • DOI: the DOI whose metadata is being updated
  • <funder_name>: name of the funding agency as it appears in the Funder Registry. Learn more about accessing the Funder Registry.
  • <funder_identifier>: funding agency identifier in the form of a DOI
  • <award_number>: grant number or other fund identifier

If a DOI has multiple funders, the DOI must be repeated for each funder. We recommend that all available metadata is deposited. If a piece of funding metadata is not available (for example, a grant number) the field should be left blank.

License metadata

Members may deposit license metadata to support text and data mining. The .csv file may contain these headings (*=required):

  • DOI: the DOI whose metadata is being updated*
  • <license_ref applies_to="vor">: license URL for version of record
  • <vor_lic_start_date>: start date of version of record license
  • <license_ref applies_to="am">: license URL for accepted manuscript
  • <am_lic_start_date>: start date of accepted manuscript license
  • <license_ref applies_to="tdm">: license URL for accepted manuscript
  • <tdm_lic_start_date>: start date of accepted manuscript license
  • <resource content_version="vor">: item URL for version of record
  • <resource content_version="vor" mime_type="?">: item URL for version of record with MIME type
  • <resource content_version="am">: item URL for author manuscript with MIME type
  • <resource content_version="am" mime_type="?">: item URL for author manuscript with MIME type
  • <resource>: item URL with no version type and with MIME type
  • <resource mime_type="?">: item URL with no version type

where “?” is the MIME type as defined in the deposit section of the schema.

Funding and license metadata

Funding and license metadata may be combined into a single file. The order is important: please include columns in the order listed below (*=required):

  • DOI: the DOI whose metadata is being updated*
  • <funder_name>: name of the funding agency* as it appears in the Funder Registry. Learn more about accessing the Funder Registry
  • <funder_identifier>: funding agency identifier in the form of a DOI*
  • <award_number>: grant number or other fund identifier*
  • <license_ref>: license URL
  • <license_ref applies_to="vor">: license URL for version of record
  • <vor_lic_start_date>: start date of version of record license
  • <license_ref applies_to="am">: license URL for accepted manuscript
  • <am_lic_start_date>: start date of accepted manuscript license
  • <license_ref applies_to="tdm">: license URL for accepted manuscript
  • <tdm_lic_start_date>: start date of accepted manuscript license
  • <resource content_version="vor">: item URL for version of record
  • <resource content_version="vor" mime_type="?">: item URL for version of record with MIME type
  • <resource content_version="am">: item URL for author manuscript with MIME type
  • <resource content_version="am" mime_type="?">: item URL for author manuscript with MIME type

where “?” is the MIME type as defined in the deposit section of the schema.

Example .csv files

Last Updated: 2020 April 8 by Laura J. Wilkinson